Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_replacemsg_group — настройка групп сообщений-замен в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_replacemsg_group.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов больше одного, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

system_replacemsg_group

dictionary

Настройка групп сообщений замены.

admin

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

alertmail

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

auth

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

automation

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

comment

string

Комментарий.

custom_message

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

device_detection_portal

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

ec

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

fortiguard_wf

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

ftp

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

group_type

string

Тип группы.

Варианты:

  • "default"
  • "utm"
  • "auth"
  • "ec"

http

list / elements=dictionary

Записи таблицы сообщений замены.

buffer

string

Текст сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

icap

list / elements=dictionary

Записи таблицы сообщений-замен.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательно

Тип сообщения.

mail

list / elements=dictionary

Записи таблицы сообщений-замен.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательно

Тип сообщения.

mm1

list / elements=dictionary

Записи таблицы сообщений-замен.

add_smil

string

добавить инкапсуляцию сообщения

Варианты:

  • "enable"
  • "disable"

charset

string

кодировка символов, используемая для сообщения-замены

Варианты:

  • "utf-8"
  • "us-ascii"

class

string

класс сообщения

Варианты:

  • "not-included"
  • "personal"
  • "advertisement"
  • "information"
  • "automatic"

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

fos_message

string

текст сообщения

from

string

адрес отправителя

from_sender

string

уведомительное сообщение, отправленное получателю

Варианты:

  • "enable"
  • "disable"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

image

string

Строка сообщения. Источник: system.replacemsg-image.name.

msg_type

string / обязательно

Тип сообщения.

priority

string

приоритет сообщения

Варианты:

  • "not-included"
  • "low"
  • "normal"
  • "high"

rsp_status

string

код состояния ответа

Варианты:

  • "ok"
  • "err-unspecified"
  • "err-srv-denied"
  • "err-msg-fmt-corrupt"
  • "err-snd-addr-unresolv"
  • "err-msg-not-found"
  • "err-net-prob"
  • "err-content-not-accept"
  • "err-unsupp-msg"

rsp_text

string

текст ответа

sender_visibility

string

видимость отправителя

Варианты:

  • "not-specified"
  • "show"
  • "hide"

smil_part

string

текст инкапсуляции сообщения

subject

string

строка темы сообщения

mm3

list / elements=dictionary

Записи таблицы сообщений-замен.

add_html

string

добавить инкапсуляцию сообщения

Варианты:

  • "enable"
  • "disable"

charset

string

кодировка символов, используемая для сообщения-замены

Варианты:

  • "utf-8"
  • "us-ascii"

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

fos_message

string

текст сообщения

from

string

адрес отправителя

from_sender

string

уведомительное сообщение, отправленное получателю

Варианты:

  • "enable"
  • "disable"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

html_part

string

текст инкапсуляции сообщения

image

string

Строка сообщения. Источник: system.replacemsg-image.name.

msg_type

string / обязательно

Тип сообщения.

priority

string

приоритет сообщения

Варианты:

  • "not-included"
  • "low"
  • "normal"
  • "high"

subject

string

строка темы сообщения

mm4

list / elements=dictionary

Записи таблицы сообщений-замен.

add_smil

string

добавить инкапсуляцию сообщения

Варианты:

  • "enable"
  • "disable"

charset

string

кодировка символов, используемая для сообщения-замены

Варианты:

  • "utf-8"
  • "us-ascii"

class

string

класс сообщения

Варианты:

  • "not-included"
  • "personal"
  • "informational"
  • "advertisement"
  • "auto"

domain

string

домен адреса отправителя

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

fos_message

string

текст сообщения

from

string

адрес отправителя

from_sender

string

уведомительное сообщение, отправленное получателю

Варианты:

  • "enable"
  • "disable"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

image

string

Строка сообщения. Источник: system.replacemsg-image.name.

msg_type

string / обязательно

Тип сообщения.

priority

string

приоритет сообщения

Варианты:

  • "not-included"
  • "low"
  • "normal"
  • "high"

rsp_status

string

состояние ответа

