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

Примечание

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

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

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

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

Добавлено в 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, с помощью которого переопределяются условия успешного выполнения.
replacemsg-group string	Устарел, используйте “replacemsg_group”.
replacemsg_group string	Параметр (replacemsg-group) в запрошенном URL.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
system_replacemsggroup_mm3 dictionary	Набор параметров верхнего уровня.
add_html псевдонимы: add-html string	Добавление обрамления сообщения Варианты: `"disable"` `"enable"`
charset string	Кодировка символов, используемая для сообщения-замены Варианты: `"us-ascii"` `"utf-8"`
fmgr_message string	Текст сообщения
format string	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
from string	Адрес отправителя
from_sender псевдонимы: from-sender string	Уведомление, отправляемое получателю Варианты: `"disable"` `"enable"`
header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
html_part псевдонимы: html-part string	Текст обрамления сообщения
image string	Строка сообщения.
msg_type псевдонимы: msg-type string / обязательный	Тип сообщения.
priority string	Приоритет сообщения Варианты: `"low"` `"normal"` `"high"` `"not-included"`
subject 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Replacement message table entries.
      fortinet.fortimanager.fmgr_system_replacemsggroup_mm3:
        # 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_mm3:
          msg_type: "your value" # Required variable, string
          # add_html: <value in [disable, enable]>
          # charset: <value in [us-ascii, utf-8]>
          # format: <value in [none, text, html, ...]>
          # from: <string>
          # from_sender: <value in [disable, enable]>
          # header: <value in [none, http, 8bit]>
          # html_part: <string>
          # image: <string>
          # fmgr_message: <string>
          # priority: <value in [low, normal, high, ...]>
          # subject: <string>

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

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

Ключ	Описание
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_mm3_module.html