ansible.netcommon.libssh (3.1.3) — connection

Install collection

Install with ansible-galaxy collection install ansible.netcommon:==3.1.3

Add to requirements.yml

  collections:
    - name: ansible.netcommon
      version: 3.1.3

Description

Use the ansible-pylibssh python bindings to connect to targets

The python bindings use libssh C library (https://www.libssh.org/) to connect to targets

This plugin borrows a lot of settings from the ssh plugin as they both cover the same protocol.

Inputs

    
pty:
    default: true
    description: 'TODO: write it'
    env:
    - name: ANSIBLE_LIBSSH_PTY
    ini:
    - key: pty
      section: libssh_connection
    type: boolean

password:
    description:
    - Secret used to either login the ssh server or as a passphrase for ssh keys that
      require it
    - Can be set from the CLI via the C(--ask-pass) option.
    vars:
    - name: ansible_password
    - name: ansible_ssh_pass
    - name: ansible_ssh_password
    - name: ansible_libssh_pass
    - name: ansible_libssh_password

ssh_args:
    cli:
    - name: ssh_args
    description:
    - Arguments to pass to all ssh CLI tools.
    - ProxyCommand is the only supported argument.
    - This option is deprecated in favor of I(proxy_command).
    env:
    - name: ANSIBLE_SSH_ARGS
    ini:
    - key: ssh_args
      section: ssh_connection
    vars:
    - name: ansible_ssh_args
    version_added: 3.2.0
    version_added_collection: ansible.netcommon

remote_addr:
    default: inventory_hostname
    description:
    - Address of the remote target
    vars:
    - name: inventory_hostname
    - name: ansible_host
    - name: ansible_ssh_host
    - name: ansible_libssh_host

remote_user:
    description:
    - User to login/authenticate as
    - Can be set from the CLI via the C(--user) or C(-u) options.
    env:
    - name: ANSIBLE_REMOTE_USER
    - name: ANSIBLE_LIBSSH_REMOTE_USER
    ini:
    - key: remote_user
      section: defaults
    - key: remote_user
      section: libssh_connection
    vars:
    - name: ansible_user
    - name: ansible_ssh_user
    - name: ansible_libssh_user

look_for_keys:
    default: true
    description: 'TODO: write it'
    env:
    - name: ANSIBLE_LIBSSH_LOOK_FOR_KEYS
    ini:
    - key: look_for_keys
      section: libssh_connection
    type: boolean

proxy_command:
    default: ''
    description:
    - Proxy information for running the connection via a jumphost.
    - Also this plugin will scan 'ssh_args', 'ssh_extra_args' and 'ssh_common_args' from
      the 'ssh' plugin settings for proxy information if set.
    env:
    - name: ANSIBLE_LIBSSH_PROXY_COMMAND
    ini:
    - key: proxy_command
      section: libssh_connection
    vars:
    - name: ansible_paramiko_proxy_command
    - name: ansible_libssh_proxy_command

ssh_extra_args:
    cli:
    - name: ssh_extra_args
    description:
    - Extra arguments exclusive to the 'ssh' CLI tool.
    - ProxyCommand is the only supported argument.
    - This option is deprecated in favor of I(proxy_command).
    env:
    - name: ANSIBLE_SSH_EXTRA_ARGS
    ini:
    - key: ssh_extra_args
      section: ssh_connection
    vars:
    - name: ansible_ssh_extra_args
    version_added: 3.2.0
    version_added_collection: ansible.netcommon

password_prompt:
    description:
    - Text to match when using keyboard-interactive authentication to determine if the
      prompt is for the password.
    - Requires ansible-pylibssh version >= 1.0.0
    vars:
    - name: ansible_libssh_password_prompt
    version_added: 3.1.0
    version_added_collection: ansible.netcommon

ssh_common_args:
    cli:
    - name: ssh_common_args
    description:
    - Common extra arguments for all ssh CLI tools.
    - ProxyCommand is the only supported argument.
    - This option is deprecated in favor of I(proxy_command).
    env:
    - name: ANSIBLE_SSH_COMMON_ARGS
    ini:
    - key: ssh_common_args
      section: ssh_connection
    vars:
    - name: ansible_ssh_common_args
    version_added: 3.2.0
    version_added_collection: ansible.netcommon

host_key_auto_add:
    description: 'TODO: write it'
    env:
    - name: ANSIBLE_LIBSSH_HOST_KEY_AUTO_ADD
    ini:
    - key: host_key_auto_add
      section: libssh_connection
    type: boolean

host_key_checking:
    default: true
    description: Set this to "False" if you want to avoid host key checking by the underlying
      tools Ansible uses to connect to the host
    env:
    - name: ANSIBLE_HOST_KEY_CHECKING
    - name: ANSIBLE_SSH_HOST_KEY_CHECKING
    - name: ANSIBLE_LIBSSH_HOST_KEY_CHECKING
    ini:
    - key: host_key_checking
      section: defaults
    - key: host_key_checking
      section: libssh_connection
    type: boolean
    vars:
    - name: ansible_host_key_checking
    - name: ansible_ssh_host_key_checking
    - name: ansible_libssh_host_key_checking

use_persistent_connections:
    default: false
    description: Toggles the use of persistence for connections
    env:
    - name: ANSIBLE_USE_PERSISTENT_CONNECTIONS
    ini:
    - key: use_persistent_connections
      section: defaults
    type: boolean