fortinet.fortimanager.fmgr_system_replacemsggroup модуль — Настройка групп сообщений замены.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к 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, с которыми будут переопределены условия успешного завершения задачи.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_replacemsggroup словарь	Установленные параметры верхнего уровня.
admin список / элементы=словарь	Администрирование.
buffer строка	Строка сообщения.
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
msg-type строка	Устаревший параметр, пожалуйста, переименуйте его в msg_type. Тип сообщения.
alertmail список / элементы=словарь	Alertmail.
buffer строка	Строка сообщения.
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
id целое число	Идентификатор.
msg-type строка	Устаревший параметр, пожалуйста, переименуйте его в msg_type. Тип сообщения.

auth list / elements=dictionary	Авторизация.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
automation list / elements=dictionary	Автоматизация.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
comment string	Комментарий.
custom-message list / elements=dictionary	Устарело, переименуйте в custom_message. Пользовательское сообщение.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
device-detection-portal list / elements=dictionary	Устарело, переименуйте в device_detection_portal. Портал обнаружения устройств.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
ec list / elements=dictionary	Ec.

buffer string	Строка сообщения.
format string	Флаг форматирования. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
fortiguard-wf list / elements=dictionary	Устарело, переименуйте в fortiguard_wf. Fortiguard wf.
buffer string	Строка сообщения.
format string	Флаг форматирования. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
ftp list / elements=dictionary	Ftp.
buffer string	Строка сообщения.
format string	Флаг форматирования. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
group-type string	Устарело, переименуйте в group_type. Тип группы. Choices: `"default"` `"utm"` `"auth"` `"ec"` `"captive-portal"`
http list / elements=dictionary	Http.
buffer string	Строка сообщения.
format string	Флаг форматирования. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
icap list / elements=dictionary	Icap.

buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
mail list / elements=dictionary	Почта.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
mm1 list / elements=dictionary	Mm1.
add-smil string	Устарело, переименуйте в add_smil. Добавить инкапсуляцию сообщения Choices: `"disable"` `"enable"`
charset string	Кодировка символов, используемая для сообщения замены Choices: `"us-ascii"` `"utf-8"`
class string	Класс сообщения Choices: `"personal"` `"advertisement"` `"information"` `"automatic"` `"not-included"`
fmgr_message string	Текст сообщения
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
from string	Адрес отправителя
from-sender string	Устарело, переименуйте в from_sender. Уведомление отправлено от получателя Choices: `"disable"` `"enable"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
image string	Строка сообщения.
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
priority string	Приоритет сообщения Choices: `"low"` `"normal"` `"high"` `"not-included"`

rsp-status string	Устарело, переименуйте в 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 string	Устарело, переименуйте в rsp_text. Текст ответа
sender-visibility string	Устарело, переименуйте в sender_visibility. Видимость отправителя Варианты: `"hide"` `"show"` `"not-specified"`
smil-part string	Устарело, переименуйте в smil_part. Текст инкапсуляции сообщения
subject string	Строка текста темы
mm3 list / elements=dictionary	Mm3.
add-html string	Устарело, переименуйте в add_html. Добавить инкапсуляцию сообщения Варианты: `"disable"` `"enable"`
charset string	Кодировка символов, используемая для сообщения замены Варианты: `"us-ascii"` `"utf-8"`
fmgr_message string	Текст сообщения
format string	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
from string	Адрес отправителя
from-sender string	Устарело, переименуйте в from_sender. Уведомление отправлено от получателя Варианты: `"disable"` `"enable"`
header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
html-part string	Устарело, переименуйте в html_part. Текст инкапсуляции сообщения
image string	Строка сообщения.
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
priority string	Приоритет сообщения Варианты: `"low"` `"normal"` `"high"` `"not-included"`
subject string	Строка текста темы
mm4 list / elements=dictionary	Mm4.
add-smil string	Устарело, переименуйте в add_smil. Добавить инкапсуляцию сообщения Варианты: `"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 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. Статус ответа Варианты: `"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 string	Устарело, переименуйте в smil_part. Текст инкапсуляции сообщения
subject string	Строка текста темы
mm7 list / elements=dictionary	Mm7.
add-smil string	Устарело, переименуйте в add_smil. Добавить инкапсуляцию сообщения Варианты: `"disable"` `"enable"`
addr-type string	Устарело, переименуйте в addr_type. Тип адреса отправителя Варианты: `"rfc2822-addr"` `"number"` `"short-code"`
allow-content-adaptation string	Устарело, переименуйте в allow_content_adaptation. Разрешить адаптацию контента Варианты: `"disable"` `"enable"`
charset string	Кодировка символов, используемая для сообщения замены Варианты: `"us-ascii"` `"utf-8"`
class string	Класс сообщения Варианты: `"personal"` `"advertisement"` `"informational"` `"auto"` `"not-included"`
fmgr_message string	Текст сообщения

формат строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
от строка	Адрес отправителя
отправитель строка	Устаревшее, пожалуйста, переименуйте на from_sender. Сообщение отправлено от получателя Варианты: `"disable"` `"enable"`
заголовок строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
изображение строка	Строка сообщения.
тип_сообщения строка	Устаревшее, пожалуйста, переименуйте на msg_type. Тип сообщения.
приоритет строка	Приоритет сообщения Варианты: `"low"` `"normal"` `"high"` `"not-included"`
статус_ответа строка	Устаревшее, пожалуйста, переименуйте на 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 строка	Устаревшее, пожалуйста, переименуйте на smil_part. Текст инкапсуляции сообщения
тема строка	Строка текста темы
mms список / элементы=словарь	MMS.
буфер строка	Строка сообщения.
кодировка_символов строка	Кодировка символов, используемая для сообщения замены Варианты: `"us-ascii"` `"utf-8"`
формат строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
заголовок строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
изображение строка	Строка сообщения.
тип_сообщения строка	Устаревшее, пожалуйста, переименуйте на msg_type. Тип сообщения.
nac_quar список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на nac_quar. Nac quar.
буфер строка	Строка сообщения.
формат строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`

header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
id integer	Идентификатор.
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
name string / required	Имя группы.
nntp list / elements=dictionary	NNTP.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
spam list / elements=dictionary	Спам.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
sslvpn list / elements=dictionary	SSLVPN.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Choices: `"none"` `"http"` `"8bit"`
msg-type string	Устарело, переименуйте в msg_type. Тип сообщения.
traffic-quota list / elements=dictionary	Устарело, переименуйте в traffic_quota. Квота трафика.
buffer string	Строка сообщения.
format string	Флаг формата. Choices: `"none"` `"text"` `"html"` `"wml"`

header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
msg-type string	Устаревший параметр, пожалуйста, переименуйте его в msg_type. Тип сообщения.
utm list / elements=dictionary	Utm.
buffer string	Строка сообщения.
format string	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
msg-type string	Устаревший параметр, пожалуйста, переименуйте его в msg_type. Тип сообщения.
webproxy list / elements=dictionary	Webproxy.
buffer string	Строка сообщения.
format string	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
header string	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
msg-type string	Устаревший параметр, пожалуйста, переименуйте его в msg_type. Тип сообщения.
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
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
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_module.html