Модуль fortinet.fortios.fortios_system_auto_script — Настройка автоскрипта в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: fortinet.fortios.fortios_system_auto_script.
Новое в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные функции и категорию автоскриптов. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано из GUI Fortigate. |
enable_log логический | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов несколько. Параметр, помеченный member_path, допустим для выполнения операций с членом. |
member_state строка | Добавление или удаление члена по указанному пути атрибута. Если member_state указан, параметр state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
system_auto_script словарь | Настройка автоскрипта. |
|
interval целое число |
Интервал повторения в секундах. |
|
name строка / обязательно |
Имя автоскрипта. |
|
output_size целое число |
Количество мегабайтов для ограничения вывода скрипта (10 - 1024). |
|
repeat целое число |
Количество повторений этого скрипта (0 = бесконечно). |
|
script строка |
Список команд FortiOS CLI для повторения. |
|
start строка |
Режим запуска скрипта. Варианты:
|
|
timeout целое число |
Максимальное время выполнения этого скрипта в секундах (0 = без таймаута). |
vdom строка | Виртуальная область (vdom), определённая ранее. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль legacy fortiosapi устарел, httpapi — предпочтительный способ запуска книг задач.
- Модуль поддерживает режим check_mode.
Примеры
- name: Configure auto script.
fortinet.fortios.fortios_system_auto_script:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_auto_script:
interval: "0"
name: "default_name_4"
output_size: "10"
repeat: "1"
script: "<your_own_value>"
start: "manual"
timeout: "0"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для подготовки содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, полученный от FortiGate при последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем запросе к FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для обработки запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для обработки запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_system_auto_script_module.html