Модуль dellemc.enterprise_sonic.sonic_users — управление пользователями и их параметрами

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install dellemc.enterprise_sonic.

Чтобы использовать коллекцию в плейбуке, укажите: dellemc.enterprise_sonic.sonic_users.

Добавлено в dellemc.enterprise_sonic 1.1.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль обеспечивает управление конфигурацией параметров пользователей на устройствах под управлением Enterprise SONiC.

Параметры

Параметр	Комментарии
config list / elements=dictionary	Задает конфигурацию, связанную с пользователями.
name string / обязательный	Задает имя пользователя.
password string	Задает пароль пользователя.
role string	Задает роль пользователя. Варианты: `"admin"` `"operator"` `"netadmin"` `"secadmin"`
ssh_key string добавлено в dellemc.enterprise_sonic 3.1.0	Задает ключ SSH пользователя для существующего пользователя. Пару ключей SSH (открытый и закрытый ключи) можно создать с помощью команды ssh-keygen на сервере, с которого пользователь будет подключаться к устройству SONiC. В поле ssh_key указывается только открытый ключ. Параметр ssh_key можно «объединить» только после первоначального создания затрагиваемого экземпляра «user» и необходимо выполнять слияние, не указывая никаких дополнительных параметров, кроме «name». Его можно удалить как отдельный параметр, только если он является единственным указанным параметром. Если для удаления указаны другие параметры, удаляется весь экземпляр пользователя.
update_password string	Задает флаг обновления пароля. При значении always пароль будет обновляться при каждом запуске. При значении on_create пароль будет обновляться только при создании пользователя. Варианты: `"always"` ← (по умолчанию) `"on_create"`
state string	Задает операцию, выполняемую с настроенными на устройстве пользователями. При значении merged входная конфигурация объединяется с существующей конфигурацией пользователей на устройстве. При значении deleted существующая конфигурация пользователей удаляется с устройства. При значении replaced существующая конфигурация указанного пользователя заменяется предоставленной конфигурацией. При значении overridden существующая конфигурация пользователей заменяется предоставленной конфигурацией. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"overridden"` `"replaced"`

Примечания

Примечание

Проверено на Enterprise SONiC Distribution by Dell Technologies.
Поддерживает check_mode.

Примеры

# 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
# ----------------------------------------------------------------------

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
after list / elements=string	Конфигурация после выполнения модуля. Возвращается: при изменении Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
after(generated) list / elements=string	Сгенерированная конфигурация модуля. Возвращается: при `check_mode` Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
before list / elements=string	Конфигурация до выполнения модуля. Возвращается: всегда Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
commands list / elements=string	Набор команд, отправленных на удаленное устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

Niraimadaiselvam M (@niraimadaiselvamm)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_users_module.html