Class: Ansible::Ruby::Modules::Nxos_nxapi

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb

Overview

Use to enable or disable NXAPI access, set the port and state of http and https servers, and enable or disable the sandbox. When enabling NXAPI access the default is to enable HTTP on port 80, enable HTTPS on port 443, and enable the web based UI sandbox. Use the options below to override the default configuration.

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

#http ⇒ Boolean?

Returns Enable/disable HTTP server.

Returns:

  • (Boolean, nil) —

    Enable/disable HTTP server.



24
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb', line 24

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.



16
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb', line 16

attribute :http_port

#https ⇒ Boolean?

Returns Enable/disable HTTPS server.

Returns:

  • (Boolean, nil) —

    Enable/disable HTTPS server.



28
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb', line 28

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.



20
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb', line 20

attribute :https_port

#sandbox ⇒ Boolean?

Returns Enable/disable NXAPI web based UI for entering commands.

Returns:

  • (Boolean, nil) —

    Enable/disable NXAPI web based UI for entering commands.



32
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb', line 32

attribute :sandbox

#state ⇒ :started, ...

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

Returns:

  • (:started, :stopped, nil) —

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



12
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb', line 12

attribute :state