ansible.netcommon.httpapi – Use httpapi to run command on network appliances

From Get docs
Ansible/docs/2.10/collections/ansible/netcommon/httpapi connection


ansible.netcommon.httpapi – Use httpapi to run command on network appliances

Note

This plugin is part of the ansible.netcommon collection (version 1.4.1).

To install it use: ansible-galaxy collection install ansible.netcommon.

To use it in a playbook, specify: ansible.netcommon.httpapi.


New in version 1.0.0: of ansible.netcommon


Synopsis

  • This connection plugin provides a connection to remote devices over a HTTP(S)-based api.

Parameters

Parameter Choices/Defaults Configuration Comments

become

boolean

  • no ←

  • yes

ini entries: [privilege_escalation]become = no


env:ANSIBLE_BECOME

var: ansible_become

The become option will instruct the CLI session to attempt privilege escalation on platforms that support it. Normally this means transitioning from user mode to enable mode in the CLI session. If become is set to True and the remote device does not support privilege escalation or the privilege has already been elevated, then this option is silently ignored.

Can be configured from the CLI via the --become or -b options.

become_method

string

Default:

"sudo"

ini entries: [privilege_escalation]become_method = sudo


env:ANSIBLE_BECOME_METHOD

var: ansible_become_method

This option allows the become method to be specified in for handling privilege escalation. Typically the become_method value is set to enable but could be defined as other values.

host

string

Default:

"inventory_hostname"

var: ansible_host

Specifies the remote device FQDN or IP address to establish the HTTP(S) connection to.

network_os

string

var: ansible_network_os

Configures the device platform network operating system. This value is used to load the correct httpapi plugin to communicate with the remote device

password

string

var: ansible_password

var: ansible_httpapi_pass

var: ansible_httpapi_password

Configures the user password used to authenticate to the remote device when needed for the device API.

persistent_command_timeout

integer

Default:

30

ini entries: [persistent_connection]command_timeout = 30


env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT

var: ansible_command_timeout

Configures, in seconds, the amount of time to wait for a command to return from the remote device. If this timer is exceeded before the command returns, the connection plugin will raise an exception and close.

persistent_connect_timeout

integer

Default:

30

ini entries: [persistent_connection]connect_timeout = 30


env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT

var: ansible_connect_timeout

Configures, in seconds, the amount of time to wait when trying to initially establish a persistent connection. If this value expires before the connection to the remote device is completed, the connection will fail.

persistent_log_messages

boolean

  • no ←

  • yes

ini entries: [persistent_connection]log_messages = no


env:ANSIBLE_PERSISTENT_LOG_MESSAGES

var: ansible_persistent_log_messages

This flag will enable logging the command executed and response received from target device in the ansible log file. For this option to work 'log_path' ansible configuration option is required to be set to a file path with write access.

Be sure to fully understand the security implications of enabling this option as it could create a security vulnerability by logging sensitive information in log file.

port

integer

ini entries: [defaults]remote_port = None


env:ANSIBLE_REMOTE_PORT

var: ansible_httpapi_port

Specifies the port on the remote device that listens for connections when establishing the HTTP(S) connection.

When unspecified, will pick 80 or 443 based on the value of use_ssl.

remote_user

string

ini entries: [defaults]remote_user = None


env:ANSIBLE_REMOTE_USER

var: ansible_user

The username used to authenticate to the remote device when the API connection is first established. If the remote_user is not specified, the connection will use the username of the logged in user.

Can be configured from the CLI via the --user or -u options.

session_key

dictionary

var: ansible_httpapi_session_key

Configures the session key to be used to authenticate to the remote device when needed for the device API.

This should contain a dictionary representing the key name and value for the token.

When specified, password is ignored.

use_proxy

boolean

  • no

  • yes ←

var: ansible_httpapi_use_proxy

Whether to use https_proxy for requests.

use_ssl

boolean

  • no ←

  • yes

var: ansible_httpapi_use_ssl

Whether to connect using SSL (HTTPS) or not (HTTP).

validate_certs

boolean

  • no

  • yes ←

var: ansible_httpapi_validate_certs

Whether to validate SSL certificates



Authors

  • Ansible Networking Team

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/netcommon/httpapi_connection.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.10/collections/ansible/netcommon/httpapi_connection&oldid=55285"
Powered by MediaWiki