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

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать его в плейбуке, укажите: f5networks.f5_modules.bigip_user.

Добавлен в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
full_name строка	Полное имя пользователя.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"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`. Часть раздела кортежа должна быть существующим разделом или значением «все».
password_credential строка	Установите пароль пользователя на это незашифрованное значение. `password_credential` требуется при создании новой учетной записи.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem логическое	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как ее имя вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение, которое следует использовать при подключении к удаленному устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs логическое	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяемые сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
shell строка	Необязательно задать оболочку пользователя. Варианты: `"bash"` `"none"` `"tmsh"`
state строка	Определяет, должна ли учетная запись существовать или нет, принимая действия, если состояние отличается от указанного. Варианты: `"present"` ← (по умолчанию) `"absent"`
update_password строка	`always` позволяет пользователю обновлять пароли. `on_create` только устанавливает пароль для вновь созданных пользователей. Когда `username_credential` равно `root`, это значение принудительно устанавливается в `always`. Варианты: `"always"` ← (по умолчанию) `"on_create"`

username_credential

aliases: name

string / обязательно

Имя пользователя для создания, удаления или изменения.

Пользователь root удалить нельзя.

Примечания

Примечание

Требуются версии BIG-IP >= 12.0.0
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы гарантировать сохранение специфической для BIG-IP конфигурации на диске, убедитесь, что включён хотя бы один task, использующий модуль f5networks.f5_modules.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 строка	Полное имя пользователя. Возвращается: changed и success Пример: `"John Doe"`
partition_access список / элементы=строка	Список строк, содержащих роли пользователя и к каким разделам они применяются. Они задаются в формате «раздел:роль». Возвращается: changed и success Пример: `["all:admin"]`
shell строка	Оболочка, назначенная учётной записи пользователя. Возвращается: changed и success Пример: `"tmsh"`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_user_module.html