ansible.builtin.nxos_user (v2.9.13) — module

Install Ansible via pip

Install with pip install ansible==2.9.13

Description

This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Usage examples

Scanned by Steampunk Spotter

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

- name: create a new user
  nxos_user:
    name: ansible
    sshkey: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
    state: present

Scanned by Steampunk Spotter

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

- name: remove all users except admin
  nxos_user:
    purge: yes

Scanned by Steampunk Spotter

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

- name: set multiple users role
  aggregate:
    - name: netop
    - name: netend
  role: network-operator
  state: present

Inputs

    
name:
    description:
    - The username to be configured on the remote Cisco Nexus device.  This argument accepts
      a string value and is mutually exclusive with the C(aggregate) argument.

role:
    aliases:
    - roles
    description:
    - The C(role) argument configures the role for the username in the device running
      configuration.  The argument accepts a string value defining the role name.  This
      argument does not check if the role has been configured on the device.

purge:
    default: 'no'
    description:
    - The C(purge) argument instructs the module to consider the resource definition absolute.  It
      will remove any previously configured usernames on the device with the exception
      of the `admin` user which cannot be deleted per nxos constraints.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The C(state) argument configures the state of the username definition as it relates
      to the device operational configuration.  When set to I(present), the username(s)
      should be configured in the device active configuration and when set to I(absent)
      the username(s) should not be in the device active configuration

sshkey:
    description:
    - The C(sshkey) argument defines the SSH public key to configure for the username.  This
      argument accepts a valid SSH key value.

provider:
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
    - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.'
    - This option will be removed in a release after 2022-06-01.
    - For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html).
    - HORIZONTALLINE
    - A dict object containing connection details.
    suboptions:
      auth_pass:
        description:
        - Specifies the password to use if required to enter privileged mode on the remote
          device.  If I(authorize) is false, then this argument does nothing. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
          will be used instead.
        type: str
      authorize:
        default: false
        description:
        - Instructs the module to enter privileged mode on the remote device before sending
          any commands.  If not specified, the device will attempt to execute all commands
          in non-privileged mode. If the value is not specified in the task, the value
          of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead.
        type: bool
      host:
        description:
        - 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.
        type: str
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote device.  This
          is a common argument used for either I(cli) or I(nxapi) transports. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
          will be used instead.
        type: str
      port:
        description:
        - Specifies the port to use when building the connection to the remote device.  This
          value applies to either I(cli) or I(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).
        type: int
      ssh_keyfile:
        description:
        - Specifies the SSH key to use to authenticate the connection to the remote device.  This
          argument is only used for the I(cli) transport. If the value is not specified
          in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will
          be used instead.
        type: str
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error. NX-API can be slow to return
          on long-running commands (sh mac, sh bgp, etc).
        type: int
      transport:
        choices:
        - cli
        - nxapi
        default: cli
        description:
        - 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.
        type: str
      use_proxy:
        default: true
        description:
        - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
          ignored.
        type: bool
      use_ssl:
        default: false
        description:
        - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi),
          otherwise this value is ignored.
        type: bool
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          device.  This value 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 C(ANSIBLE_NET_USERNAME) will
          be used instead.
        type: str
      validate_certs:
        default: false
        description:
        - If C(no), SSL certificates will not be validated. This should only be used on
          personally controlled sites using self-signed certificates.  If the transport
          argument is not nxapi, this value is ignored.
        type: bool
    type: dict

aggregate:
    aliases:
    - users
    - collection
    description:
    - The set of username objects to be configured on the remote Cisco Nexus device.  The
      list entries can either be the username or a hash of username and properties.  This
      argument is mutually exclusive with the C(name) argument.
    version_added: '2.4'
    version_added_collection: ansible.builtin

update_password:
    choices:
    - on_create
    - always
    default: always
    description:
    - Since passwords are encrypted in the device running config, this argument will instruct
      the module when to change the password.  When set to C(always), the password will
      always be updated in the device and when set to C(on_create) the password will be
      updated only if the username is created.

configured_password:
    description:
    - The password to be configured on the network device. The password needs to be provided
      in cleartext and it will be encrypted on the device. Please note that this option
      is not same as C(provider password).
    version_added: '2.4'
    version_added_collection: ansible.builtin

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - name ansible
  - name ansible password password
  type: list
delta:
  description: The time elapsed to perform all operations
  returned: always
  sample: '0:00:10.469466'
  type: str
end:
  description: The time the job ended
  returned: always
  sample: '2016-11-16 10:38:25.595612'
  type: str
start:
  description: The time the job started
  returned: always
  sample: '2016-11-16 10:38:15.126146'
  type: str