community.network.icx_user – Управление учетными записями пользователей на коммутаторах Ruckus ICX 7000 серии.
Примечание
Этот плагин входит в состав коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в книге задач, укажите: community.network.icx_user.
Обзор
- Этот модуль создает или обновляет учетные записи пользователей на сетевых устройствах. Он позволяет книгам задач управлять либо отдельными именами пользователей, либо совокупностью имен пользователей в текущей рабочей конфигурации. Он также поддерживает очистку имен пользователей из конфигурации, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_time строка | Этот параметр указывает время, к которому следует установить время доступа к файлу. Должно сохраняться, когда изменения не требуются, YYYYMMDDHHMM.SS при использовании формата времени по умолчанию или now. Значение по умолчанию — None, что означает, что preserve является значением по умолчанию для состояния=[file,directory,link,hard], а now — по умолчанию для состояния=touch | ||
| aggregate список / элементы=строка | Набор объектов имен пользователей, которые должны быть настроены на удаленном устройстве ICX. Элементы списка могут представлять собой имя пользователя или хеш имени пользователя и свойств. Этот аргумент взаимоисключающий с аргументом name. Псевдонимы: users, collection | ||
| access_time строка | Этот параметр указывает время, к которому следует установить время доступа к файлу. Должно сохраняться, когда изменения не требуются, YYYYMMDDHHMM.SS при использовании формата времени по умолчанию или now. Значение по умолчанию — None, что означает, что preserve является значением по умолчанию для состояния=[file,directory,link,hard], а now — по умолчанию для состояния=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 Platform Options.
Примеры
- 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/icx_user_module.html
