fortinet.fortios.fortios_system_replacemsg_group – Настройка групп замещающих сообщений в FortiOS и FortiGate Fortinet.

Примечание

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

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

Для использования в playbook укажите: fortinet.fortios.fortios_system_replacemsg_group.

Новое в версии 2.9: of fortinet.fortios

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

Обзор

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные параметры и категорию replacemsg_group. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ansible>=2.9.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
access_token строка				Аутентификация на основе токена. Сгенерировано из GUI Fortigate.
state строка / обязательно			Варианты: present absent	Указывает, нужно ли создать или удалить объект.
system_replacemsg_group словарь				Настройка групп сообщений замены.
	admin список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	alertmail список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	auth список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	comment строка			Комментарий.
	custom_message список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	device_detection_portal список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	ec список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	fortiguard_wf список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	ftp список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	group_type строка		Варианты: default utm auth ec	Тип группы.
	http список / элементы=строка			Записи таблицы сообщений замены.
		buffer строка		Строка сообщения.
		format строка	Варианты: none text html wml	Флаг формата.
		header строка	Варианты: none http 8bit	Флаг заголовка.
		msg_type строка		Тип сообщения.
	icap список / элементы=строка			Записи таблицы сообщений замены.

		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	mail list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	nac_quar list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	name string / required			Имя группы.
	nntp list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	spam list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	sslvpn list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	traffic_quota list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	utm list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
	webproxy list / elements=string			Записи таблицы сообщений для замены.
		buffer string		Строка сообщения.
		format string	Варианты: none text html wml	Флаг форматирования.
		header string	Варианты: none http 8bit	Флаг заголовка.
		msg_type string		Тип сообщения.
vdom string			По умолчанию: "root"	Виртуальный домен из ранее определённых. VDOM — это виртуальная инстанция FortiGate, которая может настраиваться и использоваться как отдельный блок.

Примечания

Примечание

Модуль fortiosapi устарел, httpapi предпочтительнее для запуска playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure replacement message groups.
    fortios_system_replacemsg_group:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_group:
        admin:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        alertmail:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        auth:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        comment: "Comment."
        custom_message:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        device_detection_portal:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        ec:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        fortiguard_wf:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        ftp:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        group_type: "default"
        http:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        icap:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        mail:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        nac_quar:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        name: "default_name_65"
        nntp:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        spam:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        sslvpn:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        traffic_quota:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        utm:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"
        webproxy:
         -
            buffer: "<your_own_value>"
            format: "none"
            header: "none"
            msg_type: "<your_own_value>"

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

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

Ключ	Возвращаемое значение	Описание
build строка	всегда	Номер сборки изображения FortiGate Пример: 1547
http_method строка	всегда	Последний метод, использованный для предоставления содержимого в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, полученный от FortiGate при последней операции Пример: 200
mkey строка	успех	Главный ключ (id), используемый в последнем вызове FortiGate Пример: id
name строка	всегда	Имя таблицы, используемой для выполнения запроса Пример: urlfilter
path строка	всегда	Путь таблицы, используемой для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Используемый виртуальный домен Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 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/fortios/fortios_system_replacemsg_group_module.html