Модуль fortinet.fortimanager.fmgr_system_replacemsggroup_mm1 — записи таблицы сообщений-замен.

Примечание

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

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

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

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

Добавлено в 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 / элементы=integer	Список кодов rc, для которых переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, для которых переопределяются условия успешного выполнения.
replacemsg-group string	Устарел, используйте «replacemsg_group»
replacemsg_group string	Параметр (replacemsg-group) в запрошенном URL.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
system_replacemsggroup_mm1 dictionary	Набор параметров верхнего уровня.
add_smil псевдонимы: 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 псевдонимы: from-sender string	Уведомление, отправленное получателю от имени отправителя Варианты: `"disable"` `"enable"`
header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
image string	Строка сообщения.
msg_type псевдонимы: msg-type string / обязательный	Тип сообщения.
priority string	Приоритет сообщения Варианты: `"low"` `"normal"` `"high"` `"not-included"`
rsp_status псевдонимы: 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 псевдонимы: rsp-text string	Текст ответа
sender_visibility псевдонимы: sender-visibility string	Видимость отправителя Варианты: `"hide"` `"show"` `"not-specified"`
smil_part псевдонимы: smil-part string	Текст инкапсуляции сообщения
subject string	Текст темы
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Replacement message table entries.
      fortinet.fortimanager.fmgr_system_replacemsggroup_mm1:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        replacemsg_group: <your own value>
        state: present # <value in [present, absent]>
        system_replacemsggroup_mm1:
          msg_type: "your value" # Required variable, string
          # add_smil: <value in [disable, enable]>
          # charset: <value in [us-ascii, utf-8]>
          # class: <value in [personal, advertisement, information, ...]>
          # format: <value in [none, text, html, ...]>
          # from: <string>
          # from_sender: <value in [disable, enable]>
          # header: <value in [none, http, 8bit]>
          # image: <string>
          # fmgr_message: <string>
          # priority: <value in [low, normal, high, ...]>
          # rsp_status: <value in [ok, err-unspecified, err-srv-denied, ...]>
          # rsp_text: <string>
          # sender_visibility: <value in [hide, show, not-specified]>
          # smil_part: <string>
          # subject: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Состояние запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Состояние запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_mm1_module.html