fortinet.fortimanager.fmgr_system_replacemsggroup_auth module – Записи таблицы сообщений замены.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_replacemsggroup_auth.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
replacemsg-group string | Устарело, используйте “replacemsg_group” |
replacemsg_group string | Параметр (replacemsg-group) в запрошенном URL. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
system_replacemsggroup_auth dictionary | Набор параметров верхнего уровня. |
|
buffer string |
Текст сообщения. |
|
format string |
Флаг формата. Варианты:
|
|
header string |
Флаг заголовка. Варианты:
|
|
msg_type псевдонимы: msg-type string / обязательный |
Тип сообщения. |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другое значение, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook
hosts: fortimanagers
gather_facts: false
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_auth:
bypass_validation: false
adom: ansible
replacemsg_group: ansible-test # name
state: present
system_replacemsggroup_auth:
buffer: ansible-buffer
format: text # <value in [none, text, html, ...]>
header: http # <value in [none, http, 8bit]>
msg_type: ansible-msgtype # required
- 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 scripts
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_replacemsggroup_auth"
params:
adom: "ansible"
replacemsg_group: "ansible-test" # name
auth: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_system_replacemsggroup_auth_module.html
