cisco.nxos.nxos_nxapi (7.0.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0

Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
http:
    aliases:
    - enable_http
    default: true
    description:
    - 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.
    required: false
    type: bool

https:
    aliases:
    - enable_https
    default: false
    description:
    - 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.
    required: false
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - 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.
    required: false
    type: str

sandbox:
    aliases:
    - enable_sandbox
    description:
    - 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.
    required: false
    type: bool

tlsv1_0:
    default: true
    description:
    - 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.
    required: false
    type: bool

tlsv1_1:
    default: false
    description:
    - 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.
    required: false
    type: bool

tlsv1_2:
    default: false
    description:
    - 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.
    required: false
    type: bool

http_port:
    default: 80
    description:
    - 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.
    required: false
    type: int

https_port:
    default: 443
    description:
    - 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.
    required: false
    type: int

ssl_strong_ciphers:
    default: false
    description:
    - 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.
    required: false
    type: bool

Outputs

updates:
  description:
  - Returns the list of commands that need to be pushed into the remote device to
    satisfy the arguments
  returned: always
  sample:
  - no feature nxapi
  type: list