httpapi¶
Collection Note
This module is part of the ansible.netcommon collection. To install the collection, use:
Added in version1.0.0.
Synopsis¶
- This connection plugin provides a connection to remote devices over a HTTP(S)-based api.
Parameters¶
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| become boolean |
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 C(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 C(--become) or C(-b) options. Env: ANSIBLE_BECOME |
|
| become_method string |
Default: sudo |
This option allows the become method to be specified in for handling privilege escalation. Typically the become_method value is set to C(enable) but could be defined as other values. Env: ANSIBLE_BECOME_METHOD |
| ca_path path |
Path to CA cert bundle to use. Version Added: 5.2.0 |
|
| ciphers list / elements=string |
SSL/TLS Ciphers to use for requests When a list is provided, all ciphers are joined in order with C(:) See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#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. Version Added: 5.0.0 |
|
| 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, I(client_key) is not required Version Added: 5.2.0 |
|
| client_key | PEM formatted file that contains the private key to be used for SSL client authentication. If I(client_cert) contains both the certificate and key, this option is not required. Version Added: 5.2.0 |
|
| host string |
Default: inventory_hostname |
Specifies the remote device FQDN or IP address to establish the HTTP(S) connection to. |
| http_agent | User-Agent to use in the request. Version Added: 5.2.0 |
|
| import_modules boolean |
Default: True |
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 C(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. Env: ANSIBLE_NETWORK_IMPORT_MODULES |
| network_os string |
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 |
Configures the user password used to authenticate to the remote device when needed for the device API. | |
| persistent_command_timeout int |
Default: 30 |
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. Env: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT |
| persistent_connect_timeout int |
Default: 30 |
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. Env: ANSIBLE_PERSISTENT_CONNECT_TIMEOUT |
| persistent_log_messages boolean |
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. Env: ANSIBLE_PERSISTENT_LOG_MESSAGES |
|
| platform_type string |
Set type of platform. Env: ANSIBLE_PLATFORM_TYPE |
|
| port int |
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. Env: ANSIBLE_REMOTE_PORT |
|
| remote_user string |
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 C(--user) or C(-u) options. Env: ANSIBLE_REMOTE_USER |
|
| session_key dict |
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, I(password) is ignored. |
|
| use_proxy boolean |
Default: True |
Whether to use https_proxy for requests. |
| use_ssl boolean |
Whether to connect using SSL (HTTPS) or not (HTTP). | |
| validate_certs boolean |
Default: True |
Whether to validate SSL certificates |
Authors¶
- Ansible Networking Team (@ansible-Network)