Модуль fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress – Параметры для DHCP-сервера для назначения IP-настроек определённым MAC-адресам.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress.
Новая функция в 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_reservedaddress словарь | Настроенные параметры верхнего уровня. |
|
action строка |
Параметры DHCP-сервера для настройки клиента с резервированным MAC-адресом. Варианты:
|
|
circuit_id строка |
Устарело, используйте circuit_id. ID канала клиента, которому будет назначен резервированный IP-адрес. |
|
circuit_id_type строка |
Устарело, используйте circuit_id_type. Тип DHCP-опции. Варианты:
|
|
description строка |
Описание. |
|
id целое / обязательно |
Идентификатор. |
|
ip строка |
IP-адрес, который будет зарезервирован для MAC-адреса. |
|
mac строка |
MAC-адрес клиента, которому будет назначен резервированный IP-адрес. |
|
remote_id строка |
Устарело, используйте remote_id. ID удаленного клиента, которому будет назначен резервированный IP-адрес. |
|
remote_id_type строка |
Устарело, используйте remote_id_type. Тип DHCP-опции. Варианты:
|
|
type string |
Тип DHCP резервированного адреса. Выбор:
|
workspace_locking_adom string | ADOM для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая 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 помогают в этой работе.
- Для создания или обновления объекта используйте директиву 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: Options for the DHCP server to assign IP settings to specific MAC addresses.
fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress:
bypass_validation: false
adom: ansible
server: 1 # id
state: present
system_dhcp_server_reservedaddress:
action: assign # <value in [assign, block, reserved]>
description: ansible-description
id: 1
ip: 222.222.222.1
- 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 reserved addresses of DHCP server
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_dhcp_server_reservedaddress"
params:
adom: "ansible"
server: "1" # id
reserved-address: "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_reservedaddress_module.html
