Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_system_replacemsggroup module – Настройка групп сообщений-замен.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_replacemsggroup.

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

Параметр (adom) в запрашиваемом URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Варианты:

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

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределенный метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, задающий условия, при которых операция считается неудачной; эти условия будут переопределены.

rc_succeeded

list / elements=integer

Список кодов rc, задающий условия, при которых операция считается успешной; эти условия будут переопределены.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

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

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

system_replacemsggroup

dictionary

Набор параметров верхнего уровня.

admin

list / elements=dictionary

Администратор.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

alertmail

list / elements=dictionary

Электронное уведомление.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

id

integer

Идентификатор.

msg_type

aliases: msg-type

string

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

auth

list / elements=dictionary

Аутентификация.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

automation

list / elements=dictionary

Автоматизация.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

comment

string

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

custom_message

aliases: custom-message

list / elements=dictionary

Пользовательское сообщение.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

device_detection_portal

aliases: device-detection-portal

list / elements=dictionary

Портал обнаружения устройств.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

ec

list / elements=dictionary

EC.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

fortiguard_wf

aliases: fortiguard-wf

list / elements=dictionary

FortiGuard WF.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

ftp

list / elements=dictionary

FTP.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

group_type

aliases: group-type

string

Тип группы.

Варианты:

  • "default"
  • "utm"
  • "auth"
  • "ec"
  • "captive-portal"

http

list / elements=dictionary

HTTP.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

icap

list / elements=dictionary

ICAP.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

mail

list / elements=dictionary

Почта.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

mm1

list / elements=dictionary

Mm1.

add_smil

aliases: add-smil

string

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

Варианты:

  • "disable"
  • "enable"

charset

string

Кодировка символов для сообщения-замены

Варианты:

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

class

string

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

Варианты:

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

fmgr_message

string

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

format

string

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

Варианты:

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

from

string

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

from_sender

aliases: from-sender

string

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

Варианты:

  • "disable"
  • "enable"

header

string

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

Варианты:

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

image

string

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

msg_type

aliases: msg-type

string

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

priority

string

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

Варианты:

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

rsp_status

aliases: 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

aliases: rsp-text

string

Текст ответа

sender_visibility

aliases: sender-visibility

string

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

Варианты:

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

smil_part

aliases: smil-part

string

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

subject

string

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

mm3

list / elements=dictionary

Mm3.

add_html

aliases: add-html

string

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

Варианты:

  • "disable"
  • "enable"

charset

string

Кодировка символов для сообщения-замены

Варианты:

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

fmgr_message

string

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

format

string

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

Варианты:

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

from

string

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

from_sender

aliases: from-sender

string

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

Варианты:

  • "disable"
  • "enable"

header

string

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

Варианты:

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

html_part

aliases: html-part

string

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

image

string

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

msg_type

aliases: msg-type

string

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

priority

string

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

Варианты:

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

subject

string

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

mm4

list / elements=dictionary

Mm4.

add_smil

aliases: add-smil

string

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

Варианты:

  • "disable"
  • "enable"

charset

string

Кодировка символов для сообщения-замены

Варианты:

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

class

string

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

Варианты:

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

domain

string

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

fmgr_message

string

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

format

string

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

Варианты:

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

from

string

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

from_sender

aliases: from-sender

string

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

Варианты:

  • "disable"
  • "enable"

header

string

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

Варианты:

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

image

string

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

msg_type

aliases: msg-type

string

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

priority

string

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

Варианты:

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

rsp_status

aliases: 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

aliases: smil-part

string

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

subject

string

Текст темы

mm7

list / elements=dictionary

Mm7.

add_smil

aliases: add-smil

string

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

Варианты:

  • "disable"
  • "enable"

addr_type

aliases: addr-type

string

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

Варианты:

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

allow_content_adaptation

aliases: allow-content-adaptation

string

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

Варианты:

  • "disable"
  • "enable"

charset

string

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

Варианты:

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

class

string

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

Варианты:

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

fmgr_message

string

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

format

string

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

Варианты:

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

from

string

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

from_sender

aliases: from-sender

string

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

Варианты:

  • "disable"
  • "enable"

header

string

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

Варианты:

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

image

string

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

msg_type

aliases: msg-type

string

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

priority

string

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

Варианты:

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

rsp_status

aliases: 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

aliases: smil-part

string

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

subject

string

Текст темы

mms

list / elements=dictionary

Mms.

buffer

string

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

charset

string

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

Варианты:

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

image

string

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

msg_type

aliases: msg-type

string

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

nac_quar

aliases: nac-quar

list / elements=dictionary

Карантин NAC.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

id

integer

Идентификатор.

msg_type

aliases: msg-type

string

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

name

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

Имя группы.

nntp

list / elements=dictionary

NNTP.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

spam

list / elements=dictionary

Спам.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

sslvpn

list / elements=dictionary

SSL VPN.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

traffic_quota

aliases: traffic-quota

list / elements=dictionary

Квота трафика.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

utm

list / elements=dictionary

UTM.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

webproxy

list / elements=dictionary

Веб-прокси.

buffer

string

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

format

string

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

Варианты:

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

header

string

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

Варианты:

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

msg_type

aliases: msg-type

string

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

workspace_locking_adom

string

ADOM, который необходимо заблокировать в FortiManager, работающем в режиме рабочей области; значением может быть global, а также другие значения, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, имена всех входных аргументов соответствуют соглашению об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия, при которых выполнение считается неудачным или успешным, можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Чтобы создать или обновить объект, используйте директиву state present.
  • Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure replacement message groups.
      fortinet.fortimanager.fmgr_system_replacemsggroup:
        bypass_validation: false
        adom: ansible
        state: present
        system_replacemsggroup:
          comment: ansible-comment
          name: ansible-test

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the replacement message groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_replacemsggroup"
          params:
            adom: "ansible"
            replacemsg_group: "your_value"

Возвращаемые значения

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

Ключ

Описание

meta

dictionary

Результат запроса.

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Статус API-запроса.

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Текстовое описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / elements=string

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

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

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortimanager/fmgr_system_replacemsggroup_module.html

Spec-Zone.ru

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