Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Варианты:

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

enable_log

boolean

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

Варианты:

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

firewall_address

dictionary

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

_image_base64

псевдонимы: _image-base64

string

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

agent_id

псевдонимы: agent-id

any

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

allow_routing

псевдонимы: allow-routing

string

Включить/отключить использование этого адреса в конфигурации статической маршрутизации.

Варианты:

  • "disable"
  • "enable"

associated_interface

псевдонимы: associated-interface

string

Сетевой интерфейс, связанный с адресом.

cache_ttl

псевдонимы: cache-ttl

integer

Задает минимальное значение TTL отдельных IP-адресов в кэше FQDN в секундах.

clearpass_spt

псевдонимы: clearpass-spt

string

SPT

Варианты:

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

color

integer

Цвет значка в графическом интерфейсе.

comment

any

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

country

string

IP-адреса, связанные с определенной страной.

dirty

string

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

Варианты:

  • "dirty"
  • "clean"

dynamic_mapping

list / elements=dictionary

Динамическое сопоставление.

_image_base64

псевдонимы: _image-base64

string

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

_scope

list / elements=dictionary

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

name

string

Имя.

vdom

string

Виртуальный домен.

agent_id

псевдонимы: agent-id

any

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

allow_routing

псевдонимы: allow-routing

string

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

Варианты:

  • "disable"
  • "enable"

associated_interface

псевдонимы: associated-interface

string

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

cache_ttl

псевдонимы: cache-ttl

integer

TTL кэша.

clearpass_spt

псевдонимы: clearpass-spt

string

SPT ClearPass.

Варианты:

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

color

integer

Цвет.

comment

any

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

country

string

Страна.

dirty

string

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

Варианты:

  • "dirty"
  • "clean"

end_ip

псевдонимы: end-ip

string

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

end_mac

псевдонимы: end-mac

string

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

epg_name

псевдонимы: epg-name

string

Имя EPG.

fabric_object

псевдонимы: fabric-object

string

Параметр глобального объекта Security Fabric.

Варианты:

  • "disable"
  • "enable"

filter

string

Фильтр.

fqdn

string

FQDN.

fsso_group

псевдонимы: fsso-group

any

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

global_object

псевдонимы: global-object

integer

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

hw_model

псевдонимы: hw-model

string

Динамический адрес, соответствующий модели оборудования.

hw_vendor

псевдонимы: hw-vendor

string

Динамический адрес, соответствующий производителю оборудования.

interface

string

Интерфейс.

macaddr

any

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

node_ip_only

псевдонимы: node-ip-only

string

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

Варианты:

  • "disable"
  • "enable"

obj_id

псевдонимы: obj-id

string

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

obj_tag

псевдонимы: obj-tag

string

Тег объекта.

obj_type

псевдонимы: obj-type

string

Тип объекта.

Варианты:

  • "ip"
  • "mac"

organization

string

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

os

string

Динамический адрес, соответствующий операционной системе.

passive_fqdn_learning

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

string

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

Варианты:

  • "disable"
  • "enable"

pattern_end

псевдонимы: pattern-end

integer

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

pattern_start

псевдонимы: pattern-start

integer

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

policy_group

псевдонимы: policy-group

string

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

route_tag

псевдонимы: route-tag

integer

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

sdn

string

SDN.

Варианты:

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

sdn_addr_type

псевдонимы: sdn-addr-type

string

Тип адреса SDN.

Варианты:

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

sdn_tag

псевдонимы: sdn-tag

string

Тег SDN.

sso_attribute_value

псевдонимы: sso-attribute-value

any

(список) Имя

start_ip

псевдонимы: 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

aliases: wildcard-fqdn

string

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

end_ip

aliases: end-ip

string

Последний IP-адрес

end_mac

aliases: end-mac

string

Последний MAC-адрес в диапазоне.

epg_name

aliases: epg-name

string

Имя группы конечных точек.

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

Имя интерфейса, IP-адрес которого следует использовать.

list

list / elements=dictionary

Список.

ip

string

IP-адрес.

net_id

aliases: net-id

string

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

obj_id

aliases: obj-id

string

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

macaddr

any

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

name

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

Имя адреса.

node_ip_only

aliases: node-ip-only

string

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

Варианты:

  • "disable"
  • "enable"

obj_id

aliases: obj-id

string

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

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

Конечный номер шаблона для группы FQDN.

pattern_start

aliases: pattern-start

integer

Начальный номер шаблона для группы FQDN.

policy_group

aliases: policy-group

string

Имя группы политик.

profile_list

aliases: profile-list

list / elements=dictionary

Список профилей.

profile_id

aliases: profile-id

integer

Идентификатор профиля службы NSX.

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

Тип собираемых адресов.

Варианты:

  • "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

IP-адрес и маска подсети адреса.

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 динамического объекта адреса.

tagging

list / elements=dictionary

Метки.

category

string

Категория метки.

name

string

Имя записи метки.

tags

any

(список) Метки.

tags

string

Имена меток объектов, применённых к адресу.

tenant

string

Арендатор.

type

string

Тип адреса.

Варианты:

  • "ipmask"
  • "iprange"
  • "fqdn"
  • "wildcard"
  • "geography"
  • "url"
  • "wildcard-fqdn"
  • "nsx"
  • "aws"
  • "dynamic"
  • "interface-subnet"
  • "mac"
  • "fqdn-group"
  • "route-tag"

uuid

string

Универсальный уникальный идентификатор

visibility

string

Включение/отключение видимости адреса в графическом интерфейсе.

Варианты:

  • "disable"
  • "enable"

wildcard

string

IP-адрес и маска подсети с подстановочными символами.

wildcard_fqdn

aliases: wildcard-fqdn

string

Полное доменное имя с подстановочными символами.

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, для которых условия успешного выполнения будут переопределены.

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 IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        bypass_validation: false
        adom: root
        state: present
        firewall_address:
          name: "ansible-test1"
          allow_routing: disable
          associated_interface: any

- 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 IPv4 addresses
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_address"
          params:
            adom: "ansible"
            address: "your_value"

- 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 IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        bypass_validation: false
        adom: root
        state: present
        firewall_address:
          allow_routing: disable
          associated_interface: any
          name: "address-orignal"
          # visibility: enable
    - name: Rename the firewall addressobject
      fortinet.fortimanager.fmgr_rename:
        rename:
          selector: "firewall_address"
          self:
            adom: "root"
            address: "address-orignal"
          target:
            name: "address-new"
    - name: Delete renamed object
      fortinet.fortimanager.fmgr_firewall_address:
        adom: "root"
        state: absent
        firewall_address:
          name: "address-new"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

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

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

request_url

string

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

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

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

response_code

integer

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

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Описание ответа API.

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

Пример: "OK."

system_information

dictionary

Сведения о целевой системе.

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

rc

integer

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

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

Пример: 0

version_check_warning

list / elements=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_module.html

Spec-Zone.ru

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