Spec-Zone.ru › Ansible

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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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), позволяя пользователю устанавливать и изменять системные функции и категорию replacemsg_group. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировался с FOS v6.0.0

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

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

enable_log

булево

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

Выбор:

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

member_path

строка

Путь к атрибуту члена для обработки.

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

Параметр, помеченный member_path, является допустимым для выполнения операции над членом.

member_state

строка

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

Когда member_state указан, опция state игнорируется.

Выбор:

  • "present"
  • "absent"

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

строка / обязательно

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

automation

list / elements=dictionary

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

buffer

string

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

format

string

Флаг форматирования.

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

comment

string

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

custom_message

list / elements=dictionary

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

buffer

string

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

format

string

Флаг форматирования.

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

device_detection_portal

list / elements=dictionary

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

buffer

string

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

format

string

Флаг форматирования.

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

ec

list / elements=dictionary

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

buffer

string

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

format

string

Флаг форматирования.

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

fortiguard_wf

list / elements=dictionary

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

buffer

string

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

format

string

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

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

ftp

list / elements=dictionary

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

buffer

string

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

format

string

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

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

group_type

string

Тип группы.

Choices:

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

http

list / elements=dictionary

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

buffer

string

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

format

string

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

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

icap

list / elements=dictionary

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

buffer

string

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

format

string

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

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

mail

list / elements=dictionary

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

buffer

string

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

format

string

Флаг форматирования.

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

mm1

list / elements=dictionary

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

add_smil

string

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

Choices:

  • "enable"
  • "disable"

charset

string

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

Choices:

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

class

string

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

Choices:

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

format

string

Флаг форматирования.

Choices:

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

fos_message

string

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

from

string

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

from_sender

string

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

Choices:

  • "enable"
  • "disable"

header

string

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

Choices:

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

image

string

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

msg_type

string / required

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

priority

string

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

Choices:

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

rsp_status

string

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

Choices:

  • "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

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

Choices:

  • "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 / required

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

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

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

Choices:

  • "enable"
  • "disable"

header

string

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

Choices:

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

image

string

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

msg_type

string / required

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

priority

string

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

Choices:

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

rsp_status

string

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

Choices:

  • "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

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

Choices:

  • "enable"
  • "disable"

addr_type

string

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

Choices:

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

allow_content_adaptation

string

разрешить адаптацию контента

Choices:

  • "enable"
  • "disable"

charset

string

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

Choices:

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

class

string

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

Choices:

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

format

string

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

Choices:

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

fos_message

string

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

from

string

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

from_sender

string

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

Choices:

  • "enable"
  • "disable"

header

string

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

Choices:

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

image

string

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

msg_type

string / required

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

priority

string

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

Choices:

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

rsp_status

string

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

Choices:

  • "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

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

Choices:

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

format

string

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

Choices:

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

header

string

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

Choices:

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

image

string

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

msg_type

string / required

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

nac_quar

list / elements=dictionary

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

buffer

string

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

format

string

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

Choices:

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

header

string

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

Choices:

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

msg_type

string / required

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

name

string / required

Имя группы.

nntp

list / elements=dictionary

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

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

string / required

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

spam

list / elements=dictionary

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

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

string / required

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

sslvpn

list / elements=dictionary

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

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

string / required

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

traffic_quota

list / elements=dictionary

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

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

string / required

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

utm

list / elements=dictionary

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

buffer

string

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

формат

строка

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

Выбор:

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

заголовок

строка

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

Выбор:

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

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

строка / обязательно

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

webproxy

список / элементы=словарь

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

буфер

строка

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

формат

строка

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

Выбор:

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

заголовок

строка

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

Выбор:

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

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

строка / обязательно

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

vdom

строка

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

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

Примечания

Примечание

  • Модуль fortiosapi устарел, httpapi предпочтительнее для запуска playbooks
  • Модуль поддерживает режим проверки (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

строка

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

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

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

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

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

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

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_replacemsg_group_module.html

Spec-Zone.ru

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