fortinet.fortimanager.fmgr_firewall_addrgrp – Настройка групп адресов IPv4.

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_addrgrp.

В версии 2.10: из fortinet.fortimanager

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

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation булево				Варианты: нет ← да	устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_addrgrp словарь					установленные параметры верхнего уровня
	allow-routing строка			Варианты: выключить включить	Включить/выключить использование этой группы в конфигурации статических маршрутов.
	color целое число				Цвет значка на графическом интерфейсе.
	comment строка				нет описания
	dynamic_mapping список / элементы=строка				нет описания
		_scope список / элементы=строка			нет описания
			name строка		нет описания
			vdom строка		нет описания
		allow-routing строка		Варианты: выключить включить	нет описания
		color целое число			нет описания
		comment строка			нет описания
		exclude строка		Варианты: выключить включить	нет описания
		exclude-member строка			нет описания
		member список / элементы=строка			нет описания
		tags строка			нет описания
		uuid строка			Универсальный уникальный идентификатор (UUID; автоматически назначается, но может быть вручную сброшен).
		visibility строка		Варианты: выключить включить	Включить/выключить видимость адреса в графическом интерфейсе.
	member список / элементы=строка				нет описания
	name строка				Имя группы адресов.
	tagging список / элементы=строка				нет описания
		category строка			Категория тега.
		name строка			Имя записи тегирования.
		tags строка			нет описания
	uuid строка				Уникальный идентификатор (UUID; автоматически назначается, но может быть вручную сброшен).
	visibility строка			Варианты: выключить включить	нет описания
rc_failed список / элементы=строка					список кодов rc, при которых будут переопределены условия ошибки
rc_succeeded список / элементы=строка					список кодов rc, при которых будут переопределены условия успеха
state строка / обязательно				Варианты: present absent	инструкция для создания, обновления или удаления объекта
workspace_locking_adom строка					adom для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая root
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 IPv4 address groups.
     fmgr_firewall_addrgrp:
        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_addrgrp:
           allow-routing: <value in [disable, enable]>
           color: <value of integer>
           comment: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 allow-routing: <value in [disable, enable]>
                 color: <value of integer>
                 comment: <value of string>
                 exclude: <value in [disable, enable]>
                 exclude-member: <value of string>
                 member: <value of list>
                 tags: <value of string>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
           member: <value of list>
           name: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           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_addrgrp_module.html