Skip to content

Latest commit

 

History

History
498 lines (471 loc) · 23.1 KB

ansible.netcommon.httpapi_connection.rst

File metadata and controls

498 lines (471 loc) · 23.1 KB
Raw

ansible.netcommon.httpapi

Use httpapi to run command on network appliances

Version added: 1.0.0

Synopsis

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

Parameters

Parameter Choices/Defaults Configuration Comments
become
boolean
Default:
"no"
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.
ca_path
path
added in 5.2.0
var: ansible_httpapi_ca_path
Path to CA cert bundle to use.
ciphers
list / elements=string
added in 5.0.0
var: ansible_httpapi_ciphers
SSL/TLS Ciphers to use for requests
When a list is provided, all ciphers are joined in order with :
See the OpenSSL Cipher List Format for more details.
The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
This option will have no effect on ansible-core<2.14 but a warning will be emitted.
client_cert
-
added in 5.2.0
var: ansible_httpapi_client_cert
PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, client_key is not required
client_key
-
added in 5.2.0
var: ansible_httpapi_client_key
PEM formatted file that contains the private key to be used for SSL client authentication. If client_cert contains both the certificate and key, this option is not required.
host
string
Default:
"inventory_hostname"
var: inventory_hostname
var: ansible_host
Specifies the remote device FQDN or IP address to establish the HTTP(S) connection to.
http_agent
-
added in 5.2.0
var: ansible_httpapi_http_agent
User-Agent to use in the request.
import_modules
boolean
Default:
"yes"
ini entries:

[ansible_network]
import_modules = yes

env:ANSIBLE_NETWORK_IMPORT_MODULES
var: ansible_network_import_modules
Reduce CPU usage and network module execution time by enabling direct execution. Instead of the module being packaged and executed by the shell, it will be directly executed by the Ansible control node using the same python interpreter as the Ansible process. Note- Incompatible with asynchronous mode. Note- Python 3 and Ansible 2.9.16 or greater required. Note- With Ansible 2.9.x fully qualified modules names are required in tasks.
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
Default:
"no"
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.
platform_type
string
env:ANSIBLE_PLATFORM_TYPE
var: ansible_platform_type
Set type of platform.
port
integer
ini entries:

[defaults]
remote_port = VALUE

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 = VALUE

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
Default:
"yes"
var: ansible_httpapi_use_proxy
Whether to use https_proxy for requests.
use_ssl
boolean
Default:
"no"
var: ansible_httpapi_use_ssl
Whether to connect using SSL (HTTPS) or not (HTTP).
validate_certs
boolean
Default:
"yes"
var: ansible_httpapi_validate_certs
Whether to validate SSL certificates

Status

Authors

  • Ansible Networking Team (@ansible-network)

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.