eos_eapi – Manage and configure Arista EOS eAPI.
eos_eapi – Manage and configure Arista EOS eAPI.
New in version 2.1.
Synopsis
- Use to enable or disable eAPI access, and set the port and state of http, https, local_http and unix-socket servers.
- When enabling eAPI access the default is to enable HTTP on port 80, enable HTTPS on port 443, disable local HTTP, and disable Unix socket server. Use the options listed below to override the default configuration.
- Requires EOS v4.12 or greater.
Requirements
The below requirements are needed on the host that executes this module.
- EOS v4.12 or greater
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_pass - |
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable | ||
authorize boolean |
|
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable | |
config - added in 2.2 |
The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The config argument allows the implementer to pass in the configuration to use as the base config for comparison. | ||
http boolean |
|
The
| |
http_port - |
Default: 80 |
Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled. This argument accepts integer values in the valid range of 1 to 65535. | |
https boolean |
|
The
| |
https_port - |
Default: 443 |
Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled. This argument accepts integer values in the valid range of 1 to 65535. | |
local_http boolean |
|
The Note is value is independent of the
| |
local_http_port - |
Default: 8080 |
Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled. This argument accepts integer values in the valid range of 1 to 65535. | |
provider - |
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. A dict object containing connection details. | ||
auth_pass - |
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable | ||
authorize boolean |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable | |
host - / required |
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
password - |
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or eapi transports. If the value is not specified in the task, the value of environment variable | ||
port - |
Default: "0 (use common port)" |
Specifies the port to use when building the connection to the remote device. This value applies to either cli or eapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). | |
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable | ||
timeout - |
Default: 10 |
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | |
transport - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
use_proxy boolean added in 2.5 |
|
If | |
use_ssl boolean |
|
Configures the transport to use SSL if set to true only when the | |
username - |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable | ||
validate_certs boolean |
|
If | |
socket boolean |
|
The
| |
state - |
|
The | |
vrf - added in 2.2 |
Default: "default" |
The |
Notes
Note
- For information on using CLI, eAPI and privileged mode see the EOS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Arista EOS devices see the Arista integration page.
Examples
- name: Enable eAPI access with default configuration
eos_eapi:
state: started
- name: Enable eAPI with no HTTP, HTTPS at port 9443, local HTTP at port 80, and socket enabled
eos_eapi:
state: started
http: false
https_port: 9443
local_http: yes
local_http_port: 80
socket: yes
- name: Shutdown eAPI access
eos_eapi:
state: stopped
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list |
always |
The list of configuration mode commands to send to the device
Sample: ['management api http-commands', 'protocol http port 81', 'no protocol https'] |
session_name string |
when changed is True |
The EOS config session name used to load the configuration
Sample: ansible_1479315771 |
urls dictionary |
when eAPI is started |
Hash of URL endpoints eAPI is listening on per interface
Sample: {'Management1': ['http://172.26.10.1:80']} |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Peter Sprygada (@privateip)
© 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/modules/eos_eapi_module.html