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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_address словарь	Параметры верхнего уровня.
_image-base64 строка	Устарело, пожалуйста, переименуйте на _image_base64. Изображение base64.
allow-routing строка	Устарело, пожалуйста, переименуйте на allow_routing. Включить/выключить использование этого адреса в конфигурации статического маршрута. Варианты: `"disable"` `"enable"`
associated-interface строка	Устарело, пожалуйста, переименуйте на associated_interface. Сеть интерфейса, связанного с адресом.
cache-ttl целое число	Устарело, пожалуйста, переименуйте на cache_ttl. Определяет минимальное время жизни (TTL) отдельных IP-адресов в кэше FQDN, измеряемое в сек…
clearpass-spt строка	Устарело, пожалуйста, переименуйте на clearpass_spt. SPT Варианты: `"unknown"` `"healthy"` `"quarantine"` `"checkup"` `"transition"` `"infected"` `"transient"`
color целое число	Цвет значка на графическом интерфейсе.
comment любой тип	(словарь или строка) Комментарий.
country строка	IP-адреса, связанные с определенной страной.
dirty строка	Подлежащий удалению адрес. Варианты: `"dirty"` `"clean"`
dynamic_mapping список / элементы=словарь	Динамическое отображение.
_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 string	Устарело, переименуйте в clearpass_spt. Clearpass spt. Варианты: `"unknown"` `"healthy"` `"quarantine"` `"checkup"` `"transition"` `"infected"` `"transient"`
color integer	Цвет.
comment any	(dict or str) Комментарий.
country string	Страна.
dirty string	Адрес, подлежащий удалению. Варианты: `"dirty"` `"clean"`
end-ip string	Устарело, переименуйте в end_ip. Конечный IP.
end-mac string	Устарело, переименуйте в end_mac. Конечный MAC.
epg-name string	Устарело, переименуйте в epg_name. Имя EPG.
fabric-object string	Устарело, переименуйте в fabric_object. Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
filter string	Фильтр.
fqdn string	FQDN.
fsso-group any	(list or str) Устарело, переименуйте в fsso_group. Группа FSSO.
global-object integer	Устарело, переименуйте в global_object. Глобальный объект.
hw-model string	Устарело, переименуйте в hw_model. Модель оборудования для динамического сопоставления адресов.
hw-vendor string	Устарело, переименуйте в hw_vendor. Производитель оборудования для динамического сопоставления адресов.
interface string	Интерфейс.
macaddr any	(list) Несколько диапазонов MAC-адресов.
node-ip-only string	Устарело, переименуйте в node_ip_only. Включить/отключить сбор только адресов узлов в Kubernetes. Варианты: `"disable"` `"enable"`
obj-id string	Устарело, переименуйте в obj_id. 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	UUID.
visibility string	Видимость. Варианты: `"disable"` `"enable"`
wildcard string	Подстановочный знак.

wildcard-fqdn string	Устарело, переименуйте в wildcard_fqdn. Wildcard fqdn.
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"`
filter string	Фильтр критериев соответствия.
fqdn string	Полностью квалифицированное доменное имя.
fsso-group any	(список или строка) Устарело, переименуйте в fsso_group. Группа FSSO
global-object integer	Устарело, переименуйте в global_object. Глобальный объект.
hw-model string	Устарело, переименуйте в hw_model. Модель оборудования для динамического сопоставления адресов.
hw-vendor string	Устарело, переименуйте в hw_vendor. Производитель оборудования для динамического сопоставления адресов.
interface string	Имя интерфейса, IP-адрес которого будет использоваться.
list list / elements=dictionary	Список.
ip string	IP-адрес.
net-id string	Устарело, переименуйте в net_id. Идентификатор сети.
obj-id string	Устарело, переименуйте в obj_id. Идентификатор объекта.
macaddr any	(список) Несколько диапазонов MAC-адресов.
name string / required	Имя адреса.
node-ip-only string	Устарело, переименуйте в node_ip_only. Включить/выключить сбор только адресов узлов в Kubernetes. Варианты: `"disable"` `"enable"`
obj-id string	Устарело, переименуйте в obj_id. Идентификатор объекта для NSX.
obj-tag string	Устарело, переименуйте в obj_tag. Тег объекта динамического адреса.
obj-type string	Устарело, переименуйте в obj_type. Тип объекта. Варианты: `"ip"` `"mac"`
organization string	Доменное имя организации
os string	Операционная система для динамического сопоставления адресов.
policy-group string	Устарело, переименуйте в policy_group. Имя группы политик.

