Class: Ansible::Ruby::Modules::Eos_eapi

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Eos_eapi

Defined in:

lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb

Overview

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.

Instance Method Summary

• #config ⇒ Object^?

  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.

• #http ⇒ :yes, ...

  The C(http) argument controls the operating state of the HTTP transport protocol when eAPI is present in the running-config.

• #http_port ⇒ Integer^?

  Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled.

• #https ⇒ :yes, ...

  The C(https) argument controls the operating state of the HTTPS transport protocol when eAPI is present in the running-config.

• #https_port ⇒ Integer^?

  Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled.

• #local_http ⇒ :yes, ...

  The C(local_http) argument controls the operating state of the local HTTP transport protocol when eAPI is present in the running-config.

• #local_http_port ⇒ Integer^?

  Configures the HTTP port that will listen for connections when the HTTP transport protocol is enabled.

• #socket ⇒ :yes, ...

  The C(socket) argument controls the operating state of the UNIX Domain Socket used to receive eAPI requests.

• #state ⇒ :started, ...

  The C(state) argument controls the operational state of eAPI on the remote device.

• #vrf ⇒ String^?

  The C(vrf) argument will configure eAPI to listen for connections in the specified VRF.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#config ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 46

attribute :config

#http ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 14

attribute :http

#http_port ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 18

attribute :http_port

#https ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 22

attribute :https

#https_port ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 26

attribute :https_port

#local_http ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 30

attribute :local_http

#local_http_port ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 34

attribute :local_http_port

#socket ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 38

attribute :socket

#state ⇒ :started, ...

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 49

attribute :state

#vrf ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/eos/eos_eapi.rb', line 42

attribute :vrf