fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver – без описания
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver.
Новое в версии 2.10: плагина fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation логическое значение |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| fsp_vlan_dhcpserver словарь | параметры верхнего уровня | |||
| автонастройка строка |
| нет описания | ||
| conflicted-ip-timeout целое число | нет описания | |||
| ddns-auth строка |
| нет описания | ||
| ddns-key строка | нет описания | |||
| ddns-keyname строка | нет описания | |||
| ddns-server-ip строка | нет описания | |||
| ddns-ttl целое число | нет описания | |||
| ddns-update строка |
| нет описания | ||
| ddns-update-override строка |
| нет описания | ||
| ddns-zone строка | нет описания | |||
| default-gateway строка | нет описания | |||
| dns-server1 строка | нет описания | |||
| dns-server2 строка | нет описания | |||
| dns-server3 строка | нет описания | |||
| dns-service строка |
| нет описания | ||
| domain строка | нет описания | |||
| enable строка |
| нет описания | ||
| exclude-range список / элементы=строка | нет описания | |||
| end-ip строка | нет описания | |||
| id целое число | нет описания | |||
| start-ip строка | нет описания | |||
| filename строка | нет описания | |||
| forticlient-on-net-status строка |
| нет описания | ||
| id целое число | нет описания | |||
| interface строка | нет описания | |||
| ip-mode строка |
| нет описания | ||
| ip-range список / элементы=строка | нет описания | |||
| end-ip строка | нет описания | |||
| id целое число | нет описания | |||
| start-ip строка | нет описания | |||
| ipsec-lease-hold целое число | нет описания | |||
| lease-time целое число | нет описания | |||
| mac-acl-default-action строка |
| нет описания | ||
| netmask строка | нет описания | |||
| next-server строка | нет описания | |||
| ntp-server1 строка | нет описания | |||
| ntp-server2 строка | нет описания | |||
| ntp-server3 строка | нет описания | |||
| ntp-service строка |
| нет описания | ||
| option1 строка | нет описания | |||
| option2 строка | нет описания | |||
| option3 строка | нет описания | |||
| option4 строка | нет описания | |||
| option5 строка | нет описания | |||
| option6 строка | нет описания | |||
| options список / элементы=строка | нет описания | |||
| code целое число | нет описания | |||
| id целое число | нет описания | |||
| ip строка | нет описания | |||
| type строка |
| нет описания | ||
| value строка | нет описания | |||
| reserved-address список / элементы=строка | нет описания | |||
| action строка |
| нет описания | ||
| circuit-id строка | нет описания | |||
| circuit-id-type строка |
| нет описания | ||
| description строка | нет описания | |||
| id целое число | нет описания | |||
| ip string | без описания | |||
| mac string | без описания | |||
| remote-id string | без описания | |||
| remote-id-type string |
| без описания | ||
| type string |
| без описания | ||
| server-type string |
| без описания | ||
| status string |
| без описания | ||
| tftp-server string | без описания | |||
| timezone string |
| без описания | ||
| timezone-option string |
| без описания | ||
| vci-match string |
| без описания | ||
| vci-string string | без описания | |||
| wifi-ac1 string | без описания | |||
| wifi-ac2 string | без описания | |||
| wifi-ac3 string | без описания | |||
| wins-server1 string | без описания | |||
| wins-server2 string | без описания | |||
| rc_failed list / elements=string | список кодов rc, при которых условия будут нарушены | |||
| rc_succeeded list / elements=string | список кодов rc, при которых условия будут выполнены | |||
| state string / required |
| указание на создание, обновление или удаление объекта | ||
| vlan string / required | параметр (vlan) в запрошенном URL | |||
| workspace_locking_adom string | область домена для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть global и другими, включая 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: no description
fmgr_fsp_vlan_dhcpserver:
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>
fsp_vlan_dhcpserver:
auto-configuration: <value in [disable, enable]>
conflicted-ip-timeout: <value of integer>
ddns-auth: <value in [disable, tsig]>
ddns-key: <value of string>
ddns-keyname: <value of string>
ddns-server-ip: <value of string>
ddns-ttl: <value of integer>
ddns-update: <value in [disable, enable]>
ddns-update-override: <value in [disable, enable]>
ddns-zone: <value of string>
default-gateway: <value of string>
dns-server1: <value of string>
dns-server2: <value of string>
dns-server3: <value of string>
dns-service: <value in [default, specify, local]>
domain: <value of string>
enable: <value in [disable, enable]>
exclude-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
filename: <value of string>
forticlient-on-net-status: <value in [disable, enable]>
id: <value of integer>
interface: <value of string>
ip-mode: <value in [range, usrgrp]>
ip-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
ipsec-lease-hold: <value of integer>
lease-time: <value of integer>
mac-acl-default-action: <value in [assign, block]>
netmask: <value of string>
next-server: <value of string>
ntp-server1: <value of string>
ntp-server2: <value of string>
ntp-server3: <value of string>
ntp-service: <value in [default, specify, local]>
option1: <value of string>
option2: <value of string>
option3: <value of string>
option4: <value of string>
option5: <value of string>
option6: <value of string>
options:
-
code: <value of integer>
id: <value of integer>
ip: <value of string>
type: <value in [hex, string, ip, ...]>
value: <value of string>
reserved-address:
-
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]>
server-type: <value in [regular, ipsec]>
status: <value in [disable, enable]>
tftp-server: <value of string>
timezone: <value in [00, 01, 02, ...]>
timezone-option: <value in [disable, default, specify]>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
wifi-ac1: <value of string>
wifi-ac2: <value of string>
wifi-ac3: <value of string>
wins-server1: <value of string>
wins-server2: <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_fsp_vlan_dhcpserver_module.html