Модуль fortinet.fortimanager.fmgr_system_dhcp_server_options — DHCP опции.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_dhcp_server_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. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, по которым будет переопределяться условие неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, по которым будет переопределяться условие успеха. |
server строка / обязательно | Параметр (server) в запрошенном URL. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
system_dhcp_server_options словарь | Установленные параметры верхнего уровня. |
|
code целое число |
Код DHCP-опции. |
|
id целое число / обязательно |
ИД. |
|
ip любой |
(список) IP-адреса DHCP-опции. |
|
type строка |
Тип DHCP-опции. Варианты:
|
|
uci-match строка |
Устаревшее, пожалуйста, переименуйте на uci_match. Включить/выключить идентификатор пользовательского класса. Варианты:
|
|
uci-string любой |
(список) Устаревшее, пожалуйста, переименуйте на uci_string. Одна или несколько строковых значений UCI в кавычках, разделенных пробелами. |
|
value строка |
Значение DHCP-опции. |
|
vci-match строка |
Устаревшее, пожалуйста, переименуйте на vci_match. Включить/выключить идентификатор класса вендора. Варианты:
|
|
vci-string любой |
(список) Устаревшее, пожалуйста, переименуйте на vci_string. Одна или несколько строковых значений VCI в кавычках, разделенных пробелами. |
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
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_system_dhcp_server_options:
bypass_validation: false
adom: ansible
server: 1 # id
state: present
system_dhcp_server_options:
id: 1
ip: 222.222.222.1
type: hex # <value in [hex, string, ip, ...]>
value: ansible
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the DHCP options of DHCP server
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_dhcp_server_options"
params:
adom: "ansible"
server: "1" # id
options: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_system_dhcp_server_options_module.html
