Модуль fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_options – Параметры DHCP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver_options.
Впервые в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиента с помощью токена доступа к API forticloud. |
fsp_vlan_dhcpserver_options словарь | Установленные параметры верхнего уровня. |
|
code целое число |
Код. |
|
id целое число / обязательно |
Идентификатор. |
|
ip любой |
(список) IP. |
|
type строка |
Тип. Варианты:
|
|
uci-match строка |
Устаревшее, пожалуйста, переименуйте в uci_match. Включить/выключить идентификатор класса пользователя Варианты:
|
|
uci-string любой |
(список) Устаревшее, пожалуйста, переименуйте в uci_string. Одна или несколько строк UCI в кавычках, разделенных пробелами. |
|
value строка |
Значение. |
|
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 строка | Область (adom), которая будет заблокирована для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 options.
fortinet.fortimanager.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: present # <value in [present, absent]>
fsp_vlan_dhcpserver_options:
code: <integer>
id: <integer>
ip: <list or string>
type: <value in [hex, string, ip, ...]>
value: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
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_dhcpserver_options_module.html
