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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required	Параметр (address6) в запрошенном URL.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_address6_dynamicmapping dictionary	Набор параметров верхнего уровня.
_image-base64 string	Устарело, переименуйте в _image_base64. Изображение в формате base64.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
cache-ttl integer	Устарело, переименуйте в cache_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	IPv6.

macaddr any	(список) Несколько диапазонов MAC-адресов.
obj-id строка	Устарело, пожалуйста, переименуйте на obj_id. Идентификатор объекта.
route-tag целое число	Устарело, пожалуйста, переименуйте на route_tag. Адрес тега маршрута.
sdn строка	Sdn. Варианты: `"nsx"`
sdn-tag строка	Устарело, пожалуйста, переименуйте на sdn_tag. Тег SDN.
start-ip строка	Устарело, пожалуйста, переименуйте на start_ip. Стартовый IP.
start-mac строка	Устарело, пожалуйста, переименуйте на start_mac. Стартовый MAC.
subnet-segment список / элементы=словарь	Устарело, пожалуйста, переименуйте на subnet_segment. Сегмент подсети.
name строка	Имя.
type строка	Тип. Варианты: `"any"` `"specific"`
value строка	Значение.
tags any	(список или строка) Теги.
template строка	Шаблон.
tenant строка	Абонент.
type строка	Тип. Варианты: `"ipprefix"` `"iprange"` `"nsx"` `"dynamic"` `"fqdn"` `"template"` `"mac"` `"geography"` `"route-tag"`
uuid строка	Uuid.
visibility строка	Видимость. Варианты: `"disable"` `"enable"`
forticloud_access_token строка	Авторизуйте клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`

workspace_locking_adom string	ADOM для блокировки в режиме работы FortiManager в рабочем пространстве, значение может быть глобальным и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву 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 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–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_dynamicmapping_module.html