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

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_replacemsggroup_mm7.

Введено в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для завершения неудачно.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успешного завершения.
replacemsg-group строка	Устарело, используйте «replacemsg_group»
replacemsg_group строка	Параметр (replacemsg-group) в запрошенном URL.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_replacemsggroup_mm7 словарь	Набор параметров верхнего уровня.
add_smil строка	Устарело, переименуйте на add_smil. Добавление инкапсуляции сообщения Варианты: `"disable"` `"enable"`
addr_type строка	Устарело, переименуйте на addr_type. Тип адреса Варианты: `"rfc2822-addr"` `"number"` `"short-code"`
allow_content_adaptation строка	Устарело, переименуйте на allow_content_adaptation. Разрешить адаптацию контента Варианты: `"disable"` `"enable"`
charset строка	Кодировка символов, используемая для сообщения замены Варианты: `"us-ascii"` `"utf-8"`
class строка	Класс сообщения Варианты: `"personal"` `"advertisement"` `"informational"` `"auto"` `"not-included"`
fmgr_message строка	Текст сообщения
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
from строка	Адрес отправителя

END_OF_DOCUMENT_MARKER

from-sender string	Устаревшее, пожалуйста, переименуйте его на from_sender. Сообщение уведомления, отправленное получателем Варианты: `"disable"` `"enable"`
header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
image string	Строка сообщения.
msg-type string / обязательно	Устаревшее, пожалуйста, переименуйте его на msg_type. Тип сообщения.
priority string	Приоритет сообщения Варианты: `"low"` `"normal"` `"high"` `"not-included"`
rsp-status string	Устаревшее, пожалуйста, переименуйте его на rsp_status. Статус ответа Варианты: `"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	Устаревшее, пожалуйста, переименуйте его на smil_part. Текст инкапсуляции сообщения
subject string	Строка текста темы
workspace_locking_adom string	ADOM для блокировки рабочего пространства для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 помогают в работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой rc. Вы также можете переопределить условия завершения ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Replacement message table entries.
      fortinet.fortimanager.fmgr_system_replacemsggroup_mm7:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        replacemsg_group: <your own value>
        state: present # <value in [present, absent]>
        system_replacemsggroup_mm7:
          add_smil: <value in [disable, enable]>
          addr_type: <value in [rfc2822-addr, number, short-code]>
          allow_content_adaptation: <value in [disable, enable]>
          charset: <value in [us-ascii, utf-8]>
          class: <value in [personal, advertisement, informational, ...]>
          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>
          msg_type: <string>
          priority: <value in [low, normal, high, ...]>
          rsp_status: <value in [success, partial-success, client-err, ...]>
          smil_part: <string>
          subject: <string>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_replacemsggroup_mm7_module.html