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

Примечание

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

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

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

Для использования в playbook укажите: dellemc.enterprise_sonic.sonic_users.

Введено в dellemc.enterprise_sonic 1.1.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр	Комментарии
config список / элементы=словарь	Указывает конфигурацию, связанную с пользователями.
name строка / обязательно	Указывает имя пользователя.
password строка	Указывает пароль пользователя.
role строка	Указывает роль пользователя. Варианты: `"admin"` `"operator"` `"netadmin"` `"secadmin"`
update_password строка	Указывает флаг обновления пароля. В случае «всегда» пароль будет обновляться каждый раз. В случае «при создании» пароль будет обновляться только при создании пользователя. Варианты: `"always"` ← (по умолчанию) `"on_create"`
state строка	Указывает операцию, которая должна быть выполнена для пользователей, настроенных на устройстве. В случае «слияния» входная конфигурация будет слита с существующей конфигурацией пользователей на устройстве. В случае «удаления» существующая конфигурация пользователей будет удалена с устройства. В случае «замены» существующая конфигурация указанного пользователя будет заменена предоставленной конфигурацией. В случае «переопределения» существующая конфигурация пользователей будет переопределена предоставленной конфигурацией. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"overridden"` `"replaced"`

Примечания

Примечание

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

Примеры

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

Значения возврата

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

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

Авторы

Niraimadaiselvam M (@niraimadaiselvamm)

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

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