Варианты:

  • "ok"
  • "err-unspecified"
  • "err-srv-denied"
  • "err-msg-fmt-corrupt"
  • "err-snd-addr-unresolv"
  • "err-net-prob"
  • "err-content-not-accept"
  • "err-unsupp-msg"

smil_part

string

текст инкапсуляции сообщения

subject

string

строка темы сообщения

mm7

list / elements=dictionary

Записи таблицы сообщений-замен.

add_smil

string

добавление инкапсуляции сообщения

Варианты:

  • "enable"
  • "disable"

addr_type

string

тип адреса отправителя

Варианты:

  • "rfc2822-addr"
  • "number"
  • "short-code"

allow_content_adaptation

string

разрешить адаптацию содержимого

Варианты:

  • "enable"
  • "disable"

charset

string

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

Варианты:

  • "utf-8"
  • "us-ascii"

class

string

класс сообщения

Варианты:

  • "not-included"
  • "personal"
  • "informational"
  • "advertisement"
  • "auto"

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

fos_message

string

текст сообщения

from

string

адрес отправителя

from_sender

string

уведомление, отправленное получателю

Варианты:

  • "enable"
  • "disable"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

image

string

Строка сообщения. Источник: system.replacemsg-image.name.

msg_type

string / обязательный

Тип сообщения.

priority

string

приоритет сообщения

Варианты:

  • "not-included"
  • "low"
  • "normal"
  • "high"

rsp_status

string

статус ответа

Варианты:

  • "success"
  • "partial-success"
  • "client-err"
  • "oper-restrict"
  • "addr-err"
  • "addr-not-found"
  • "content-refused"
  • "msg-id-not-found"
  • "link-id-not-found"
  • "msg-fmt-corrupt"
  • "app-id-not-found"
  • "repl-app-id-not-found"
  • "srv-err"
  • "not-possible"
  • "msg-rejected"
  • "multiple-addr-not-supp"
  • "app-addr-not-supp"
  • "gen-service-err"
  • "improper-ident"
  • "unsupp-ver"
  • "unsupp-oper"
  • "validation-err"
  • "service-err"
  • "service-unavail"
  • "service-denied"
  • "app-denied"

smil_part

string

текст инкапсуляции сообщения

subject

string

текст темы сообщения

mms

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

charset

string

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

Варианты:

  • "utf-8"
  • "us-ascii"

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

image

string

Строка сообщения. Источник: system.replacemsg-image.name.

msg_type

string / обязательный

Тип сообщения.

nac_quar

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

name

string / обязательный

Имя группы.

nntp

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

spam

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

sslvpn

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

traffic_quota

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

utm

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

webproxy

list / elements=dictionary

Записи таблицы замещающих сообщений.

buffer

string

Строка сообщения.

format

string

Флаг формата.

Варианты:

  • "none"
  • "text"
  • "html"
  • "wml"

header

string

Флаг заголовка.

Варианты:

  • "none"
  • "http"
  • "8bit"

msg_type

string / обязательный

Тип сообщения.

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi больше не поддерживается; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure replacement message groups.
  fortinet.fortios.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>"
          automation:
              -
                  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>"
          mm1:
              -
                  add_smil: "enable"
                  charset: "utf-8"
                  class: "not-included"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  rsp_status: "ok"
                  rsp_text: "<your_own_value>"
                  sender_visibility: "not-specified"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mm3:
              -
                  add_html: "enable"
                  charset: "utf-8"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  html_part: "<your_own_value>"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  subject: "<your_own_value>"
          mm4:
              -
                  add_smil: "enable"
                  charset: "utf-8"
                  class: "not-included"
                  domain: "<your_own_value>"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  rsp_status: "ok"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mm7:
              -
                  add_smil: "enable"
                  addr_type: "rfc2822-addr"
                  allow_content_adaptation: "enable"
                  charset: "utf-8"
                  class: "not-included"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  rsp_status: "success"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mms:
              -
                  buffer: "<your_own_value>"
                  charset: "utf-8"
                  format: "none"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
          nac_quar:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          name: "default_name_140"
          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

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Использованный виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_replacemsg_group_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API