Модуль fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_excluderange — исключение одного или нескольких диапазонов IP-адресов из числа назначаемых клиентам.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_excluderange.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль предназначен для настройки устройства FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
fsp_vlan_dhcpserver_excluderange dictionary | Набор параметров верхнего уровня. |
|
end_ip псевдонимы: end-ip string |
Конечный IP-адрес. |
|
id integer / обязательный |
Идентификатор. |
|
lease_time псевдонимы: lease-time integer |
Время аренды в секундах; значение 0 означает время аренды по умолчанию. |
|
start_ip псевдонимы: start-ip string |
Начальный IP-адрес. |
|
uci_match псевдонимы: uci-match string |
Включить или отключить идентификатор класса пользователя Варианты:
|
|
uci_string псевдонимы: uci-string any |
(список) Одна или несколько строк UCI в кавычках, разделённых пробелами. |
|
vci_match псевдонимы: vci-match string |
Включить или отключить идентификатор класса производителя Варианты:
|
|
vci_string псевдонимы: vci-string any |
(список) Одна или несколько строк VCI в кавычках, разделённых пробелами. |
proposed_method string | Метод, переопределяющий метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
vlan string / обязательный | Параметр (vlan) в запрошенном URL. |
workspace_locking_adom string | ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global и другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените такие аргументы, как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Exclude one or more ranges of IP addresses from being assigned to clients.
fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_excluderange:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
vlan: <your own value>
state: present # <value in [present, absent]>
fsp_vlan_dhcpserver_excluderange:
id: 0 # Required variable, integer
# end_ip: <string>
# start_ip: <string>
# vci_match: <value in [disable, enable]>
# vci_string: <list or string>
# lease_time: <integer>
# uci_match: <value in [disable, enable]>
# uci_string: <list or string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии сложных условий |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_fsp_vlan_dhcpserver_excluderange_module.html
