ansible.builtin.nxos_nxapi (v2.3.3.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

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
  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
  nxos_nxapi:
    enable_http: false
    https_port: 9443
    https: yes
    enable_sandbox: no

Scanned by Steampunk Spotter

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

- name: remove NXAPI configuration
  nxos_nxapi:
    state: absent

Inputs

    
http:
    aliases:
    - enable_http
    choices:
    - 'yes'
    - 'no'
    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

https:
    aliases:
    - enable_https
    choices:
    - 'yes'
    - 'no'
    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

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

sandbox:
    aliases:
    - enable_sandbox
    choices:
    - 'yes'
    - 'no'
    default: false
    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.
    required: false

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

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

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