bigip_user – Управление учетными записями пользователей и атрибутами пользователей на BIG-IP
Новая версия 2.4.
Описание
- Управление учетными записями пользователей и атрибутами пользователей на BIG-IP. Как правило, этот модуль работает только с пользователями REST API, а не с пользователями CLI. При указании
root, вы можете изменить только пароль. Остальные ваши параметры будут проигнорированы в этом случае. Изменение пароляrootне является идемпотентной операцией. Поэтому он будет изменяться каждый раз, когда этот модуль пытается его изменить.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| full_name - | Полное имя пользователя. | ||
| partition - добавлен в 2.5 | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| partition_access - | Указывает административный раздел, к которому имеет доступ пользователь. partition_access требуется при создании новой учетной записи. Должен иметь вид "partition:role". Допустимые роли включают 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 | Значение по умолчанию: null | Объект словаря, содержащий данные подключения. | |
| 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 boolean |
| Если 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 boolean добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Требуются версии BIG-IP >= 12.0.0
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы гарантировать, что конфигурация, специфичная для BIG-IP, сохранится на диске, убедитесь, что включён хотя бы один task, использующий модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Add the user 'johnd' as an admin
bigip_user:
server: lb.mydomain.com
user: admin
password: secret
username_credential: johnd
password_credential: password
full_name: John Doe
partition_access: all:admin
update_password: on_create
state: present
delegate_to: localhost
- name: Change the user "johnd's" role and shell
bigip_user:
server: lb.mydomain.com
user: admin
password: secret
username_credential: johnd
partition_access: NewPartition:manager
shell: tmsh
state: present
delegate_to: localhost
- name: Make the user 'johnd' an admin and set to advanced shell
bigip_user:
server: lb.mydomain.com
user: admin
password: secret
name: johnd
partition_access: all:admin
shell: bash
state: present
delegate_to: localhost
- name: Remove the user 'johnd'
bigip_user:
server: lb.mydomain.com
user: admin
password: secret
name: johnd
state: absent
delegate_to: localhost
- name: Update password
bigip_user:
server: lb.mydomain.com
user: admin
password: secret
state: present
username_credential: johnd
password_credential: newsupersecretpassword
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:
server: lb.mydomain.com
user: admin
password: secret
state: present
username_credential: admin
password_credential: NewSecretPassword
delegate_to: localhost
- name: Change the root user's password
bigip_user:
server: lb.mydomain.com
user: admin
password: secret
username_credential: root
password_credential: secret
state: present
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| full_name строка | изменён и успешно | Полное имя пользователя Пример: Иван Иванов |
| partition_access список | изменён и успешно | Список строк, содержащих роли пользователя и к которым они применяются. Они задаются в виде "раздел:роль". Пример: ['все:админ'] |
| shell строка | изменён и успешно | Оболочка, назначенная учетной записи пользователя Пример: tmsh |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнёром Ansible. [сертифицировано]
Авторы
- Тимофей Рупп (@caphrim007)
- Войцех Выпиор (@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.7/modules/bigip_user_module.html