Модуль fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress — параметры DHCP-сервера для назначения IP-настроек определённым MAC-адресам.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах указаны все параметры и значения, которые необходимо изменить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
dynamic_mapping string / обязательный | Параметр (dynamic_mapping) в запрашиваемом URL. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
fsp_vlan_dynamicmapping_dhcpserver_reservedaddress dictionary | Набор параметров верхнего уровня. |
|
action string |
Действие. Варианты:
|
|
circuit_id псевдонимы: circuit-id string |
Идентификатор канала. |
|
circuit_id_type псевдонимы: circuit-id-type string |
Тип идентификатора канала. Варианты:
|
|
description string |
Описание. |
|
id integer / обязательный |
Идентификатор. |
|
ip string |
IP-адрес. |
|
mac string |
MAC-адрес. |
|
remote_id псевдонимы: remote-id string |
Удалённый идентификатор. |
|
remote_id_type псевдонимы: remote-id-type string |
Тип удалённого идентификатора. Варианты:
|
|
type string |
Тип. Варианты:
|
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, для которых переопределяются условия сбоя. |
rc_succeeded list / элементы=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: Options for the DHCP server to assign IP settings to specific MAC addresses.
fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_reservedaddress:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
vlan: <your own value>
dynamic_mapping: <your own value>
state: present # <value in [present, absent]>
fsp_vlan_dynamicmapping_dhcpserver_reservedaddress:
id: 0 # Required variable, integer
# action: <value in [assign, block, reserved]>
# circuit_id: <string>
# circuit_id_type: <value in [hex, string]>
# description: <string>
# ip: <string>
# mac: <string>
# remote_id: <string>
# remote_id_type: <value in [hex, string]>
# type: <value in [mac, option82]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, характерные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=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_dynamicmapping_dhcpserver_reservedaddress_module.html
