ansible.netcommon.httpapi connection – Use httpapi to run command on network appliances
Note
This connection plugin is part of the ansible.netcommon collection (version 7.1.0).
You might already have this collection installed if you are using the ansible package.
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 ansible.netcommon.
To use it in a playbook, specify: ansible.netcommon.httpapi.
New in ansible.netcommon 1.0.0
Synopsis
This connection plugin provides a connection to remote devices over a HTTP(S)-based api.
Parameters
Parameter |
Comments |
|---|---|
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 Can be configured from the CLI via the Choices:
Configuration:
|
|
This option allows the become method to be specified in for handling privilege escalation. Typically the become_method value is set to Default: Configuration:
|
|
Path to CA cert bundle to use. Configuration:
|
|
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. Configuration:
|
|
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 Configuration:
|
|
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. Configuration:
|
|
Specifies the remote device FQDN or IP address to establish the HTTP(S) connection to. Default: Configuration:
|
|
User-Agent to use in the request. Configuration:
|
|
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 Choices:
Configuration:
|
|
Configures the device platform network operating system. This value is used to load the correct httpapi plugin to communicate with the remote device Configuration:
|
|
Configures the user password used to authenticate to the remote device when needed for the device API. Configuration:
|
|
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. Default: Configuration:
|
|
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. Default: Configuration:
|
|
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. Choices:
Configuration:
|
|
Set type of platform. Configuration:
|
|
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. Configuration:
|
|
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 Configuration:
|
|
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. Configuration:
|
|
Whether to use https_proxy for requests. Choices:
Configuration:
|
|
Whether to connect using SSL (HTTPS) or not (HTTP). Choices:
Configuration:
|
|
Whether to validate SSL certificates Choices:
Configuration:
|