fortinet.fortimanager.fmgr_system_dhcp_server_excluderange модуль — Исключить один или несколько диапазонов IP-адресов из назначения клиентам.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_system_dhcp_server_excluderange.
Добавлена в 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_excluderange словарь | Набор параметров верхнего уровня. |
|
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: Exclude one or more ranges of IP addresses from being assigned to clients.
fortinet.fortimanager.fmgr_system_dhcp_server_excluderange:
bypass_validation: false
adom: ansible
server: 1 # id
state: present
system_dhcp_server_excluderange:
end-ip: 222.222.222.7
id: 1
start-ip: 222.222.222.6
- 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 exclude ranges of DHCP server
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_dhcp_server_excluderange"
params:
adom: "ansible"
server: "1" # id
exclude-range: "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_excluderange_module.html
