cisco.radkit.terminal connection – DEPRECATED: Use port_forward module for Linux servers instead

Note

This connection plugin is part of the cisco.radkit collection (version 2.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install git+https://wwwin-github.cisco.com/scdozier/cisco.radkit-ansible.git.

To use it in a playbook, specify: cisco.radkit.terminal.

New in cisco.radkit 0.1.0

DEPRECATED

Removed in:

version 2.0.0

Why:

Replaced by port_forward module for better file transfer support

Alternative:

Use port_forward module for Linux servers

Synopsis

  • 🚨 DEPRECATED as of v2.0.0: This connection plugin is deprecated.

  • Use port_forward module for Linux servers instead of this terminal connection.

  • Port forwarding provides better file transfer support (SCP/SFTP) required by most Ansible modules.

  • For network devices, use ssh_proxy module with ansible.netcommon.network_cli connection.

  • Uses RADKit to connect to devices over SSH. Works with LINUX platforms.

Parameters

Parameter

Comments

device_addr

string

Hostname/Address of the remote target. This must match the host on RADKit.

This option will be used when ansible_host or ansible_ssh_host is specified

Configuration:

  • Variable: ansible_host

  • Variable: ansible_ssh_host

device_name

string

Device name of the remote target. This must match the device name on RADKit (not host field)

Configuration:

  • Variable: inventory_hostname

radkit_client_ca_path

string

The path to the issuer chain for the identity certificate

Configuration:

radkit_client_cert_path

string

The path to the identity certificate

Configuration:

radkit_client_key_path

string

The path to the private key for the identity certificate

Configuration:

radkit_client_private_key_password_base64

string / required

The private key password in base64 for radkit client

Configuration:

radkit_connection_timeout

integer

Timeout in seconds for RADKit connection lifecycle

Connection will be automatically cleaned up after this period of inactivity

Default: 3600

Configuration:

radkit_exec_timeout

integer

Specifies how many seconds RADKit will for wait command to complete

Default: 3600

Configuration:

radkit_identity

string / required

The Client ID (owner email address) present in the RADKit client certificate.

Configuration:

radkit_login_timeout

integer

Timeout in seconds for RADKit certificate login

Default: 60

Configuration:

radkit_service_serial

string / required

The serial of the RADKit service you wish to connect through

Configuration:

radkit_wait_timeout

integer

Specifies how many seconds RADKit will wait before failing task.

Note that the request is not affected, and it will still eventually complete (successfully or unsuccessfully)

Default: 0

Configuration:

Examples

- hosts: all
  connection: cisco.radkit.terminal
  vars:
    ansible_remote_tmp: /tmp/.ansible/tmp
    ansible_async_dir: /tmp/.ansible_async
    radkit_service_serial: xxxx-xxxx-xxxx
    radkit_identity: user@cisco.com
  become: yes
  tasks:
    - name: Restart sshd
      ansible.builtin.service:
        name: sshd
        state: restarted

Status

  • This connection will be removed in version 2.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ansible Core Team

  • Scott Dozier (@scdozier)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.