fortinet.fortimanager.fmgr_firewall_address6 – Настройка адресов IPv6 брандмауэра.

Примечание

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

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

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

Добавлен в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation булево				Варианты: нет ← да	устанавливается в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_address6 словарь					параметры верхнего уровня
	cache-ttl целое число				Минимальное значение TTL отдельных IPv6-адресов в кэше FQDN.
	color целое число				Целочисленное значение для определения цвета значка в графическом интерфейсе (диапазон от 1 до 32, по умолчанию = 0, что устанавливает значение в 1).
	comment строка				Комментарий.
	dynamic_mapping список / элементы=строка				нет описания
		_scope список / элементы=строка			нет описания
			name строка		нет описания
			vdom строка		нет описания
		cache-ttl целое число			нет описания
		color целое число			нет описания
		comment строка			нет описания
		end-ip строка			нет описания
		fqdn строка			нет описания
		host строка			нет описания
		host-type строка		Варианты: любой конкретный	нет описания
		ip6 строка			нет описания
		obj-id строка			нет описания
		sdn строка		Варианты: nsx	нет описания
		start-ip строка			нет описания
		tags строка			нет описания
		template строка			нет описания
		type строка		Варианты: ipprefix iprange dynamic fqdn template	нет описания
		uuid строка			нет описания
		visibility строка		Варианты: выключить включить	нет описания
	end-ip строка				Конечный IP-адрес (включительно) в диапазоне адреса (формат: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
	fqdn строка				Полное доменное имя.
	host строка				Адрес хоста.
	host-type строка			Варианты: любой конкретный	Тип хоста.
	ip6 строка				Префикс IPv6-адреса (формат: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx).
	list список / элементы=строка				нет описания
		ip строка			IP.
	name строка				Имя адреса.
	obj-id строка				Идентификатор объекта для NSX.
	sdn строка			Варианты: nsx	SDN.
	start-ip строка				Первый IP-адрес (включительно) в диапазоне адреса (формат: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).
	subnet-segment список / элементы=строка				нет описания
		name строка			Имя.
		type строка		Варианты: любой конкретный	Тип сегмента подсети.
		value строка			Значение сегмента подсети.
	tagging список / элементы=строка				нет описания
		category строка			Категория тега.
		name строка			Имя записи тегирования.
		tags строка			нет описания
	template строка				Шаблон IPv6-адреса.
	type строка			Варианты: ipprefix iprange dynamic fqdn template	Тип объекта IPv6-адреса (по умолчанию = ipprefix).
	uuid строка				Универсальный уникальный идентификатор (UUID; автоматически назначается, но может быть изменён вручную).
	visibility строка			Варианты: выключить включить	Включить/выключить видимость объекта в графическом интерфейсе.
rc_failed список / элементы=строка					список кодов rc, с которыми будут переопределены условия для отказа
rc_succeeded список / элементы=строка					список кодов rc, с которыми будут переопределены условия для успеха
state строка / обязательно				Варианты: present absent	директива для создания, обновления или удаления объекта
workspace_locking_adom строка					adom для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой
workspace_locking_timeout целое число				Значение по умолчанию: 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 IPv6 firewall addresses.
     fmgr_firewall_address6:
        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_address6:
           cache-ttl: <value of integer>
           color: <value of integer>
           comment: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 cache-ttl: <value of integer>
                 color: <value of integer>
                 comment: <value of string>
                 end-ip: <value of string>
                 fqdn: <value of string>
                 host: <value of string>
                 host-type: <value in [any, specific]>
                 ip6: <value of string>
                 obj-id: <value of string>
                 sdn: <value in [nsx]>
                 start-ip: <value of string>
                 tags: <value of string>
                 template: <value of string>
                 type: <value in [ipprefix, iprange, dynamic, ...]>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
           end-ip: <value of string>
           fqdn: <value of string>
           host: <value of string>
           host-type: <value in [any, specific]>
           ip6: <value of string>
           list:
             -
                 ip: <value of string>
           name: <value of string>
           obj-id: <value of string>
           sdn: <value in [nsx]>
           start-ip: <value of string>
           subnet-segment:
             -
                 name: <value of string>
                 type: <value in [any, specific]>
                 value: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           template: <value of string>
           type: <value in [ipprefix, iprange, dynamic, ...]>
           uuid: <value of string>
           visibility: <value in [disable, enable]>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа 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_address6_module.html