Модуль fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange — Настройка диапазона DHCP IP-адресов.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange.
Новое в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логический тип | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты:
|
dynamic_mapping строка / обязательно | Параметр (dynamic_mapping) в запрошенном URL. |
enable_log логический тип | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
fsp_vlan_dynamicmapping_dhcpserver_iprange словарь | Настройка верхнего уровня параметров. |
|
end_ip строка |
Устарело, пожалуйста, переименуйте на end_ip. Конечный IP-адрес. |
|
id целое число / обязательно |
Идентификатор. |
|
lease_time целое число |
Устарело, пожалуйста, переименуйте на lease_time. Время аренды в секундах, 0 означает время аренды по умолчанию. |
|
start_ip строка |
Устарело, пожалуйста, переименуйте на start_ip. Начальный IP-адрес. |
|
uci_match строка |
Устарело, пожалуйста, переименуйте на uci_match. Включить/выключить идентификатор класса пользователя Варианты:
|
|
uci_string любой тип |
(список) Устарело, пожалуйста, переименуйте на uci_string. Один или несколько идентификаторов UCI в кавычках, разделенных пробелами. |
|
vci_match строка |
Устарело, пожалуйста, переименуйте на vci_match. Включить/выключить идентификатор класса вендора Варианты:
|
|
vci_string любой тип |
(список) Устарело, пожалуйста, переименуйте на vci_string. Один или несколько идентификаторов VCI в кавычках, разделенных пробелами. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для ошибки. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
vlan строка / обязательно | Параметр (vlan) в запрошенном URL. |
workspace_locking_adom string | ADOM для блокировки в режиме работы с рабочим пространством FortiManager, значение может быть глобальным и другими, включая 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 помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой rc. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: DHCP IP range configuration.
fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange:
# 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>
dynamic_mapping: <your own value>
state: present # <value in [present, absent]>
fsp_vlan_dynamicmapping_dhcpserver_iprange:
end_ip: <string>
id: <integer>
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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange_module.html
