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/core/network/eos/eos_eapi.rb

Overview

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.

Instance Method Summary

• #http ⇒ Boolean^?

  Enable HTTP server access.

• #http_port ⇒ Integer^?

  Port on which the HTTP server will listen.

• #https ⇒ Boolean^?

  Enable HTTPS server access.

• #https_port ⇒ Integer^?

  Port on which the HTTPS server will listen.

• #local_http ⇒ Boolean^?

  Enable local HTTP server access.

• #local_http_port ⇒ Integer^?

  Port on which the local HTTP server will listen.

• #socket ⇒ Boolean^?

  Enable Unix socket server access.

• #state ⇒ :started, ...

  Set to started or stopped.

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

#http ⇒ Boolean^?

Returns Enable HTTP server access.

Returns:

• (Boolean, nil) —

  Enable HTTP server access.

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

attribute :http

#http_port ⇒ Integer^?

Returns Port on which the HTTP server will listen.

Returns:

• (Integer, nil) —

  Port on which the HTTP server will listen.

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

attribute :http_port

#https ⇒ Boolean^?

Returns Enable HTTPS server access.

Returns:

• (Boolean, nil) —

  Enable HTTPS server access.

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

attribute :https

#https_port ⇒ Integer^?

Returns Port on which the HTTPS server will listen.

Returns:

• (Integer, nil) —

  Port on which the HTTPS server will listen.

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

attribute :https_port

#local_http ⇒ Boolean^?

Returns Enable local HTTP server access.

Returns:

• (Boolean, nil) —

  Enable local HTTP server access.

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

attribute :local_http

#local_http_port ⇒ Integer^?

Returns Port on which the local HTTP server will listen.

Returns:

• (Integer, nil) —

  Port on which the local HTTP server will listen.

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

attribute :local_http_port

#socket ⇒ Boolean^?

Returns Enable Unix socket server access.

Returns:

• (Boolean, nil) —

  Enable Unix socket server access.

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

attribute :socket

#state ⇒ :started, ...

Returns Set to started or stopped. A state of started will enable EAPI access, and a state of stopped will disable or shutdown all EAPI access.

Returns:

• (:started, :stopped, nil) —

  Set to started or stopped. A state of started will enable EAPI access, and a state of stopped will disable or shutdown all EAPI access.

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

attribute :state