Spec-Zone.ru › Ansible 2.5

bigip_user - Управление учетными записями пользователей и атрибутами пользователей на BIG-IP

Новое в версии 2.4.

  • Описание
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Описание

  • Управление учетными записями пользователей и атрибутами пользователей на BIG-IP. Как правило, этот модуль работает только с пользователями REST API, а не с пользователями CLI. Однако есть одно исключение, если вы укажете username_credential для root. При указании root, вы можете изменить только пароль. Другие параметры будут проигнорированы в этом случае. Изменение пароля root не является идемпотентной операцией. Поэтому он будет изменяться каждый раз, когда этот модуль пытается его изменить.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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)
Значение по умолчанию:
None
Объект словаря, содержащий данные подключения.
ssh_keyfile
Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout Значение по умолчанию:
10
Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль вернет ошибку.
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER задана.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER задана.
server_port Значение по умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT задана.
password
обязательно
Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD задана.

псевдонимы: pass, pwd
validate_certs
    Варианты:
  • no
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS задана.
transport
обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для подключения к удаленному устройству.
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER задана.
server_port
(добавлено в 2.2)
Значение по умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT задана.
shell
    Варианты:
  • bash
  • none
  • tmsh
Выберите оболочку пользователя.
state
    Варианты:
  • present ←
  • absent
Указывает, должна ли учетная запись существовать или нет, выполняя действия, если состояние отличается от указанного.
update_password
    Варианты:
  • always
  • on_create ←
always позволит обновлять пароли, если пользователь этого хочет. on_create будет устанавливать пароль только для вновь созданных пользователей. Когда username_credential равно root, это значение будет принудительно установлено в always.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER задана.
username_credential
обязательно
Имя пользователя для создания, удаления или изменения. Существует особый случай для пользователя root.

псевдонимы: name
validate_certs
(добавлено в 2.0)
    Варианты:
  • no
  • да ←
Если 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.

Примеры

- 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
список
изменено и успешно
Список строк, содержащих роли пользователя и разделы, к которым они применяются. Они задаются в формате "раздел:роль".

Пример:
['all:admin']
shell
строка
изменено и успешно
Оболочка, назначенная учетной записи пользователя

Пример:
tmsh


Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратная совместимость.

Автор

  • 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.5/modules/bigip_user_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API