Модуль fortinet.fortimanager.fmgr_firewall_address6_dynamicmapping — настройка адресов IPv6 для межсетевого экрана.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_address6_dynamicmapping.

Добавлено в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
В примерах указаны все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
address6 string / обязательный	Параметр (address6) в запрошенном URL.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_address6_dynamicmapping dictionary	Набор параметров верхнего уровня.
_image_base64 псевдонимы: _image-base64 string	Изображение в формате base64.
_scope list / элементы=dictionary	Область действия.
name string	Имя.
vdom string	VDOM.
cache_ttl псевдонимы: cache-ttl integer	Время жизни кэша.
color integer	Цвет.
comment string	Комментарий.
country string	Страна.
end_ip псевдонимы: end-ip string	Конечный IP-адрес.
end_mac псевдонимы: end-mac string	Конечный MAC-адрес.
epg_name псевдонимы: epg-name string	Имя группы конечных точек.
fabric_object псевдонимы: fabric-object string	Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
filter string	Фильтр критериев соответствия.
fqdn string	Полное доменное имя (FQDN).
global_object псевдонимы: global-object integer	Глобальный объект.
host string	Узел.
host_type псевдонимы: host-type string	Тип узла. Варианты: `"any"` `"specific"`
ip6 string	IPv6-адрес.
macaddr any	(список) Несколько диапазонов MAC-адресов.
obj_id псевдонимы: obj-id string	Идентификатор объекта.
passive_fqdn_learning псевдонимы: passive-fqdn-learning string	Включить/отключить пассивное обучение FQDN. Варианты: `"disable"` `"enable"`
route_tag псевдонимы: route-tag integer	Метка маршрута для адреса.
sdn string	SDN. Варианты: `"nsx"`
sdn_addr_type псевдонимы: sdn-addr-type string	Тип собираемых адресов. Варианты: `"all"` `"private"` `"public"`
sdn_tag псевдонимы: sdn-tag string	Тег SDN.
start_ip псевдонимы: start-ip string	Начальный IP-адрес.
start_mac псевдонимы: start-mac string	Начальный MAC-адрес.
subnet_segment псевдонимы: subnet-segment list / элементы=dictionary	Сегмент подсети.
name string	Имя.
type string	Тип. Варианты: `"any"` `"specific"`
value string	Значение.
tags any	(список или строка) Теги.
template string	Шаблон.
tenant string	Арендатор.
type string	Тип. Варианты: `"ipprefix"` `"iprange"` `"nsx"` `"dynamic"` `"fqdn"` `"template"` `"mac"` `"geography"` `"route-tag"` `"wildcard"`
uuid string	UUID.
visibility string	Видимость. Варианты: `"disable"` `"enable"`
wildcard string	IPv6-адрес и маска подсети с подстановочными знаками.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочей области; значение может быть global или другим, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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 dynamic mappings of IPv6 address
      fortinet.fortimanager.fmgr_firewall_address6_dynamicmapping:
        bypass_validation: false
        adom: ansible
        address6: "ansible-test" # name
        state: present
        firewall_address6_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          cache_ttl: 0
          color: 22
          comment: "ansible-test-comment"
          end_ip: "::100"
          host: "::"
          host_type: any # <value in [any, specific]>
          ip6: "::/128"
          start_ip: "::"
          type: iprange # <value in [ipprefix, iprange, nsx, ...]>
          visibility: enable

- 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 dynamic mappings of IPv6 address
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address6_dynamicmapping"
          params:
            adom: "ansible"
            address6: "ansible-test" # name
            dynamic_mapping: "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–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_dynamicmapping_module.html