profile-list list / elements=dictionary	Устарело, переименуйте в profile_list. Список профилей.
profile-id integer	Устарело, переименуйте в profile_id. ID профиля сервиса NSX.
route-tag integer	Устарело, переименуйте в route_tag. Адрес route-tag.
sdn string	SDN. Choices: `"aci"` `"aws"` `"nsx"` `"nuage"` `"azure"` `"gcp"` `"oci"` `"openstack"`
sdn-addr-type string	Устарело, переименуйте в sdn_addr_type. Тип адресов для сбора. Choices: `"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. Подтип адреса. Choices: `"sdn"` `"clearpass-spt"` `"fsso"` `"ems-tag"` `"swc-tag"` `"fortivoice-tag"` `"fortinac-tag"` `"fortipolicy-tag"` `"device-identification"`
subnet string	IP-адрес и маска подсети адреса.
subnet-name string	Устарело, переименуйте в subnet_name. Имя подсети.
sw-version string	Устарело, переименуйте в sw_version. Версия программного обеспечения для сопоставления динамических адресов.
tag-detection-level string	Устарело, переименуйте в tag_detection_level. Уровень обнаружения тегов для динамического объекта адреса.
tag-type string	Устарело, переименуйте в tag_type. Тип тега для динамического объекта адреса.
tagging list / elements=dictionary	Разметка.
category string	Категория тега.
name string	Имя записи разметки.
tags any	(list) Теги.
tags string	Имена тегов объектов, примененных к адресу.
tenant string	Арендатор.
type string	Тип адреса. Choices: `"ipmask"` `"iprange"` `"fqdn"` `"wildcard"` `"geography"` `"url"` `"wildcard-fqdn"` `"nsx"` `"aws"` `"dynamic"` `"interface-subnet"` `"mac"` `"fqdn-group"` `"route-tag"`
uuid string	Универсальный уникальный идентификатор

видимость строка	Включить/выключить видимость адреса в графическом интерфейсе. Варианты: `"disable"` `"enable"`
маска_подсети строка	IP-адрес и маска подсети с подстановкой.
маска_подсети-FQDN строка	Устарело, пожалуйста, переименуйте на wildcard_fqdn. Полное доменное имя с подстановками.
токен_доступа_forticloud строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
предложенный_метод строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_ошибка список / элементы=целое	Список rc-кодов, при которых условия будут нарушены.
rc_успешно список / элементы=целое	Список rc-кодов, при которых условия будут выполнены.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
блокировка_рабочей_области_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая корень.
таймаут_блокировки_рабочей_области целое	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов все еще доступны, но вы будете получать предупреждения о устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву состояния present.
Для удаления объекта используйте директиву состояния 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 IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "ansible-test1"
          visibility: disable

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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Create IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        adom: root
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "fooaddress"
          visibility: disable
      register: info
      failed_when: info.rc != 0
    - name: Create IPv4 addresses.
      fortinet.fortimanager.fmgr_firewall_address:
        adom: root
        state: present
        firewall_address:
          allow-routing: disable
          associated-interface: any
          name: "fooaddress"
          visibility: disable
      register: info
      failed_when: info.message != 'Object update skipped!'
    - name: Delete created address
      fortinet.fortimanager.fmgr_firewall_address:
        adom: root
        state: absent
        firewall_address:
          name: "fooaddress"

Значения возврата

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

Ключ	Описание
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_address_module.html