fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_options – без описания
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_options.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается только в случае, если схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров | |
| fsp_vlan_dhcpserver_options словарь | параметры верхнего уровня | ||
| code целое число | без описания | ||
| id целое число | без описания | ||
| ip строка | без описания | ||
| type строка |
| без описания | |
| value строка | без описания | ||
| rc_failed список / элементы=строка | список кодов rc, при которых выполнение завершится ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых выполнение завершится успешно | ||
| state строка / обязательный |
| направление для создания, обновления или удаления объекта | |
| vlan строка / обязательный | параметр (vlan) в запрошенном URL | ||
| 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_fsp_vlan_dhcpserver_options:
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_options:
code: <value of integer>
id: <value of integer>
ip: <value of string>
type: <value in [hex, string, ip, ...]>
value: <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_fsp_vlan_dhcpserver_options_module.html
