fortinet.fortimanager.fmgr_system_report_group модуль — Группа отчетов.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_report_group.
Новое в fortinet.fortimanager 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить для данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логическое значение | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
system_report_group словарь | Настроены параметры верхнего уровня. |
|
adom строка |
Имя домена администратора. |
|
case_insensitive строка |
Устаревшее, переименуйте на case_insensitive. Нечувствительность к регистру. disable - Отключить нечувствительность к регистру. enable - Включить нечувствительность к регистру. Варианты:
|
|
chart_alternative список / элементы=словарь |
Устаревшее, переименуйте на chart_alternative. Альтернативная диаграмма. |
|
chart_name строка |
Устаревшее, переименуйте на chart_name. Название диаграммы. |
|
chart_replace строка |
Устаревшее, переименуйте на chart_replace. Замена диаграммы. |
|
group_by список / элементы=словарь |
Устаревшее, переименуйте на group_by. Группировка. |
|
var_expression строка |
Устаревшее, переименуйте на var_expression. Выражение переменной. |
|
var_name строка |
Устаревшее, переименуйте на var_name. Имя переменной. |
|
var_type строка |
Устаревшее, переименуйте на var_type. Тип переменной. integer - Целое число. string - Строка. enum - Перечисление. ip - IP. Варианты:
|
|
group_id целое число / обязательно |
Устаревшее, переименуйте на group_id. Идентификатор группы. |
|
report_like строка |
Устаревшее, переименуйте на report_like. Шаблон отчета. |
workspace_locking_adom строка | Домен администрирования для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая корень. |
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 помогают в работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код возврата. Вы также можете переопределить условия завершения успехом или ошибкой с помощью параметров 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: Report group.
fortinet.fortimanager.fmgr_system_report_group:
# 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, ...]
state: present # <value in [present, absent]>
system_report_group:
adom: <string>
case_insensitive: <value in [disable, enable]>
chart_alternative:
-
chart_name: <string>
chart_replace: <string>
group_by:
-
var_expression: <string>
var_name: <string>
var_type: <value in [integer, string, enum, ...]>
group_id: <integer>
report_like: <string>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
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_report_group_module.html
