Spec-Zone.ru › Ansible 2.6

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)
Объект словаря, содержащий данные подключения.
password
обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.

псевдонимы: pass, pwd
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена.
server_port По умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
bool
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверяться. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.
timeout По умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
ssh_keyfile
Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
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
bool

(добавлен в 2.0)
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не будут проверяться. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.

Примечания

Примечание

  • Требуются версии BIG-IP >= 12.0.0
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
  • Необходимо установить Python-пакет f5-sdk на хосте. Это так же просто, как 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
список
изменено и успешно
Список строк, содержащих роли пользователя и разделы, к которым они применяются. Они указаны в формате "раздел:роль".

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

Пример:
tmsh


Статус

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

Техническое обслуживание

Этот модуль помечен как общественный, что означает, что он поддерживается сообществом Ansible. См. Поддержка и обслуживание модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом 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.6/modules/bigip_user_module.html

Spec-Zone.ru

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