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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

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

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

Новый в версии 1.0.0: of f5networks.f5_modules

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

Обзор

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

Примечания

Примечание

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

Авторы

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

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