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

Примечание

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

Авторы

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

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

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