W3cubDocs

/Ansible

nxos_nxapi - Manage NXAPI configuration on an NXOS device.

New in version 2.1.

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.

Options

parameter required default choices comments
config
(added in 2.2)
 no
The config argument provides an optional argument to specify the device running-config to used as the basis for configuring the remote system. The config argument accepts a string value that represents the device configuration.
host
 yes
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
http
 no True
  • yes
  • no
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
 no 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
 no
  • yes
  • no
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
 no 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.
password
 no
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
 no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
provider
 no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
sandbox
 no
  • yes
  • no
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.
aliases: enable_sandbox
ssh_keyfile
 no
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
state
 no present
  • 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.
transport
 yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
use_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: admin
    password: admin

- name: Enable NXAPI access with default configuration
  nxos_nxapi:
    provider: {{ cli }}

- 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
    provider: {{ cli }}

- name: remove NXAPI configuration
  nxos_nxapi:
    state: absent
    provider: {{ cli }}

Return Values

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

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

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_nxapi_module.html