fortinet.fortimanager.fmgr_firewall_address – Настройка IPv4-адресов.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

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

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation булево				Варианты: нет ← да	устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_address словарь					установленные параметры верхнего уровня
	allow-routing строка			Варианты: отключить включить	Включить/отключить использование этого адреса в конфигурации статического маршрута.
	associated-interface строка				Сеть интерфейс, связанный с адресом.
	cache-ttl целое число				Определяет минимальное время жизни (TTL) отдельных IP-адресов в кэше FQDN, измеряемое в секундах.
	color целое число				Цвет значка на графическом интерфейсе пользователя.
	comment строка				нет описания
	country строка				IP-адреса, связанные с конкретной страной.
	dynamic_mapping список / элементы=строка				нет описания
		_scope список / элементы=строка			нет описания
			name строка		нет описания
			vdom строка		нет описания
		allow-routing строка		Варианты: отключить включить	нет описания
		associated-interface строка			нет описания
		cache-ttl целое число			нет описания
		color целое число			нет описания
		comment строка			нет описания
		country строка			нет описания
		end-ip строка			нет описания
		end-mac строка			нет описания
		epg-name строка			нет описания
		filter строка			нет описания
		fqdn строка			нет описания
		interface строка			нет описания
		obj-id строка			нет описания
		organization строка			нет описания
		policy-group строка			нет описания
		sdn строка		Варианты: aci aws nsx nuage azure gcp oci openstack	нет описания
		sdn-addr-type строка		Варианты: private public all	нет описания
		sdn-tag строка			нет описания
		start-ip строка			нет описания
		start-mac строка			нет описания
		subnet строка			нет описания
		subnet-name строка			нет описания
		tags строка			нет описания
		tenant строка			нет описания
		type строка		Варианты: ipmask iprange fqdn wildcard geography wildcard-fqdn dynamic	нет описания
		url строка			нет описания
		uuid строка			нет описания
		visibility строка		Варианты: отключить включить	нет описания
		wildcard строка			нет описания
		wildcard-fqdn строка			нет описания
	end-ip строка				Конечный IP-адрес (включительно) в диапазоне для адреса.
	epg-name строка				Имя группы конечных точек.
	filter строка				Фильтр критериев соответствия.
	fqdn строка				Полное доменное имя адреса.
	list список / элементы=строка				нет описания
		ip строка			IP.
	name строка				Имя адреса.
	obj-id строка				Идентификатор объекта для NSX.
	organization строка				Имя домена организации (Синтаксис: organization/domain).
	policy-group строка				Имя группы правил.
	sdn строка			Варианты: aci aws nsx nuage azure gcp oci openstack	SDN.
	sdn-tag строка				Тег SDN.

	start-ip string			Первый IP-адрес (включительно) в диапазоне адреса.
	subnet string			IP-адрес и маска подсети адреса.
	subnet-name string			Имя подсети.
	tagging list / elements=string			Без описания
		category string		Категория тега.
		name string		Имя записи тегов.
		tags string		Без описания
	tenant string			Арендатор.
	type string		Варианты: ipmask iprange fqdn wildcard geography wildcard-fqdn dynamic	Тип адреса.
	uuid string			Универсальный уникальный идентификатор (UUID; автоматически назначается, но может быть изменён вручную).
	visibility string		Варианты: disable enable	Включить/выключить видимость адреса в графическом интерфейсе.
	wildcard string			IP-адрес и маска подсети с подстановкой.
	wildcard-fqdn string			Полное доменное имя с символами подстановки.
rc_failed list / elements=string				Список кодов rc, при которых условия будут нарушены.
rc_succeeded list / elements=string				Список кодов rc, при которых условия будут выполнены.
state string / required			Варианты: present absent	Директива для создания, обновления или удаления объекта.
workspace_locking_adom string				ADOM для блокировки при работе в режиме рабочего пространства FortiManager. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout integer			По умолчанию: 300	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем.

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой rc. Вы также можете переопределить условия для ошибок или успешного завершения с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv4 addresses.
     fmgr_firewall_address:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_address:
           allow-routing: <value in [disable, enable]>
           associated-interface: <value of string>
           cache-ttl: <value of integer>
           color: <value of integer>
           comment: <value of string>
           country: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 allow-routing: <value in [disable, enable]>
                 associated-interface: <value of string>
                 cache-ttl: <value of integer>
                 color: <value of integer>
                 comment: <value of string>
                 country: <value of string>
                 end-ip: <value of string>
                 end-mac: <value of string>
                 epg-name: <value of string>
                 filter: <value of string>
                 fqdn: <value of string>
                 interface: <value of string>
                 obj-id: <value of string>
                 organization: <value of string>
                 policy-group: <value of string>
                 sdn: <value in [aci, aws, nsx, ...]>
                 sdn-addr-type: <value in [private, public, all]>
                 sdn-tag: <value of string>
                 start-ip: <value of string>
                 start-mac: <value of string>
                 subnet: <value of string>
                 subnet-name: <value of string>
                 tags: <value of string>
                 tenant: <value of string>
                 type: <value in [ipmask, iprange, fqdn, ...]>
                 url: <value of string>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
                 wildcard: <value of string>
                 wildcard-fqdn: <value of string>
           end-ip: <value of string>
           epg-name: <value of string>
           filter: <value of string>
           fqdn: <value of string>
           list:
             -
                 ip: <value of string>
           name: <value of string>
           obj-id: <value of string>
           organization: <value of string>
           policy-group: <value of string>
           sdn: <value in [aci, aws, nsx, ...]>
           sdn-tag: <value of string>
           start-ip: <value of string>
           subnet: <value of string>
           subnet-name: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           tenant: <value of string>
           type: <value in [ipmask, iprange, fqdn, ...]>
           uuid: <value of string>
           visibility: <value in [disable, enable]>
           wildcard: <value of string>
           wildcard-fqdn: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Описание ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_address_module.html