community.network.icx_user – Управление учетными записями пользователей на коммутаторах Ruckus ICX 7000 серии.
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.icx_user.
Описание
- Этот модуль создает или обновляет учетные записи пользователей на сетевых устройствах. Он позволяет плейбукам управлять либо отдельными именами пользователей, либо совокупностью имен пользователей в текущей конфигурации. Он также поддерживает удаление имен пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_time строка | Этот параметр указывает время, к которому следует установить время доступа к файлу. Следует сохранить, когда изменения не требуются, YYYYMMDDHHMM.SS при использовании формата времени по умолчанию или now. Значение по умолчанию — None, что означает, что preserve — значение по умолчанию для state=[file,directory,link,hard], а now — по умолчанию для state=touch | ||
| aggregate список / элементы=строка | Набор объектов имен пользователей, которые должны быть настроены на удаленном устройстве ICX. Элементы списка могут быть либо именем пользователя, либо хешем имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом name.псевдонимы: users, collection | ||
| access_time строка | Этот параметр указывает время, к которому следует установить время доступа к файлу. Следует сохранить, когда изменения не требуются, YYYYMMDDHHMM.SS при использовании формата времени по умолчанию или now. Значение по умолчанию — None, что означает, что preserve — значение по умолчанию для state=[file,directory,link,hard], а now — по умолчанию для state=touch | ||
| check_running_config логическое значение |
| Проверить текущую конфигурацию. Это можно задать как переменную среды. Модуль будет использовать значение переменной среды (по умолчанию: True), если оно не переопределено путем указания его как параметра модуля. | |
| configured_password строка | Пароль, который будет настроен на устройстве ICX. | ||
| name строка / требуется | Имя пользователя, которое будет настраиваться на устройстве ICX. | ||
| nopassword логическое значение |
| Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без проверки пароля. | |
| privilege строка |
| Уровень привилегий, предоставляемый пользователю. | |
| state строка |
| Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в present имя пользователя(ов) должно быть настроено в активной конфигурации устройства, а при установке в absent имя пользователя(ов) не должно быть в активной конфигурации устройства. | |
| update_password строка |
| Этот аргумент указывает, когда модуль должен изменить пароль. При установке в always, пароль всегда будет обновлен на устройстве, а при установке в on_create пароль будет обновлен только в случае создания имени пользователя. | |
| check_running_config логическое значение |
| Проверить текущую конфигурацию. Это можно задать как переменную среды. Модуль будет использовать значение переменной среды (по умолчанию: True), если оно не переопределено путем указания его как параметра модуля. | |
| configured_password строка | Пароль, который будет настроен на устройстве ICX. | ||
| name строка / требуется | Имя пользователя, которое будет настраиваться на устройстве ICX. | ||
| nopassword логическое значение |
| Определяет имя пользователя без присвоения пароля. Это позволит пользователю войти в систему без проверки пароля. | |
| privilege строка |
0 | Уровень привилегий, предоставляемый пользователю. | |
| purge логическое значение |
| Если установлено в значение true, модуль удалит все ранее настроенные имена пользователей на устройстве, кроме текущего набора определенных пользователей. | |
| state строка |
| Настраивает состояние определения имени пользователя по отношению к рабочей конфигурации устройства. При установке в present имя пользователя(ов) должно быть настроено в активной конфигурации устройства, а при установке в absent имя пользователя(ов) не должно быть в активной конфигурации устройства. | |
| update_password строка |
| Этот аргумент указывает, когда модуль должен изменить пароль. При установке в always, пароль всегда будет обновлен на устройстве, а при установке в on_create пароль будет обновлен только в случае создания имени пользователя. | |
Примечания
Примечание
- Проверено на ICX 10.1.
- Дополнительную информацию об использовании платформы ICX см. в руководстве по платформе ICX OS.
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список команд конфигурации, которые необходимо отправить на устройство Пример: ['username ansible nopassword', 'username ansible password-string alethea123', 'no username ansible', 'username ansible privilege 5', 'username ansible enable'] |
Авторы
- 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/2.11/collections/community/network/icx_user_module.html