fortinet.fortimanager.fmgr_firewall_address_dynamicmapping модуль — Настройка адресов IPv4.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_address_dynamicmapping.

Впервые появился в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
address строка / обязательно	Параметр (адрес) в запрошенном URL.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Выбор: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить протоколирование задачи. Выбор: `false` ← (по умолчанию) `true`
firewall_address_dynamicmapping словарь	Настройка параметров верхнего уровня.
_image-base64 строка	Устарело, пожалуйста, переименуйте на _image_base64. Изображение base64.
_scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
allow_routing строка	Устарело, пожалуйста, переименуйте на allow_routing. Разрешить маршрутизацию. Выбор: `"disable"` `"enable"`
associated_interface строка	Устарело, пожалуйста, переименуйте на associated_interface. Связанный интерфейс.
cache_ttl целое число	Устарело, пожалуйста, переименуйте на cache_ttl. Время хранения кэша.
clearpass_spt строка	Устарело, пожалуйста, переименуйте на clearpass_spt. Clearpass spt. Выбор: `"unknown"` `"healthy"` `"quarantine"` `"checkup"` `"transition"` `"infected"` `"transient"`
color целое число	Цвет.
comment любой	(словарь или строка) Комментарий.
country строка	Страна.
dirty строка	Удаляемый адрес. Выбор: `"dirty"` `"clean"`
end_ip строка	Устарело, пожалуйста, переименуйте на end_ip. Конечный IP.
end_mac строка	Устарело, пожалуйста, переименуйте на end_mac. Конечный MAC.
epg_name строка	Устарело, пожалуйста, переименуйте на epg_name. Имя EPG.
fabric_object строка	Устарело, пожалуйста, переименуйте на fabric_object. Настройка глобального объекта Security Fabric. Выбор: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

filter string	Фильтр.
fqdn string	Fqdn.
fsso-group any	(список или строка) Устарело, пожалуйста, переименуйте на fsso_group. Группа fsso.
global-object integer	Устарело, пожалуйста, переименуйте на global_object. Глобальный объект.
hw-model string	Устарело, пожалуйста, переименуйте на hw_model. Модель оборудования для динамического сопоставления адресов.
hw-vendor string	Устарело, пожалуйста, переименуйте на hw_vendor. Производитель оборудования для динамического сопоставления адресов.
interface string	Интерфейс.
macaddr any	(список) Несколько диапазонов MAC-адресов.
node-ip-only string	Устарело, пожалуйста, переименуйте на node_ip_only. Включить/выключить сбор только адресов узлов в Kubernetes. Варианты: `"disable"` `"enable"`
obj-id string	Устарело, пожалуйста, переименуйте на obj_id. Идентификатор объекта.
obj-tag string	Устарело, пожалуйста, переименуйте на obj_tag. Тег объекта.
obj-type string	Устарело, пожалуйста, переименуйте на obj_type. Тип объекта. Варианты: `"ip"` `"mac"`
organization string	Организация.
os string	Операционная система для динамического сопоставления адресов.
pattern-end integer	Устарело, пожалуйста, переименуйте на pattern_end. Конец шаблона.
pattern-start integer	Устарело, пожалуйста, переименуйте на pattern_start. Начало шаблона.
policy-group string	Устарело, пожалуйста, переименуйте на policy_group. Группа правил.
route-tag integer	Устарело, пожалуйста, переименуйте на route_tag. Тег маршрута адреса.
sdn string	Sdn. Варианты: `"aci"` `"aws"` `"nsx"` `"nuage"` `"azure"` `"gcp"` `"oci"` `"openstack"`
sdn-addr-type string	Устарело, пожалуйста, переименуйте на sdn_addr_type. Тип адреса sdn. Варианты: `"private"` `"public"` `"all"`
sdn-tag string	Устарело, пожалуйста, переименуйте на sdn_tag. Тег sdn.
start-ip string	Устарело, пожалуйста, переименуйте на start_ip. Начальный IP-адрес.
start-mac string	Устарело, пожалуйста, переименуйте на start_mac. Начальный MAC-адрес.

sub-type string	Устаревшее, пожалуйста, переименуйте в sub_type. Подтип. Варианты: `"sdn"` `"clearpass-spt"` `"fsso"` `"ems-tag"` `"swc-tag"` `"fortivoice-tag"` `"fortinac-tag"` `"fortipolicy-tag"` `"device-identification"`
subnet string	Подсеть.
subnet-name string	Устаревшее, пожалуйста, переименуйте в subnet_name. Имя подсети.
sw-version string	Устаревшее, пожалуйста, переименуйте в sw_version. Версия ПО для динамического сопоставления адресов.
tag-detection-level string	Устаревшее, пожалуйста, переименуйте в tag_detection_level. Уровень обнаружения тегов для динамического объекта адреса.
tag-type string	Устаревшее, пожалуйста, переименуйте в tag_type. Тип тега динамического объекта адреса.
tags any	(список или строка) Теги.
tenant string	Предприятие.
type string	Тип. Варианты: `"ipmask"` `"iprange"` `"fqdn"` `"wildcard"` `"geography"` `"url"` `"wildcard-fqdn"` `"nsx"` `"aws"` `"dynamic"` `"interface-subnet"` `"mac"` `"fqdn-group"` `"route-tag"`
url string	URL.
uuid string	Уникальный идентификатор.
visibility string	Видимость. Варианты: `"disable"` `"enable"`
wildcard string	Подстановка.
wildcard-fqdn string	Устаревшее, пожалуйста, переименуйте в wildcard_fqdn. Подстановка FQDN.
forticloud_access_token string	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, при которых будет происходить отказ.
rc_succeeded list / elements=integer	Список кодов rc, при которых будет происходить успешное выполнение.
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 помогают в этом.
Для создания или обновления объекта используйте директиву 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 IPv4 address
      fortinet.fortimanager.fmgr_firewall_address_dynamicmapping:
        bypass_validation: true
        adom: ansible
        address: "ansible-test1" # name
        state: present
        firewall_address_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          allow-routing: disable # <value in [disable, enable]>
          cache-ttl: 0
          color: 1
          comment: "ansible-comment"
          subnet: "222.222.222.101/32"
          subnet-name: "ansible-test"
          type: ipmask # <value in [ipmask, iprange, fqdn, ...]>
          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 IPv4 address
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address_dynamicmapping"
          params:
            adom: "ansible"
            address: "ansible-test1" # 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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_address_dynamicmapping_module.html