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

Примечание

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

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

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

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

Новый в 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_mms словарь	Набор параметров верхнего уровня.
buffer строка	Строка сообщения.
charset строка	Кодировка символов, используемая для сообщения замены. Варианты: `"us-ascii"` `"utf-8"`
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
image строка	Строка сообщения.
msg_type строка / обязательно	Устарело, пожалуйста, переименуйте на msg_type. Тип сообщения.
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_mms:
        # 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_mms:
          buffer: <string>
          charset: <value in [us-ascii, utf-8]>
          format: <value in [none, text, html, ...]>
          header: <value in [none, http, 8bit]>
          image: <string>
          msg_type: <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_mms_module.html