Модуль fortinet.fortimanager.fmgr_system_replacemsggroup_custommessage – Записи таблицы замены сообщений.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_system_replacemsggroup_custommessage.
Новая версия в fortinet.fortimanager 2.0.0
Описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для использования с источниками данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. Выбираемые значения:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Выбираемые значения:
|
forticloud_access_token строка | Авторизовать клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Выбираемые значения:
|
rc_failed список / элементы=целое | Список кодов rc, с которыми будут переопределены условия для завершения задачи с ошибкой. |
rc_succeeded список / элементы=целое | Список кодов rc, с которыми будут переопределены условия для успешного завершения задачи. |
replacemsg-group строка | Устаревшее, используйте «replacemsg_group» |
replacemsg_group строка | Параметр (replacemsg-group) в запрошенном URL. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Выбираемые значения:
|
system_replacemsggroup_custommessage словарь | Настроеные параметры верхнего уровня. |
|
buffer строка |
Строка сообщения. |
|
format строка |
Флаг формата. Выбираемые значения:
|
|
header строка |
Флаг заголовка. Выбираемые значения:
|
|
msg_type строка / обязательно |
Устаревшее, переименуйте на msg_type. Тип сообщения. |
workspace_locking_adom строка | ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Replacement message table entries.
fortinet.fortimanager.fmgr_system_replacemsggroup_custommessage:
bypass_validation: false
adom: ansible
replacemsg-group: ansible-test # name
state: present
system_replacemsggroup_custommessage: # available only when group-type is set to 'utm' in replacemsg-group
buffer: ansible-buffer
format: none # <value in [none, text, html, ...]>
header: http # <value in [none, http, 8bit]>
msg-type: ansible-msgtype
- 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 table entries of replacement message group
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_replacemsggroup_custommessage" # available only when group-type is set to 'utm' in replacemsg-group
params:
adom: "ansible"
replacemsg-group: "ansible-test" # name
custom-message: "your_value"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на сборку
© 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_custommessage_module.html
