fortinet.fortimanager.fmgr_system_dhcp_server_iprange модуль — Настройка диапазона DHCP IP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_dhcp_server_iprange.
Добавлена в 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_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 в кавычках, разделенных пробелами. |
workspace_locking_adom строка | Область (adom) для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой. |
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 IP range configuration.
fortinet.fortimanager.fmgr_system_dhcp_server_iprange:
bypass_validation: false
adom: ansible
server: 1 # id
state: present
system_dhcp_server_iprange:
end-ip: 222.222.222.35
id: 2
start-ip: 222.222.222.23
- 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 IP range of DHCP server
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_dhcp_server_iprange"
params:
adom: "ansible"
server: "1" # id
ip-range: "your_value"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_iprange_module.html
