fortinet.fortimanager.fmgr_dvmdb_script – Таблица сценариев.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvmdb_script
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить, используя источники данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation логическое значение |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| dvmdb_script словарь | установленные параметры верхнего уровня | |||
| content строка | Полное содержимое журнала результатов сценария. | |||
| desc строка | нет описания | |||
| filter_build целое число | Значение будет проигнорировано в запросах добавления/изменения/обновления, если filter_ostype не задан. Не имеет эффекта, если target — "adom_database". | |||
| filter_device целое число | Имя или идентификатор существующего устройства в базе данных. Не имеет эффекта, если target — "adom_database". | |||
| filter_hostname строка | Значение не имеет эффекта, если target — "adom_database". | |||
| filter_ostype строка |
| Значение не имеет эффекта, если target — "adom_database". | ||
| filter_osver строка |
| Значение будет проигнорировано в запросах добавления/изменения/обновления, если filter_ostype не задан. Не имеет эффекта, если target — "adom_database". | ||
| filter_platform строка | Значение будет проигнорировано в запросах добавления/изменения/обновления, если filter_ostype не задан. Не имеет эффекта, если target — "adom_database". | |||
| filter_serial строка | Значение не имеет эффекта, если target — "adom_database". | |||
| modification_time строка | Это атрибут только для чтения, указывающий время создания или изменения сценария. Значение будет проигнорировано в запросах добавления/изменения/... | |||
| name строка | нет описания | |||
| script_schedule список / элементы=строка | нет описания | |||
| datetime строка | Указывает дату и время расписания. Для каждого типа расписания следует использовать следующий формат: onetime: "ГГГГ-ММ-ДД чч:мм:сс" daily: "чч:мм" weekly: "чч:мм" monthly: "ДД чч:мм" | |||
| day_of_week строка |
| нет описания | ||
| device целое число | Имя или идентификатор существующего устройства в базе данных. | |||
| name строка | нет описания | |||
| run_on_db строка |
| Указывает, должен ли запланированный сценарий выполняться в базе данных устройства. Для сценариев tcl это значение всегда должно быть выключено. | ||
| type строка |
| нет описания | ||
| target строка |
| нет описания | ||
| type строка |
| нет описания | ||
| rc_failed список / элементы=строка | список rc-кодов, с которыми будет переопределено условие ошибки | |||
| rc_succeeded список / элементы=строка | список rc-кодов, с которыми будет переопределено условие успеха | |||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | ||
| workspace_locking_adom строка | adom для блокировки в режиме работы FortiManager в рабочем пространстве, значение может быть глобальным и другими, включая root | |||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства | ||
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву present состояния.
- Для удаления объекта используйте директиву absent состояния.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Script table.
fmgr_dvmdb_script:
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>
state: <value in [present, absent]>
dvmdb_script:
content: <value of string>
desc: <value of string>
filter_build: <value of integer>
filter_device: <value of integer>
filter_hostname: <value of string>
filter_ostype: <value in [unknown, fos]>
filter_osver: <value in [unknown, 4.00, 5.00]>
filter_platform: <value of string>
filter_serial: <value of string>
modification_time: <value of string>
name: <value of string>
script_schedule:
-
datetime: <value of string>
day_of_week: <value in [unknown, sun, mon, ...]>
device: <value of integer>
name: <value of string>
run_on_db: <value in [disable, enable]>
type: <value in [auto, onetime, daily, ...]>
target: <value in [device_database, remote_device, adom_database]>
type: <value in [cli, tcl, cligrp]>
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_dvmdb_script_module.html
