fortinet.fortimanager.fmgr_system_admin_user_adom – Домен администратора.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_admin_user_adom.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed list / elements=string			список кодов rc, при которых будут игнорироваться условия для завершения работы с ошибкой
rc_succeeded list / elements=string			список кодов rc, при которых будут игнорироваться условия для успешного завершения работы
state string / required		Варианты: present absent	директива для создания, обновления или удаления объекта
system_admin_user_adom dictionary			устанавливаемые параметры верхнего уровня
	adom-name string		Имена домен администратора.
user string / required			параметр (user) в запрошенном URL
workspace_locking_adom string			домен для блокировки FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая root
workspace_locking_timeout integer		Значение по умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем

Примечания

Примечание

В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачно при возвращении ненулевого кода rc. Также вы можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Admin domain.
     fmgr_system_admin_user_adom:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        user: <your own value>
        state: <value in [present, absent]>
        system_admin_user_adom:
           adom-name: <value of string>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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