eos_eapi - Manage and configure EAPI. Requires EOS v4.12 or greater.

Synopsis

Use to enable or disable EAPI access, and set the port and state of http, https, localHttp 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.

Options

Examples

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

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

- name: Shutdown EAPI access
  eos_eapi:
      state: stopped
      provider: {{ provider }}

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, Helping Testing PRs and Developing Modules.