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

Inherits:
Base show all
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 collapse

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?

Returns 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 I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison.

Returns:

  • (Object, nil) —

    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 I(config) argument allows the implementer to pass in the configuration to use as the base config for comparison.



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

attribute :config

#http ⇒ :yes, ...

Returns The C(http) argument controls the operating state of the HTTP transport protocol when eAPI is present in the running-config. When the value is set to True, the HTTP protocol is enabled and when the value is set to False, the HTTP protocol is disabled. By default, when eAPI is first configured, the HTTP protocol is disabled.

Returns:

  • (:yes, :no, nil) —

    The C(http) argument controls the operating state of the HTTP transport protocol when eAPI is present in the running-config. When the value is set to True, the HTTP protocol is enabled and when the value is set to False, the HTTP protocol is disabled. By default, when eAPI is first configured, the HTTP protocol is disabled.



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

attribute :http

#http_port ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



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

attribute :http_port

#https ⇒ :yes, ...

Returns The C(https) argument controls the operating state of the HTTPS transport protocol when eAPI is present in the running-config. When the value is set to True, the HTTPS protocol is enabled and when the value is set to False, the HTTPS protocol is disabled. By default, when eAPI is first configured, the HTTPS protocol is enabled.

Returns:

  • (:yes, :no, nil) —

    The C(https) argument controls the operating state of the HTTPS transport protocol when eAPI is present in the running-config. When the value is set to True, the HTTPS protocol is enabled and when the value is set to False, the HTTPS protocol is disabled. By default, when eAPI is first configured, the HTTPS protocol is enabled.



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

attribute :https

#https_port ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



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

attribute :https_port

#local_http ⇒ :yes, ...

Returns The C(local_http) argument controls the operating state of the local HTTP transport protocol when eAPI is present in the running-config. When the value is set to True, the HTTP protocol is enabled and restricted to connections from localhost only. When the value is set to False, the HTTP local protocol is disabled.,Note is value is independent of the C(http) argument.

Returns:

  • (:yes, :no, nil) —

    The C(local_http) argument controls the operating state of the local HTTP transport protocol when eAPI is present in the running-config. When the value is set to True, the HTTP protocol is enabled and restricted to connections from localhost only. When the value is set to False, the HTTP local protocol is disabled.,Note is value is independent of the C(http) argument



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

attribute :local_http

#local_http_port ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



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

attribute :local_http_port

#socket ⇒ :yes, ...

Returns The C(socket) argument controls the operating state of the UNIX Domain Socket used to receive eAPI requests. When the value of this argument is set to True, the UDS will listen for eAPI requests. When the value is set to False, the UDS will not be available to handle requests. By default when eAPI is first configured, the UDS is disabled.

Returns:

  • (:yes, :no, nil) —

    The C(socket) argument controls the operating state of the UNIX Domain Socket used to receive eAPI requests. When the value of this argument is set to True, the UDS will listen for eAPI requests. When the value is set to False, the UDS will not be available to handle requests. By default when eAPI is first configured, the UDS is disabled.



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

attribute :socket

#state ⇒ :started, ...

Returns The C(state) argument controls the operational state of eAPI on the remote device. When this argument is set to C(started), eAPI is enabled to receive requests and when this argument is C(stopped), eAPI is disabled and will not receive requests.

Returns:

  • (:started, :stopped, nil) —

    The C(state) argument controls the operational state of eAPI on the remote device. When this argument is set to C(started), eAPI is enabled to receive requests and when this argument is C(stopped), eAPI is disabled and will not receive requests.



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

attribute :state

#vrf ⇒ String?

Returns The C(vrf) argument will configure eAPI to listen for connections in the specified VRF. By default, eAPI transports will listen for connections in the global table. This value requires the VRF to already be created otherwise the task will fail.

Returns:

  • (String, nil) —

    The C(vrf) argument will configure eAPI to listen for connections in the specified VRF. By default, eAPI transports will listen for connections in the global table. This value requires the VRF to already be created otherwise the task will fail.



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

attribute :vrf