Модуль fortinet.fortimanager.fmgr_fmg_script — скрипт Fmg

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать ее в плейбуке, укажите: fortinet.fortimanager.fmgr_fmg_script.

Добавлено в fortinet.fortimanager 2.13.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
fmg_script dictionary	Параметры верхнего уровня.
content string	Содержимое.
desc string	Описание.
filter_build integer	Фильтр по номеру сборки.
filter_device integer	Фильтр по устройству.
filter_hostname string	Фильтр по имени узла.
filter_ostype integer	Фильтр по типу ОС.
filter_osver integer	Фильтр по версии ОС.
filter_platform string	Фильтр по платформе.
filter_serial string	Фильтр по серийному номеру.
member list / элементы=string	Элемент.
name string / обязательный	Имя.
schedule list / элементы=dictionary	Расписание.
datetime string	Дата и время.
day_of_week псевдонимы: day-of-week integer	День недели.
device integer	Устройство.
run_on_db псевдонимы: run-on-db integer	Выполнение в базе данных.
timestamp integer	Метка времени.
type string	Тип. Варианты: `"auto"` `"onetime"` `"daily"` `"weekly"` `"monthly"`
user string	Пользователь.
target string	Цель. Варианты: `"devdb"` `"remote"` `"adomdb"`
type string	Тип. Варианты: `"cli"` `"tcl"` `"cligrp"` `"tclgrp"` `"jinja"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: Create and run script (For FMG 7.6.5+)
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    fmg_adom: "root"
    script_name: "your_script_name"
    device_name: "your_device_name"
    device_vdom: "root"
    state: "present"
  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 (For FMG 7.6.5+)
      fortinet.fortimanager.fmgr_fmg_script:
        state: "{{ state }}"
        adom: "{{ fmg_adom }}"
        fmg_script:
          name: "{{ script_name }}"
          content: |
            config system global
                set remoteauthtimeout 80
            end
          type: cli
          desc: A script created via Ansible
          target: devdb
    - name: Run the Script
      fortinet.fortimanager.fmgr_dvmdb_script_execute:
        adom: "{{ fmg_adom }}"
        dvmdb_script_execute:
          adom: "{{ fmg_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'

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_fmg_script_module.html