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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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.
Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_peer словарь	Параметры верхнего уровня.
ca строка	Имя сертификата CA, возвращаемого командой execute vpn certificate ca list.
cn строка	Общее имя сертификата удаленного узла.
cn_type строка	Устарело, используйте cn_type. Тип общего имени сертификата удаленного узла. Варианты: `"string"` `"email"` `"FQDN"` `"ipv4"` `"ipv6"`
ldap_mode строка	Устарело, используйте ldap_mode. Режим аутентификации удаленного узла LDAP. Варианты: `"password"` `"principal-name"`
ldap_password любой тип	(список) Устарело, используйте ldap_password. Пароль для привязки к серверу LDAP.
ldap_server строка	Устарело, используйте ldap_server. Имя сервера LDAP, определенного в команде user ldap.
ldap_username строка	Устарело, используйте ldap_username. Имя пользователя для привязки к серверу LDAP.
mandatory_ca_verify строка	Устарело, используйте mandatory_ca_verify. Определяет, что происходит с удаленным узлом, если сертификат CA не установлен... Варианты: `"disable"` `"enable"`
mfa_mode строка	Устарело, используйте mfa_mode. Режим MFA для удаленной аутентификации/авторизации. Варианты: `"none"` `"password"` `"subject-identity"`
mfa_password любой тип	(список) Устарело, используйте mfa_password. Единый пароль для удаленной аутентификации.
mfa_server строка	Устарело, используйте mfa_server. Имя удаленного модуля аутентификации.

END_OF_DOCUMENT_MARKER

mfa-username string	Устаревшее, пожалуйста, переименуйте на mfa_username. Объединённое имя пользователя для удаленной аутентификации.
name string / обязательно	Имя участника.
ocsp-override-server string	Устаревшее, пожалуйста, переименуйте на ocsp_override_server. Протокол статуса сертификата онлайн.
passwd any	(список) Пароль участника, используемый для двухфакторной аутентификации.
subject string	Ограничения имени сертификата участника.
two-factor string	Устаревшее, пожалуйста, переименуйте на two_factor. Включить/выключить двухфакторную аутентификацию, применяя сертификат и пароль… Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая 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 помогают в этой задаче.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться неудачей при возвращении ненулевого rc. Вы также можете переопределить условия завершения ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_peer_module.html