eos_eapi - Manage and configure Arista EOS eAPI.

• Synopsis
• Requirements (on host that executes module)
• Options
• Examples
• Return Values
• This is a Core Module

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 (on host that executes module)

• EOS v4.12 or greater

Options

Examples

# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: admin
    password: admin

- name: Enable eAPI access with default configuration
  eos_eapi:
    state: started
    provider: {{ cli }}

- 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
    provider: {{ cli }}

- name: Shutdown eAPI access
  eos_eapi:
    state: stopped
    provider: {{ cli }}

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.