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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/network/nxos/nxos_nxapi.rb

Overview

Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the C(Cli) transport.

Instance Method Summary

• #http ⇒ Boolean^?

  Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI.

• #http_port ⇒ Integer^?

  Configure the port with which the HTTP server will listen on for requests.

• #https ⇒ Symbol^?

  Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI.

• #https_port ⇒ Integer^?

  Configure the port with which the HTTPS server will listen on for requests.

• #sandbox ⇒ Symbol^?

  The NXAPI feature provides a web base UI for developers for entering commands.

• #ssl_strong_ciphers ⇒ Symbol^?

  Controls the use of whether strong or weak ciphers are configured.

• #state ⇒ :present, ...

  The C(state) argument controls whether or not the NXAPI feature is configured on the remote device.

• #tlsv1_0 ⇒ Boolean^?

  Controls the use of the Transport Layer Security version 1.0 is configured.

• #tlsv1_1 ⇒ Symbol^?

  Controls the use of the Transport Layer Security version 1.1 is configured.

• #tlsv1_2 ⇒ Symbol^?

  Controls the use of the Transport Layer Security version 1.2 is configured.

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #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 Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.

Returns:

• (Boolean, nil) —

  Controls the operating state of the HTTP protocol as one of the underlying transports for NXAPI. By default, NXAPI will enable the HTTP transport when the feature is first configured. To disable the use of the HTTP transport, set the value of this argument to False.

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

attribute :http

#http_port ⇒ Integer^?

Returns Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.

Returns:

• (Integer, nil) —

  Configure the port with which the HTTP server will listen on for requests. By default, NXAPI will bind the HTTP service to the standard HTTP port 80. This argument accepts valid port values in the range of 1 to 65535.

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

attribute :http_port

#https ⇒ Symbol^?

Returns Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.

Returns:

• (Symbol, nil) —

  Controls the operating state of the HTTPS protocol as one of the underlying transports for NXAPI. By default, NXAPI will disable the HTTPS transport when the feature is first configured. To enable the use of the HTTPS transport, set the value of this argument to True.

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

attribute :https

#https_port ⇒ Integer^?

Returns Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.

Returns:

• (Integer, nil) —

  Configure the port with which the HTTPS server will listen on for requests. By default, NXAPI will bind the HTTPS service to the standard HTTPS port 443. This argument accepts valid port values in the range of 1 to 65535.

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

attribute :https_port

#sandbox ⇒ Symbol^?

Returns The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the C(sandbox) argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.

Returns:

• (Symbol, nil) —

  The NXAPI feature provides a web base UI for developers for entering commands. This feature is initially disabled when the NXAPI feature is configured for the first time. When the C(sandbox) argument is set to True, the developer sandbox URL will accept requests and when the value is set to False, the sandbox URL is unavailable. This is supported on NX-OS 7K series.

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

attribute :sandbox

#ssl_strong_ciphers ⇒ Symbol^?

Returns Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.

Returns:

• (Symbol, nil) —

  Controls the use of whether strong or weak ciphers are configured. By default, this feature is disabled and weak ciphers are configured. To enable the use of strong ciphers, set the value of this argument to True.

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

attribute :ssl_strong_ciphers

#state ⇒ :present, ...

Returns The C(state) argument controls whether or not the NXAPI feature is configured on the remote device. When the value is C(present) the NXAPI feature configuration is present in the device running-config. When the values is C(absent) the feature configuration is removed from the running-config.

Returns:

• (:present, :absent, nil) —

  The C(state) argument controls whether or not the NXAPI feature is configured on the remote device. When the value is C(present) the NXAPI feature configuration is present in the device running-config. When the values is C(absent) the feature configuration is removed from the running-config.

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

attribute :state

#tlsv1_0 ⇒ Boolean^?

Returns Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.

Returns:

• (Boolean, nil) —

  Controls the use of the Transport Layer Security version 1.0 is configured. By default, this feature is enabled. To disable the use of TLSV1.0, set the value of this argument to True.

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

attribute :tlsv1_0

#tlsv1_1 ⇒ Symbol^?

Returns Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.

Returns:

• (Symbol, nil) —

  Controls the use of the Transport Layer Security version 1.1 is configured. By default, this feature is disabled. To enable the use of TLSV1.1, set the value of this argument to True.

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

attribute :tlsv1_1

#tlsv1_2 ⇒ Symbol^?

Returns Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.

Returns:

• (Symbol, nil) —

  Controls the use of the Transport Layer Security version 1.2 is configured. By default, this feature is disabled. To enable the use of TLSV1.2, set the value of this argument to True.

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

attribute :tlsv1_2