bigip_user – Управление учетными записями пользователей и атрибутами пользователей на BIG-IP
Новая версия с 2.4.
Описание
- Управление учетными записями пользователей и атрибутами пользователей на BIG-IP. Обычно этот модуль работает только с пользователями REST API, а не с пользователями командной строки. При указании
root, вы можете изменить только пароль. Остальные параметры будут проигнорированы. Изменение пароляrootне является идемпотентной операцией. Поэтому он будет изменён каждый раз, когда этот модуль пытается его изменить.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| full_name строка | Полное имя пользователя. | ||
| partition строка добавлено в 2.5 | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| partition_access список | Указывает административный раздел, к которому имеет доступ пользователь. partition_access требуется при создании новой учетной записи. Должен быть в формате "раздел:роль".Допустимые роли включают acceleration-policy-editor, admin, application-editor, auditor, certificate-manager, guest, irule-manager, manager, no-access, operator, resource-admin, user-manager, web-application-security-administrator, и web-application-security-editor.Часть раздела кортежа должна быть существующим разделом или значением 'all'. | ||
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| password_credential строка | Установите пароль пользователя на это незашифрованное значение. password_credential требуется при создании новой учетной записи. | ||
| provider словарь добавлено в 2.5 | Объект типа dict, содержащий данные подключения. | ||
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. | |
| transport строка |
| Настраивает транспортное подключение для подключения к удалённому устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER. | ||
| server_port целое число добавлено в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_SERVER_PORT. | |
| shell строка |
| Необязательно задать оболочку пользователя. | |
| state строка |
| Должна существовать ли учетная запись или нет, выполняя действия, если состояние отличается от указанного. | |
| update_password строка |
| always позволит обновлять пароли, если пользователь пожелает. on_create будет устанавливать пароль только для вновь созданных пользователей.Когда username_credential равно root, это значение будет принудительно установлено в always. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения F5_USER. | ||
| username_credential строка / обязательно | Имя пользователя для создания, удаления или изменения. Пользователь root удалить нельзя.псевдонимы: name | ||
| validate_certs булево добавлено в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Требует версию BIG-IP >= 12.0.0
- Для получения дополнительной информации об использовании Ansible для управления устройствами F5 Networks см. https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диск, убедитесь, что вы включили по крайней мере одну задачу, которая использует модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Add the user 'johnd' as an admin
bigip_user:
username_credential: johnd
password_credential: password
full_name: John Doe
partition_access: all:admin
update_password: on_create
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Change the user "johnd's" role and shell
bigip_user:
username_credential: johnd
partition_access: NewPartition:manager
shell: tmsh
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Make the user 'johnd' an admin and set to advanced shell
bigip_user:
name: johnd
partition_access: all:admin
shell: bash
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove the user 'johnd'
bigip_user:
name: johnd
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Update password
bigip_user:
state: present
username_credential: johnd
password_credential: newsupersecretpassword
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
# Note that the second time this task runs, it would fail because
# The password has been changed. Therefore, it is recommended that
# you either,
#
# * Put this in its own playbook that you run when you need to
# * Put this task in a `block`
# * Include `ignore_errors` on this task
- name: Change the Admin password
bigip_user:
state: present
username_credential: admin
password_credential: NewSecretPassword
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Change the root user's password
bigip_user:
username_credential: root
password_credential: secret
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Значения возврата
Общие возвращаемые значения документированы здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| full_name строка | изменено и успешно | Полное имя пользователя Пример: John Doe |
| partition_access список | изменено и успешно | Список строк, содержащих роли пользователя и разделы, к которым они применяются. Они задаются в формате "раздел:роль". Пример: ['all:admin'] |
| shell строка | изменено и успешно | Оболочка, назначенная учетной записи пользователя Пример: tmsh |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_user_module.html