Skip to content

Latest commit

 

History

History
300 lines (266 loc) · 13.5 KB

cisco.nxos.nxos_nxapi_module.rst

File metadata and controls

300 lines (266 loc) · 13.5 KB
Raw

cisco.nxos.nxos_nxapi

Manage NXAPI configuration on an NXOS device.

Version added: 1.0.0

Synopsis

  • 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 Cli transport.

Parameters

Parameter Choices/Defaults Comments
http
boolean
    Choices:
  • no
  • yes ←
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.

aliases: enable_http
http_port
integer
Default:
80
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.
https
boolean
    Choices:
  • no ←
  • yes
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.

aliases: enable_https
https_port
integer
Default:
443
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.
sandbox
boolean
    Choices:
  • no
  • yes
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 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.

aliases: enable_sandbox
ssl_strong_ciphers
boolean
    Choices:
  • no ←
  • yes
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.
state
string
    Choices:
  • present ←
  • absent
The state argument controls whether or not the NXAPI feature is configured on the remote device. When the value is present the NXAPI feature configuration is present in the device running-config. When the values is absent the feature configuration is removed from the running-config.
tlsv1_0
boolean
    Choices:
  • no
  • yes ←
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.
tlsv1_1
boolean
    Choices:
  • no ←
  • yes
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.
tlsv1_2
boolean
    Choices:
  • no ←
  • yes
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.

Notes

Note

Examples

- name: Enable NXAPI access with default configuration
  cisco.nxos.nxos_nxapi:
    state: present

- name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled
  cisco.nxos.nxos_nxapi:
    enable_http: false
    https_port: 9443
    https: true
    enable_sandbox: false

- name: remove NXAPI configuration
  cisco.nxos.nxos_nxapi:
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
updates
list
always
Returns the list of commands that need to be pushed into the remote device to satisfy the arguments

Sample:
['no feature nxapi']


Status

Authors

  • Peter Sprygada (@privateip)