fortinet.fortimanager.fmgr_firewall_multicastaddress модуль — Настройка адресов мультикаста.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_multicastaddress.
Новое в fortinet.fortimanager 1.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_multicastaddress словарь | Установленные параметры верхнего уровня. |
|
associated_interface строка |
Устарело, пожалуйста, переименуйте на associated_interface. Интерфейс, связанный с объектом адреса. |
|
color целое число |
Целочисленное значение для определения цвета значка в интерфейсе |
|
comment строка |
Комментарий. |
|
end_ip строка |
Конечный IPv4 адрес |
|
name строка / обязательно |
Имя многоадресного адреса. |
|
start_ip строка |
Первый IPv4 адрес |
|
subnet строка |
Адрес широковещательной рассылки и подсеть. |
|
tagging список / элементы=словарь |
Разметка. |
|
category строка |
Категория тегов. |
|
name строка |
Имя записи тегов. |
|
tags любой |
(список) Теги. |
|
tags строка |
Имена тегов объектов |
|
type строка |
Тип объекта адреса Варианты:
|
|
visibility строка |
Включить/выключить видимость многоадресного адреса в интерфейсе. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к forticloud API. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, с которыми будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое число | Список rc-кодов, с которыми будут переопределены условия для успеха. |
состояние строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
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: Configure multicast addresses.
fortinet.fortimanager.fmgr_firewall_multicastaddress:
bypass_validation: false
adom: ansible
state: present
firewall_multicastaddress:
color: 0
comment: "ansible-comment"
name: "ansible-test"
subnet: "222.222.221.0/24"
type: broadcastmask # <value in [multicastrange, broadcastmask]>
visibility: disable
- 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 IPv4 multicast addresses
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_multicastaddress"
params:
adom: "ansible"
multicast-address: "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_firewall_multicastaddress_module.html
