fortinet.fortimanager.fmgr_devprof_device_profile_fortianalyzer – без описания

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation булево		Варианты: нет ← да	устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров
devprof строка / обязательно			параметр (devprof) в запрошенном URL
devprof_device_profile_fortianalyzer словарь			параметры верхнего уровня
	managed-sn строка		без описания
	target строка	Варианты: нет this-fmg управляемый другие	без описания
	target-ip строка		без описания
	target-sn строка		без описания
rc_failed список / элементы=строка			список кодов rc, при которых условия будут игнорироваться
rc_succeeded список / элементы=строка			список кодов rc, при которых условия будут игнорироваться
state строка / обязательно		Варианты: present absent	директива для создания, обновления или удаления объекта
workspace_locking_adom строка			adom для блокировки FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая root
workspace_locking_timeout целое число		Значение по умолчанию: 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: no description
     fmgr_devprof_device_profile_fortianalyzer:
        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, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_device_profile_fortianalyzer:
           managed-sn: <value of string>
           target: <value in [none, this-fmg, managed, ...]>
           target-ip: <value of string>
           target-sn: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Детальное сообщение ответа 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_devprof_device_profile_fortianalyzer_module.html