dellemc.enterprise_sonic.sonic_users module – Manage users and its parameters

Note

This module is part of the dellemc.enterprise_sonic collection (version 3.2.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 dellemc.enterprise_sonic.

To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_users.

New in dellemc.enterprise_sonic 1.1.0

Synopsis

• This module provides configuration management of users parameters on devices running Enterprise SONiC.

Parameters

Parameter	Comments
config list / elements=dictionary	Specifies the users related configuration.
name string / required	Specifies the name of the user.
password string	Specifies the password of the user.
role string	Specifies the role of the user. Choices: "admin" "operator" "netadmin" "secadmin"
ssh_key string added in dellemc.enterprise_sonic 3.1.0	Specifies the user ssh key for an existing user. The ssh key pair (public and private key) can be created using ssh-keygen command on the server from where the user will connect to the SONiC device. Only the public key is configured in the ssh_key field. The ssh_key option can only be “merged” after initial creation of the affected “user” instance and must be merged without any additional options specified other than “name”. It can only be deleted as an individual option if it is the only option specified. If other options are specified for deletion, the entire user instance is deleted.
update_password string	Specifies the update password flag. In case of always, password will be updated every time. In case of on_create, password will be updated only when user is created. Choices: "always" ← (default) "on_create"
state string	Specifies the operation to be performed on the users configured on the device. In case of merged, the input configuration will be merged with the existing users configuration on the device. In case of deleted the existing users configuration will be removed from the device. In case of replaced, the existing specified user configuration will be replaced with provided configuration. In case of overridden, the existing users configuration will be overridden with the provided configuration. Choices: "merged" ← (default) "deleted" "overridden" "replaced"

Notes

Note

• Tested against Enterprise SONiC Distribution by Dell Technologies.

• Supports check_mode.

Examples

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# sysadmin                          admin
# sysoperator                       operator

- name: Delete user
  dellemc.enterprise_sonic.sonic_users:
    config:
      - name: sysoperator
    state: deleted

# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# sysadmin                          admin

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# sysadmin                          admin
# sysoperator                       operator

- name: Delete all users configurations except admin
  dellemc.enterprise_sonic.sonic_users:
    config:
    state: deleted

# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin

# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin

- name: Merge users configurations
  dellemc.enterprise_sonic.sonic_users:
    config:
      - name: sysadmin
        role: admin
        password: admin
        update_password: always
      - name: sysoperator
        role: operator
        password: operator
        update_password: always
    state: merged

# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# sysadmin                          admin
# sysoperator                       operator

# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# sysadmin                          admin
# sysoperator                       operator

- name: Override users configurations
  dellemc.enterprise_sonic.sonic_users:
    config:
      - name: user1
        role: secadmin
        password: 123abc
        update_password: always
    state: overridden

# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# user1                             secadmin

# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# user1                             secadmin
# user2                             operator

- name: Replace users configurations
  dellemc.enterprise_sonic.sonic_users:
    config:
      - name: user1
        role: operator
        password: 123abc
        update_password: always
      - name: user2
        role: netadmin
        password: 123abc
        update_password: always
    state: replaced

# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# User                              Role(s)
# ----------------------------------------------------------------------
# admin                             admin
# user1                             operator
# user2                             netadmin

# Using Merged
#
# Before state:
# -------------
#
# sonic# show users sshkey
#
# sonic# show users configured
# --------------------------------------------------------------------
# User                           Role(s)
# --------------------------------------------------------------------
# admin                          admin
# user1                          operator
# user2                          netadmin

- name: Configure user sshkey
  dellemc.enterprise_sonic.sonic_users:
    config:
      - name: user1
        ssh_key: >
          ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCoCc6lPgrSAXZByJAPH6cwn0Mhj9J1zYUfiLc
          /iz/IwHt/7s++bN1tnL6bAan6Ssg4XvOF0mcP5K53AAP+bX5WHy/d1wm7icllBI0JT150qp9nY5y
          bjNdvLH11cxqc+mmNYa7d40fpeoUgMdSBGtSL0jY2PHHRCvVscFYjSm6tQQ== root@sonic
    state: merged

# After state:
# ------------
#
# sonic# show users configured
# ----------------------------------------------------------------------
# sonic# show users sshKey
# User: user1
# SSH Key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCoCc6lPgrSAXZByJAPH6cwn0Mhj9J1zYUfiLc/iz/IwHt/7s
#          ++bN1tnL6bAan6Ssg4XvOF0mcP5K53AAP+bX5WHy/d1wm7icllBI0JT150qp9nY5ybjNdvLH11cxqc+mmNYa7d
#          40fpeoUgMdSBGtSL0jY2PHHRCvVscFYjSm6tQQ== root@sonic
# ----------------------------------------------------------------------

# Using Deleted
#
# Before state:
# -------------
#
# sonic# show users sshKey
# User: user1
# SSH Key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDHD2TJqQ/Fve+fG5i6heOJH55wgbEf+7kTtUGBUtNttQ9OXgBRr
#          A2h2GKSyUNlyfaVijBrcr2MKwhSASvk58WnEqZhfmmhRDsdNVXPlMQuDBheIlCaXyOh+URJZCfmfeERSVO7kjRhqM
#          mbHlpTbMDHdFgYEvHGcrHMwIZyZ6KbBw== root@sonic
# ----------------------------------------------------------------------

- name: Delete sshkey for existing users
  dellemc.enterprise_sonic.sonic_users:
    config:
      - name: user1
        ssh_key:
    state: deleted

# After state:
# ------------
#
# sonic# show users sshkey
# ----------------------------------------------------------------------

Return Values

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

Key	Description
after list / elements=string	The resulting configuration module invocation. Returned: when changed Sample: ["The configuration returned will always be in the same format as the parameters above.\n"]
after(generated) list / elements=string	The generated configuration module invocation. Returned: when check_mode Sample: ["The configuration returned will always be in the same format as the parameters above.\n"]
before list / elements=string	The configuration prior to the module invocation. Returned: always Sample: ["The configuration returned will always be in the same format as the parameters above.\n"]
commands list / elements=string	The set of commands pushed to the remote device. Returned: always Sample: ["command 1", "command 2", "command 3"]

Authors

• Niraimadaiselvam M (@niraimadaiselvamm)

Collection links

• Issue Tracker
• Repository (Sources)