Модуль fortinet.fortimanager.fmgr_user_peer — настройка пользователей-пиров.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_user_peer.

Добавлено в fortinet.fortimanager 2.0.0

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

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
user_peer dictionary	Параметры верхнего уровня.
ca string	Имя сертификата CA, полученное в результате выполнения команды execute vpn certificate ca list.
cn string	Общее имя сертификата пира.
cn_type псевдонимы: cn-type string	Тип общего имени сертификата пира. Варианты: `"string"` `"email"` `"FQDN"` `"ipv4"` `"ipv6"`
ldap_mode псевдонимы: ldap-mode string	Режим аутентификации LDAP-пира. Варианты: `"password"` `"principal-name"`
ldap_password псевдонимы: ldap-password any	(список) Пароль для привязки к серверу LDAP.
ldap_server псевдонимы: ldap-server string	Имя сервера LDAP, определенного с помощью команды user ldap.
ldap_username псевдонимы: ldap-username string	Имя пользователя для привязки к серверу LDAP.
mandatory_ca_verify псевдонимы: mandatory-ca-verify string	Определяет, что произойдет с пиром, если сертификат CA не установлен. Варианты: `"disable"` `"enable"`
mfa_mode псевдонимы: mfa-mode string	Режим MFA для удаленной аутентификации и авторизации пира. Варианты: `"none"` `"password"` `"subject-identity"`
mfa_password псевдонимы: mfa-password any	(список) Единый пароль для удаленной аутентификации.
mfa_server псевдонимы: mfa-server string	Имя удаленного средства аутентификации.
mfa_username псевдонимы: mfa-username string	Единое имя пользователя для удаленной аутентификации.
name string / обязательный	Имя пира.
ocsp_override_server псевдонимы: ocsp-override-server string	Протокол проверки статуса сертификата в режиме онлайн
passwd any	(список) Пароль пира, используемый для двухфакторной аутентификации.
subject string	Ограничения имени сертификата пира.
two_factor псевдонимы: two-factor string	Включение или отключение двухфакторной аутентификации с использованием сертификата и пароля. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов задаются в стиле snake_case с использованием символов подчеркивания. Замените аргументы, например «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, но будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля может завершиться ошибкой, если возвращен ненулевой код rc. Условия успешного выполнения или ошибки можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure peer users.
      fortinet.fortimanager.fmgr_user_peer:
        bypass_validation: false
        adom: ansible
        state: present
        user_peer:
          cn_type: email # <value in [string, email, FQDN, ...]>
          name: ansible-test-peer
          passwd: fortinet

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the peer users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_peer"
          params:
            adom: "ansible"
            peer: "your_value"

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_user_peer_module.html