httpapi – Use httpapi to run command on network appliances
httpapi – Use httpapi to run command on network appliances
New in version 2.6.
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: [] = no [] = 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 Can be configured form the CLI via the |
become_method - |
Default: "sudo" |
ini entries: [] = sudo [] = 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 |
host - |
Default: "inventory_hostname" |
var: ansible_host |
Specifies the remote device FQDN or IP address to establish the HTTP(S) connection to. |
network_os - |
var: ansible_network_os |
Configures the device platform network operating system. This value is used to load the correct httpapi and cliconf plugins to communicate with the remote device | |
password - |
var: ansible_password var: ansible_httpapi_pass |
Secret used to authenticate | |
persistent_command_timeout integer |
Default: 10 |
ini entries: [persistent_connection]command_timeout = 10
env:ANSIBLE_PERSISTENT_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 |
port integer |
ini entries: [defaults]remote_port = VALUE
env:ANSIBLE_REMOTE_PORT var: ansible_httpapi_port |
Specifies the port on the remote device to listening for connections when establishing the HTTP(S) connection. When unspecified, will pick 80 or 443 based on the value of use_ssl | |
remote_user - |
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 form the CLI via the | |
timeout integer |
Default: 120 |
Sets the connection time, in seconds, for the communicating with the remote device. This timeout is used as the default timeout value for commands when issuing a command to the network CLI. If the command does not return in timeout seconds, the an error is generated. | |
use_ssl boolean |
Default: "no" |
var: ansible_httpapi_use_ssl |
Whether to connect using SSL (HTTPS) or not (HTTP) |
validate_certs boolean added in 2.7 |
Default: "yes" |
var: ansible_httpapi_validate_certs |
Whether to validate SSL certificates |
Status
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.7/plugins/connection/httpapi.html