fortinet.fortimanager.fmgr_fmupdate_fdssetting_pushoverridetoclient_announceip – Объявление IP-адресов для устройства.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
fmupdate_fdssetting_pushoverridetoclient_announceip словарь			устанавливаемые параметры верхнего уровня
	id целое число	По умолчанию: 0	Идентификатор IP-адреса объявления (1 - 10).
	ip строка	По умолчанию: "0.0.0.0"	Объявляемый IPv4-адрес.
	port целое число	По умолчанию: 8890	Порт объявления IP (1 - 65535, по умолчанию = 8890).
rc_failed список / элементы=строка			список кодов rc, при которых условия будут игнорироваться
rc_succeeded список / элементы=строка			список кодов rc, при которых условия будут игнорироваться
state строка / обязательный		Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_adom строка			домен для блокировки FortiManager, работающего в режиме рабочей области, значение может быть global и другими, включая 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: Announce IP addresses for the device.
     fmgr_fmupdate_fdssetting_pushoverridetoclient_announceip:
        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, ...]
        state: <value in [present, absent]>
        fmupdate_fdssetting_pushoverridetoclient_announceip:
           id: <value of integer>
           ip: <value of string>
           port: <value of integer>

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

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

Ключ	Возвращаемое значение	Описание
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_fmupdate_fdssetting_pushoverridetoclient_announceip_module.html