Skip to content

libssh

Collection Note

This module is part of the ansible.netcommon collection. To install the collection, use:

ansible-galaxy collection install ansible.netcommon
Added in version 1.1.0.

Synopsis

  • 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.

Parameters

Parameter Defaults / Choices Comments
config_file
path		 Alternate SSH config file location
Env: ANSIBLE_LIBSSH_CONFIG_FILE
Version Added: 5.1.0
host_key_auto_add
boolean		 TODO: write it
Env: ANSIBLE_LIBSSH_HOST_KEY_AUTO_ADD
host_key_checking
boolean		 Default: True
 Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host
Env: ANSIBLE_HOST_KEY_CHECKING
Env: ANSIBLE_SSH_HOST_KEY_CHECKING
Env: ANSIBLE_LIBSSH_HOST_KEY_CHECKING
look_for_keys
boolean		 Default: True
 TODO: write it
Env: ANSIBLE_LIBSSH_LOOK_FOR_KEYS
password
string		 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.
password_prompt
string		 Text to match when using keyboard-interactive authentication to determine if the prompt is for the password.
Requires ansible-pylibssh version >= 1.0.0
Version Added: 3.1.0
proxy_command
string		 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: ANSIBLE_LIBSSH_PROXY_COMMAND
pty
boolean		 Default: True
 TODO: write it
Env: ANSIBLE_LIBSSH_PTY
remote_addr
string		 Default: inventory_hostname
 Address of the remote target
remote_user
string		 User to login/authenticate as
Can be set from the CLI via the C(--user) or C(-u) options.
Env: ANSIBLE_REMOTE_USER
Env: ANSIBLE_LIBSSH_REMOTE_USER
ssh_args
string		 Arguments to pass to all ssh CLI tools.
ProxyCommand is the only supported argument.
This option is deprecated in favor of I(proxy_command) and will be removed in a release after 2026-01-01.
Env: ANSIBLE_SSH_ARGS
Version Added: 3.2.0
ssh_common_args
string		 Common extra arguments for all ssh CLI tools.
ProxyCommand is the only supported argument.
This option is deprecated in favor of I(proxy_command) and will be removed in a release after 2026-01-01.
Env: ANSIBLE_SSH_COMMON_ARGS
Version Added: 3.2.0
ssh_extra_args
string		 Extra arguments exclusive to the 'ssh' CLI tool.
ProxyCommand is the only supported argument.
This option is deprecated in favor of I(proxy_command) and will be removed in a release after 2026-01-01.
Env: ANSIBLE_SSH_EXTRA_ARGS
Version Added: 3.2.0
use_persistent_connections
boolean		 Toggles the use of persistence for connections
Env: ANSIBLE_USE_PERSISTENT_CONNECTIONS

Authors

  • Ansible Networking Team (@ansible-Network)