Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

address

string / обязательный

Параметр (address) в запрошенном URL.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Допустимые значения:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Допустимые значения:

  • false ← (по умолчанию)
  • true

firewall_address_dynamicmapping

dictionary

Набор параметров верхнего уровня.

_image_base64

aliases: _image-base64

string

Изображение в формате Base64.

_scope

list / elements=dictionary

Область действия.

name

string

Имя.

vdom

string

VDOM.

agent_id

aliases: agent-id

any

(список) Идентификатор агента телеметрии.

allow_routing

aliases: allow-routing

string

Разрешить маршрутизацию.

Допустимые значения:

  • "disable"
  • "enable"

associated_interface

aliases: associated-interface

string

Связанный интерфейс.

cache_ttl

aliases: cache-ttl

integer

Время жизни кэша.

clearpass_spt

aliases: clearpass-spt

string

SPT ClearPass.

Допустимые значения:

  • "unknown"
  • "healthy"
  • "quarantine"
  • "checkup"
  • "transition"
  • "infected"
  • "transient"

color

integer

Цвет.

comment

any

(словарь или строка) Комментарий.

country

string

Страна.

dirty

string

Адрес, подлежащий удалению.

Допустимые значения:

  • "dirty"
  • "clean"

end_ip

aliases: end-ip

string

Конечный IP-адрес.

end_mac

aliases: end-mac

string

Конечный MAC-адрес.

epg_name

aliases: epg-name

string

Имя EPG.

fabric_object

aliases: fabric-object

string

Настройка глобального объекта Security Fabric.

Допустимые значения:

  • "disable"
  • "enable"

filter

string

Фильтр.

fqdn

string

FQDN.

fsso_group

aliases: fsso-group

any

(список или строка) Группа FSSO.

global_object

aliases: global-object

integer

Глобальный объект.

hw_model

aliases: hw-model

string

Модель оборудования для сопоставления динамического адреса.

hw_vendor

aliases: hw-vendor

string

Производитель оборудования для сопоставления динамического адреса.

interface

string

Интерфейс.

macaddr

any

(список) Несколько диапазонов MAC-адресов.

node_ip_only

aliases: node-ip-only

string

Включить или отключить сбор только адресов узлов в Kubernetes.

Допустимые значения:

  • "disable"
  • "enable"

obj_id

aliases: obj-id

string

Идентификатор объекта.

obj_tag

aliases: obj-tag

string

Тег объекта.

obj_type

aliases: obj-type

string

Тип объекта.

Допустимые значения:

  • "ip"
  • "mac"

organization

string

Организация.

os

string

Операционная система для сопоставления динамического адреса.

passive_fqdn_learning

aliases: passive-fqdn-learning

string

Включить или отключить пассивное обучение FQDN.

Допустимые значения:

  • "disable"
  • "enable"

pattern_end

aliases: pattern-end

integer

Конец шаблона.

pattern_start

aliases: pattern-start

integer

Начало шаблона.

policy_group

aliases: policy-group

string

Группа политик.

route_tag

aliases: route-tag

integer

Адрес с тегом маршрута.

sdn

string

SDN.

Допустимые значения:

  • "aci"
  • "aws"
  • "nsx"
  • "nuage"
  • "azure"
  • "gcp"
  • "oci"
  • "openstack"

sdn_addr_type

aliases: sdn-addr-type

string

Тип адреса SDN.

Допустимые значения:

  • "private"
  • "public"
  • "all"

sdn_tag

aliases: sdn-tag

string

Тег SDN.

sso_attribute_value

aliases: sso-attribute-value

any

(список) Имя

start_ip

aliases: start-ip

string

Начальный IP-адрес.

start_mac

aliases: start-mac

string

Начальный MAC-адрес.

sub_type

aliases: sub-type

string

Подтип.

Допустимые значения:

  • "sdn"
  • "clearpass-spt"
  • "fsso"
  • "ems-tag"
  • "swc-tag"
  • "fortivoice-tag"
  • "fortinac-tag"
  • "fortipolicy-tag"
  • "device-identification"
  • "rsso"
  • "external-resource"
  • "obsolete"
  • "telemetry"

subnet

string

Подсеть.

subnet_name

aliases: subnet-name

string

Имя подсети.

sw_version

aliases: sw-version

string

Версия программного обеспечения для сопоставления динамического адреса.

tag_detection_level

aliases: tag-detection-level

string

Уровень обнаружения тегов динамического объекта адреса.

tag_type

aliases: tag-type

string

Тип тега динамического объекта адреса.

tag_uuid

aliases: tag-uuid

string

Внешний UUID динамического объекта адреса.

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

UUID.

visibility

string

Видимость.

Варианты:

  • "disable"
  • "enable"

wildcard

string

Шаблон.

wildcard_fqdn

псевдонимы: wildcard-fqdn

string

Шаблонное полное доменное имя.

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 или другие ADOM, включая 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 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

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / элементы=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / элементы=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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_address_dynamicmapping_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API