Модуль fortinet.fortimanager.fmgr_system_dhcp_server_iprange — настройка диапазона IP-адресов DHCP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 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_iprange 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: 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 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_iprange_module.html
