модуль fortinet.fortimanager.fmgr_firewall_address6 — настройка адресов брандмауэра IPv6.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_address6.
Добавлено в fortinet.fortimanager 1.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / required | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только при несовпадении схемы модуля со структурой API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
firewall_address6 dictionary | Набор параметров верхнего уровня. |
|
_image_base64 aliases: _image-base64 string |
Изображение в формате base64. |
|
cache_ttl aliases: cache-ttl integer |
Минимальный TTL отдельных IPv6-адресов в кэше FQDN. |
|
color integer |
Целочисленное значение, определяющее цвет значка в графическом интерфейсе |
|
comment string |
Комментарий. |
|
country string |
IPv6-адреса, связанные с определенной страной. |
|
dynamic_mapping list / elements=dictionary |
Динамическое сопоставление. |
|
_image_base64 aliases: _image-base64 string |
Изображение в формате base64. |
|
_scope list / elements=dictionary |
Область действия. |
|
name string |
Имя. |
|
vdom string |
VDOM. |
|
cache_ttl aliases: cache-ttl integer |
TTL кэша. |
|
color integer |
Цвет. |
|
comment string |
Комментарий. |
|
country string |
Страна. |
|
end_ip aliases: end-ip string |
Конечный IP-адрес. |
|
end_mac aliases: end-mac string |
Конечный MAC-адрес. |
|
epg_name aliases: epg-name string |
Имя группы конечных точек. |
|
fabric_object aliases: fabric-object string |
Настройка глобального объекта Security Fabric. Варианты:
|
|
filter string |
Фильтр критериев соответствия. |
|
fqdn string |
FQDN. |
|
global_object aliases: global-object integer |
Глобальный объект. |
|
host string |
Хост. |
|
host_type aliases: host-type string |
Тип хоста. Варианты:
|
|
ip6 string |
IPv6-адрес. |
|
macaddr any |
(список) Несколько диапазонов MAC-адресов. |
|
obj_id aliases: obj-id string |
Идентификатор объекта. |
|
passive_fqdn_learning aliases: passive-fqdn-learning string |
Включить/отключить пассивное обучение FQDN. Варианты:
|
|
route_tag aliases: route-tag integer |
Адрес с тегом маршрута. |
|
sdn string |
SDN. Варианты:
|
|
sdn_addr_type aliases: sdn-addr-type string |
Тип собираемых адресов. Варианты:
|
|
sdn_tag aliases: sdn-tag string |
Тег SDN. |
|
start_ip aliases: start-ip string |
Начальный IP-адрес. |
|
start_mac aliases: start-mac string |
Начальный MAC-адрес. |
|
subnet_segment aliases: subnet-segment list / elements=dictionary |
Сегмент подсети. |
|
name string |
Имя. |
|
type string |
Тип. Варианты:
|
|
value string |
Значение. |
|
tags any |
(список или строка) Теги. |
|
template string |
Шаблон. |
|
tenant string |
Тенант. |
|
type string |
Тип. Варианты:
|
|
uuid string |
UUID. |
|
visibility string |
Видимость. Варианты:
|
|
wildcard string |
IPv6-адрес и маска подсети с подстановочными знаками. |
|
end_ip aliases: end-ip string |
Конечный IP-адрес |
|
end_mac aliases: end-mac string |
Последний MAC-адрес в диапазоне. |
|
epg_name aliases: epg-name string |
Имя группы конечных точек. |
|
fabric_object aliases: fabric-object string |
Настройка глобального объекта Security Fabric. Варианты:
|
|
filter string |
Фильтр критериев соответствия. |
|
fqdn string |
Полное доменное имя. |
|
global_object aliases: global-object integer |
Глобальный объект. |
|
host string |
Адрес хоста. |
|
host_type aliases: host-type string |
Тип хоста. Варианты:
|
|
ip6 string |
Префикс IPv6-адреса |
|
list list / elements=dictionary |
Список. |
|
ip string |
IP-адрес. |
|
net_id aliases: net-id string |
Идентификатор сети. |
|
obj_id aliases: obj-id string |
Идентификатор объекта. |
|
macaddr any |
(список) Несколько диапазонов MAC-адресов. |
|
name string / обязательный |
Имя адреса. |
|
obj_id aliases: obj-id string |
Идентификатор объекта для NSX. |
|
passive_fqdn_learning aliases: passive-fqdn-learning string |
Включить или отключить пассивное изучение FQDN. Варианты:
|
|
profile_list aliases: profile-list list / elements=dictionary |
Список профилей. |
|
profile_id aliases: profile-id integer |
Идентификатор профиля службы NSX. |
|
route_tag aliases: route-tag integer |
Адрес с тегом маршрута. |
|
sdn string |
SDN. Варианты:
|
|
sdn_addr_type aliases: sdn-addr-type string |
Тип собираемых адресов. Варианты:
|
|
sdn_tag aliases: sdn-tag string |
Тег SDN. |
|
start_ip aliases: start-ip string |
Первый IP-адрес |
|
start_mac aliases: start-mac string |
Первый MAC-адрес в диапазоне. |
|
subnet_segment aliases: subnet-segment list / elements=dictionary |
Сегмент подсети. |
|
name string |
Имя. |
|
type string |
Тип сегмента подсети. Варианты:
|
|
value string |
Значение сегмента подсети. |
|
tagging list / elements=dictionary |
Назначение тегов. |
|
category string |
Категория тега. |
|
name string |
Имя записи с тегом. |
|
tags any |
(список) Теги. |
|
tags string |
Имена тегов объектов, применённых к адресу. |
|
template string |
Шаблон IPv6-адреса. |
|
tenant string |
Арендатор. |
|
type string |
Тип объекта IPv6-адреса Варианты:
|
|
uuid string |
Универсальный уникальный идентификатор |
|
visibility string |
Включить или отключить видимость объекта в графическом интерфейсе. Варианты:
|
|
wildcard string |
IPv6-адрес и маска подсети с подстановочными символами. |
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых переопределяются условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, для которых переопределяются условия успешного выполнения. |
revision_note string | Примечание об изменениях, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
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: Configure IPv6 firewall addresses.
fortinet.fortimanager.fmgr_firewall_address6:
bypass_validation: false
adom: ansible
state: present
firewall_address6:
host_type: any # <value in [any, specific]>
ip6: "::/55"
name: "ansible-test"
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 IPv6 addresses
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_address6"
params:
adom: "ansible"
address6: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=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_firewall_address6_module.html