cisco.nxos.nxos_user (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

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
  cisco.nxos.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
  cisco.nxos.nxos_user:
    purge: true

Scanned by Steampunk Spotter

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

- name: set multiple users role
  cisco.nxos.nxos_user:
    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.
    type: str

purge:
    default: false
    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

roles:
    aliases:
    - role
    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.
    elements: str
    type: list

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
    type: str

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

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.
    elements: dict
    suboptions:
      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.
        type: str
      hashed_password:
        description:
        - The hashed password to be configured on the network device. The password needs
          to already be encrypted.
        type: str
      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.
        type: str
      roles:
        aliases:
        - role
        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.
        elements: str
        type: list
      sshkey:
        description:
        - The C(sshkey) argument defines the SSH public key to configure for the username.  This
          argument accepts a valid SSH key value.
        type: str
      state:
        choices:
        - present
        - absent
        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
        type: str
      update_password:
        choices:
        - on_create
        - 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.
        type: str
    type: list

hashed_password:
    description:
    - The hashed password to be configured on the network device. The password needs to
      already be encrypted.
    type: str

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.
    type: str

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.
    type: str

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