модуль fortinet.fortimanager.fmgr_dvmdb_script – Таблица скриптов.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_dvmdb_script.
Добавлено в fortinet.fortimanager 1.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логический | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Допустимые значения:
|
dvmdb_script словарь | Параметры верхнего уровня. |
|
content строка |
Полное содержимое журнала результатов выполнения скрипта. |
|
desc строка |
Описание. |
|
filter_build целое число |
Значение игнорируется в запросах add/set/update, если не задан параметр filter_ostype. |
|
filter_device целое число |
Имя или идентификатор существующего устройства в базе данных. |
|
filter_hostname строка |
Значение не влияет на результат, если target имеет значение adom_database. |
|
filter_ostype строка |
Значение не влияет на результат, если target имеет значение adom_database. Допустимые значения:
|
|
filter_osver строка |
Значение игнорируется в запросах add/set/update, если не задан параметр filter_ostype. Допустимые значения:
|
|
filter_platform строка |
Значение игнорируется в запросах add/set/update, если не задан параметр filter_ostype. |
|
filter_serial строка |
Значение не влияет на результат, если target имеет значение adom_database. |
|
modification_time строка |
Атрибут только для чтения, указывающий время создания или изменения скрипта. |
|
name строка / обязательный |
Имя. |
|
script_schedule список / элементы=словарь |
Расписание скрипта. |
|
datetime строка |
Указывает дату и время выполнения по расписанию. onetime daily weekly monthly |
|
day_of_week строка |
День недели. Допустимые значения:
|
|
device целое число |
Имя или идентификатор существующего устройства в базе данных. |
|
name строка |
Имя. |
|
run_on_db строка |
Указывает, следует ли выполнять запланированный скрипт в базе данных устройства. Допустимые значения:
|
|
type строка |
Тип. Допустимые значения:
|
|
target строка |
Целевой объект. Допустимые значения:
|
|
type строка |
Тип. Допустимые значения:
|
enable_log логический | Включить или отключить ведение журнала для задачи. Допустимые значения:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределяемый метод для базового запроса Json RPC. Допустимые значения:
|
rc_failed список / элементы=целое число | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded список / элементы=целое число | Список кодов rc, переопределяющий условия успешного выполнения. |
state строка / обязательный | Указание на создание, обновление или удаление объекта. Допустимые значения:
|
workspace_locking_adom строка | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.
- Обычно выполнение модуля может завершиться с ошибкой, если возвращён ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Apply a script to device (For FMG <= 7.6.4)
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
device_adom: "root"
script_name: "FooScript"
device_name: "CustomHostName"
device_vdom: "root"
tasks:
# For FMG 7.6.4 and earlier, use fmgr_dvmdb_script.
# For FMG 7.6.5 and later, use fmgr_fmg_script.
- name: Create a Script to later execute
fortinet.fortimanager.fmgr_dvmdb_script:
adom: "{{ device_adom }}"
state: "present"
dvmdb_script:
name: "{{ script_name }}"
desc: "A script created via Ansible"
content: |
config system global
set remoteauthtimeout 80
end
type: "cli"
- name: Run the Script
fortinet.fortimanager.fmgr_dvmdb_script_execute:
adom: "{{ device_adom }}"
dvmdb_script_execute:
adom: "{{ device_adom }}"
script: "{{ script_name }}"
scope:
- name: "{{ device_name }}"
vdom: "{{ device_vdom }}"
register: running_task
- name: Inspect the Task Status
fortinet.fortimanager.fmgr_fact:
facts:
selector: "task_task"
params:
task: "{{ running_task.meta.response_data.task }}"
register: taskinfo
until: taskinfo.meta.response_data.percent == 100
retries: 30
delay: 3
failed_when: taskinfo.meta.response_data.state == 'error'
- 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: Script table.
fortinet.fortimanager.fmgr_dvmdb_script:
bypass_validation: false
adom: ansible
state: present
dvmdb_script:
content: "ansible-test"
name: "ansible-test"
target: device_database
type: cli
- 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 in the device
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dvmdb_script"
params:
adom: "ansible"
script: "your_value"
- 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: Enable workspace mode
fortinet.fortimanager.fmgr_system_global:
system_global:
adom_status: enable
workspace_mode: normal
- name: Script table.
fortinet.fortimanager.fmgr_dvmdb_script:
bypass_validation: false
adom: root
state: present
workspace_locking_adom: "root"
dvmdb_script:
content: "ansible-test"
name: "fooscript000"
target: device_database
type: cli
- name: Verify script table
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dvmdb_script"
params:
adom: "root"
script: "fooscript000"
register: info
failed_when: info.meta.response_code != 0
- name: Restore workspace mode
fortinet.fortimanager.fmgr_system_global:
system_global:
adom_status: enable
workspace_mode: disabled
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, характерные только для этого модуля:
Ключ | Описание |
|---|---|
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_dvmdb_script_module.html