Модуль fortinet.fortimanager.fmgr_system_dhcp_server_excluderange — исключение одного или нескольких диапазонов IP-адресов из числа назначаемых клиентам.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_system_dhcp_server_excluderange.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия возникновения ошибки. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
server string / обязательный | Параметр (server) в запрашиваемом URL. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
system_dhcp_server_excluderange dictionary | Набор параметров верхнего уровня. |
|
end_ip псевдонимы: end-ip string |
Конец диапазона IP-адресов. |
|
id integer / обязательный |
Идентификатор. |
|
lease_time псевдонимы: lease-time integer |
Время аренды в секундах; значение 0 означает время аренды по умолчанию. |
|
start_ip псевдонимы: start-ip string |
Начало диапазона IP-адресов. |
|
uci_match псевдонимы: uci-match string |
Включить или отключить идентификатор пользовательского класса. Варианты:
|
|
uci_string псевдонимы: uci-string any |
(список) Одна или несколько строк UCI в кавычках, разделённых пробелами. |
|
vci_match псевдонимы: vci-match string |
Включить или отключить идентификатор класса производителя. Варианты:
|
|
vci_string псевдонимы: vci-string any |
(список) Одна или несколько строк VCI в кавычках, разделённых пробелами. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие ADOM, включая 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.
- Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook
hosts: fortimanagers
gather_facts: false
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 dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary | Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_dhcp_server_excluderange_module.html
