модуль fortinet.fortimanager.fmgr_devprof_system_replacemsg_nntp — Сообщения замены.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.0.0

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation логический	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof строка / обязательный	Параметр (devprof) в запрошенном URL.
devprof_system_replacemsg_nntp словарь	Параметры верхнего уровня.
buffer строка	Строка сообщения.
format строка	Флаг формата. Варианты: `"none"` `"text"` `"html"` `"wml"`
header строка	Флаг заголовка. Варианты: `"none"` `"http"` `"8bit"`
msg_type псевдонимы: msg-type строка	Тип сообщения.
enable_log логический	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых запрос считается неудачным.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых запрос считается успешным.
workspace_locking_adom строка	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; значением может быть global или другие варианты, включая root.
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 позволяют выполнять эту задачу.
Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого кода rc. Условия, при которых запрос считается неудачным или успешным, можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Replacement messages.
      fortinet.fortimanager.fmgr_devprof_system_replacemsg_nntp:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_system_replacemsg_nntp:
          # buffer: <string>
          # format: <value in [none, text, html, ...]>
          # header: <value in [none, http, 8bit]>
          # 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_system_replacemsg_nntp_module.html