fortinet.fortimanager.fmgr_firewall_address6 модуль — Настройка адресов IPv6 брандмауэра.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_address6 dictionary	Набор параметров верхнего уровня.
_image-base64 string	Устарело, переименуйте в _image_base64. Изображение в формате base64.
cache-ttl integer	Устарело, переименуйте в cache_ttl. Минимальное TTL отдельных IPv6-адресов в кэше FQDN.
color integer	Целочисленное значение для определения цвета значка в графическом интерфейсе.
comment string	Комментарий.
country string	IPv6-адреса, связанные с определенной страной.
dynamic_mapping list / elements=dictionary	Динамическое сопоставление.
_image-base64 string	Устарело, переименуйте в _image_base64. Изображение в формате base64.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
cache-ttl integer	Устарело, переименуйте в cache_ttl. TTL кэша.
color integer	Цвет.
comment string	Комментарий.
country string	Страна.
end-ip string	Устарело, переименуйте в end_ip. Конечный IP.
end-mac string	Устарело, переименуйте в end_mac. Конечный MAC.
epg-name string	Устарело, переименуйте в epg_name. Имя группы конечных точек.
fabric-object string	Устарело, переименуйте в fabric_object. Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
fqdn string	FQDN.

global-object integer	Устарело, переименуйте в global_object. Глобальный объект.
host string	Хост.
host-type string	Устарело, переименуйте в host_type. Тип хоста. Варианты: `"any"` `"specific"`
ip6 string	Ip6.
macaddr any	(список) Несколько диапазонов MAC-адресов.
obj-id string	Устарело, переименуйте в obj_id. Идентификатор объекта.
route-tag integer	Устарело, переименуйте в route_tag. Адрес route-tag.
sdn string	Sdn. Варианты: `"nsx"`
sdn-tag string	Устарело, переименуйте в sdn_tag. Тег SDN.
start-ip string	Устарело, переименуйте в start_ip. Начальный IP-адрес.
start-mac string	Устарело, переименуйте в start_mac. Начальный MAC-адрес.
subnet-segment list / elements=dictionary	Устарело, переименуйте в subnet_segment. Сегмент подсети.
name string	Имя.
type string	Тип. Варианты: `"any"` `"specific"`
value string	Значение.
tags any	(список или str) Теги.
template string	Шаблон.
tenant string	Клиент.
type string	Тип. Варианты: `"ipprefix"` `"iprange"` `"nsx"` `"dynamic"` `"fqdn"` `"template"` `"mac"` `"geography"` `"route-tag"`
uuid string	Uuid.
visibility string	Видимость. Варианты: `"disable"` `"enable"`
end-ip string	Устарело, переименуйте в end_ip. Конечный IP-адрес.
end-mac string	Устарело, переименуйте в end_mac. Последний MAC-адрес в диапазоне.
epg-name string	Устарело, переименуйте в epg_name. Имя группы конечных точек.

fabric-object string	Устарело, переименуйте в fabric_object. Настройка глобального объекта Security Fabric. Choices: `"disable"` `"enable"`
fqdn string	Полностью квалифицированное доменное имя.
global-object integer	Устарело, переименуйте в global_object. Глобальный объект.
host string	IP-адрес хоста.
host-type string	Устарело, переименуйте в host_type. Тип хоста. Choices: `"any"` `"specific"`
ip6 string	Префикс IPv6-адреса
list list / elements=dictionary	Список.
ip string	IP-адрес.
net-id string	Устарело, переименуйте в net_id. Идентификатор сети.
obj-id string	Устарело, переименуйте в obj_id. Идентификатор объекта.
macaddr any	(list) Несколько диапазонов MAC-адресов.
name string / required	Имя адреса.
obj-id string	Устарело, переименуйте в obj_id. Идентификатор объекта для NSX.
profile-list list / elements=dictionary	Устарело, переименуйте в profile_list. Список профилей.
profile-id integer	Устарело, переименуйте в profile_id. Идентификатор профиля сервиса NSX.
route-tag integer	Устарело, переименуйте в route_tag. Адрес с тегом маршрута.
sdn string	SDN. Choices: `"nsx"`
sdn-tag string	Устарело, переименуйте в sdn_tag. Тег SDN.
start-ip string	Устарело, переименуйте в start_ip. Первый IP-адрес
start-mac string	Устарело, переименуйте в start_mac. Первый MAC-адрес в диапазоне.
subnet-segment list / elements=dictionary	Устарело, переименуйте в subnet_segment. Сегмент подсети.
name string	Имя.
type string	Тип сегмента подсети. Choices: `"any"` `"specific"`
value string	Значение сегмента подсети.
tagging list / elements=dictionary	Разметка.

категория строка	Категория тегов.
имя строка	Имя записи тегирования.
метки любой	(список) Метки.
метки строка	Имена тегов объектов, применённых к адресу.
шаблон строка	Шаблон IPv6-адреса.
арендатор строка	Арендатор.
тип строка	Тип объекта IPv6-адреса Варианты: `"ipprefix"` `"iprange"` `"nsx"` `"dynamic"` `"fqdn"` `"template"` `"mac"` `"geography"` `"route-tag"`
уникальный идентификатор строка	Универсальный уникальный идентификатор
видимость строка	Включить/отключить видимость объекта в графическом интерфейсе. Варианты: `"disable"` `"enable"`
токен_доступа_forticloud строка	Авторизовать Ansible-клиента с токеном доступа к API forticloud.
предложенный_метод строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_ошибка список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для ошибки.
rc_успех список / элементы=целое	Список кодов rc, с которыми будут переопределены условия для успеха.
состояние строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
блокировка_рабочего_пространства_adom строка	Adom для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
таймаут_блокировки_рабочего_пространства целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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 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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложно

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_address6_module.html