NXOS Platform Options

    For legacy playbooks, NXOS still supports ansible_connection: local. We recommend modernizing to use ansible_connection: network_cli or ansible_connection: httpapi as soon as possible.

    • If you are accessing your host directly (not through a bastion/jump host) you can remove the ansible_ssh_common_args configuration.
    • If you are accessing your host through a bastion/jump host, you cannot include your SSH password in the ProxyCommand directive. To prevent secrets from leaking out (for example in ps output), SSH does not support providing passwords via environment variables.

    Before you can use NX-API to connect to a switch, you must enable NX-API. To enable NX-API on a new switch via Ansible, use the module via the CLI connection. Set up group_vars/nxos.yml just like in the CLI example above, then run a playbook task like this:

    Once NX-API is enabled, change your group_vars/nxos.yml to use the NX-API connection.

    • If you are accessing your host directly (not through a web proxy) you can remove the proxy_env configuration.
    • If you are accessing your host through a web proxy using https, change http_proxy to https_proxy.

    In this example the proxy_env variable defined in group_vars gets passed to the environment option of the module used in the task.

    Never store passwords in plain text. We recommend using SSH keys to authenticate SSH connections. Ansible supports ssh-agent to manage your SSH keys. If you must use passwords to authenticate SSH connections, we recommend encrypting them with Ansible Vault.

    The following platforms and software versions have been certified by Cisco to work with this version of Ansible.