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

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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_mm1 словарь	Набор параметров верхнего уровня.
add_smil строка	Устарело, переименуйте на add_smil. Добавить инкапсуляцию сообщения Варианты: `"disable"` `"enable"`
charset строка	Кодировка символов, используемая для замены сообщения Варианты: `"us-ascii"` `"utf-8"`
class строка	Класс сообщения Варианты: `"personal"` `"advertisement"` `"information"` `"automatic"` `"not-included"`
fmgr_message строка	Текст сообщения
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
from строка	Адрес отправителя
from_sender строка	Устарело, переименуйте на from_sender. Отправитель уведомления Варианты: `"disable"` `"enable"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`

END_OF_DOCUMENT_MARKER

image строка	Строка сообщения.
msg-type строка / обязательно	Устаревшее, пожалуйста, переименуйте его в msg_type. Тип сообщения.
priority строка	Приоритет сообщения Варианты: `"low"` `"normal"` `"high"` `"not-included"`
rsp-status строка	Устаревшее, пожалуйста, переименуйте его в rsp_status. Код состояния ответа Варианты: `"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. Текст ответа
sender-visibility строка	Устаревшее, пожалуйста, переименуйте его в sender_visibility. Видимость отправителя Варианты: `"hide"` `"show"` `"not-specified"`
smil-part строка	Устаревшее, пожалуйста, переименуйте его в smil_part. Текст инкапсуляции сообщения
subject строка	Строка текста темы
workspace_locking_adom строка	Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует блокировку рабочей области. По умолчанию: `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_mm1:
        # 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_mm1:
          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>
          msg_type: <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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_mm1_module.html