community.network.icx_user – Manage the user accounts on Ruckus ICX 7000 series switches.

Note

This plugin is part of the community.network collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.icx_user.

Synopsis

  • This module creates or updates user account on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Parameters

Parameter Choices/Defaults Comments
access_time
string
This parameter indicates the time the file's access time should be set to. Should be preserve when no modification is required, YYYYMMDDHHMM.SS when using default time format, or now. Default is None meaning that preserve is the default for state=[file,directory,link,hard] and now is default for state=touch
aggregate
list / elements=string
The set of username objects to be configured on the remote ICX device. The list entries can either be the username or a hash of username and properties. This argument is mutually exclusive with the name argument.

aliases: users, collection
access_time
string
This parameter indicates the time the file's access time should be set to. Should be preserve when no modification is required, YYYYMMDDHHMM.SS when using default time format, or now. Default is None meaning that preserve is the default for state=[file,directory,link,hard] and now is default for state=touch
check_running_config
boolean
    Choices:
  • no
  • yes
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter.
configured_password
string
The password to be configured on the ICX device.
name
string / required
The username to be configured on the ICX device.
nopassword
boolean
    Choices:
  • no
  • yes
Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password.
privilege
string
    Choices:
  • 0
  • 4
  • 5
The privilege level to be granted to the user
state
string
    Choices:
  • present
  • absent
Configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
update_password
string
    Choices:
  • on_create
  • always
This argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.
check_running_config
boolean
    Choices:
  • no
  • yes ←
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter.
configured_password
string
The password to be configured on the ICX device.
name
string / required
The username to be configured on the ICX device.
nopassword
boolean
    Choices:
  • no ←
  • yes
Defines the username without assigning a password. This will allow the user to login to the system without being authenticated by a password.
privilege
string
    Choices:
  • 0
  • 4
  • 5
Default:
0
The privilege level to be granted to the user
purge
boolean
    Choices:
  • no ←
  • yes
If set to true module will remove any previously configured usernames on the device except the current defined set of users.
state
string
    Choices:
  • present ←
  • absent
Configures the state of the username definition as it relates to the device operational configuration. When set to present, the username(s) should be configured in the device active configuration and when set to absent the username(s) should not be in the device active configuration
update_password
string
    Choices:
  • on_create
  • always ←
This argument will instruct the module when to change the password. When set to always, the password will always be updated in the device and when set to on_create the password will be updated only if the username is created.

Notes

Note

Examples

- name: Create a new user without password
  community.network.icx_user:
    name: user1
    nopassword: true

- name: Create a new user with password
  community.network.icx_user:
    name: user1
    configured_password: 'newpassword'

- name: Remove users
  community.network.icx_user:
    name: user1
    state: absent

- name: Set user privilege level to 5
  community.network.icx_user:
    name: user1
    privilege: 5

Return Values

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

Key Returned Description
commands
list / elements=string
always
The list of configuration mode commands to send to the device

Sample:
['username ansible nopassword', 'username ansible password-string alethea123', 'no username ansible', 'username ansible privilege 5', 'username ansible enable']


Authors

  • Ruckus Wireless (@Commscope)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/icx_user_module.html