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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation булево		Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров
fsp_vlan_dhcpserver_reservedaddress словарь			устанавливаемые параметры верхнего уровня
	action строка	Варианты: назначить блокировать зарезервировать	без описания
	circuit-id строка		без описания
	circuit-id-type строка	Варианты: шестнадцатеричный строка	без описания
	description строка		без описания
	id целое число		без описания
	ip строка		без описания
	mac строка		без описания
	remote-id строка		без описания
	remote-id-type строка	Варианты: шестнадцатеричный строка	без описания
	type строка	Варианты: mac option82	без описания
rc_failed список / элементы=строка			список rc-кодов, при которых выполнение завершится с ошибкой
rc_succeeded список / элементы=строка			список rc-кодов, при которых выполнение завершится успешно
state строка / обязательно		Варианты: present absent	директива для создания, обновления или удаления объекта
vlan строка / обязательно			параметр (vlan) в запрошенном URL
workspace_locking_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_fsp_vlan_dhcpserver_reservedaddress:
        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>
        vlan: <your own value>
        state: <value in [present, absent]>
        fsp_vlan_dhcpserver_reservedaddress:
           action: <value in [assign, block, reserved]>
           circuit-id: <value of string>
           circuit-id-type: <value in [hex, string]>
           description: <value of string>
           id: <value of integer>
           ip: <value of string>
           mac: <value of string>
           remote-id: <value of string>
           remote-id-type: <value in [hex, string]>
           type: <value in [mac, option82]>

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

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

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