Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_securityconsole_install_package модуль – Копирование и установка пакета политики на устройства.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_securityconsole_install_package.

Новая в fortinet.fortimanager 1.0.0

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

логическое значение

Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager. В этом случае модуль продолжит выполнение без валидации параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

логическое значение

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

rc_failed

список / элементы=целое число

Список rc-кодов, при которых выполнение будет прервано.

rc_succeeded

список / элементы=целое число

Список rc-кодов, при которых выполнение будет завершено успешно.

securityconsole_install_package

словарь

Настройка параметров верхнего уровня.

adom

строка

Имя ADOM источника.

adom_rev_comments

строка

Если установлен флаг generate_rev, комментарий к новой ревизии ADOM.

adom_rev_name

строка

Если установлен флаг generate_rev, имя новой ревизии ADOM.

dev_rev_comments

строка

Комментарии к ревизии конфигурации устройства, которая будет сгенерирована во время установки.

flags

список / элементы=строка

cp_all_objs - Назначение всех объектов при глобальном назначении политики.

preview - Генерация только кэша предварительного просмотра.

generate_rev - Генерация новой ревизии ADOM перед установкой.

copy_assigned_pkg - Для глобального назначения политики - копирование назначенного пакета из ADOM на устройство.

unassign - Удаление глобальной политики из ADOM.

ifpolicy_only - Установка только политик интерфейса.

no_ifpolicy - Установка только обычных политик - не установка политик интерфейса.

objs_only - Установка объекта

auto_lock_ws - Автоматическое блокирование и разблокирование рабочей области при выполнении задачи консоли безопасности.

copy_only - Только копирование в базу данных устройства.

Варианты:

  • "none"
  • "cp_all_objs"
  • "preview"
  • "generate_rev"
  • "copy_assigned_pkg"
  • "unassign"
  • "ifpolicy_only"
  • "no_ifpolicy"
  • "objs_only"
  • "auto_lock_ws"
  • "check_pkg_st"
  • "copy_only"

pkg

строка

Путь и имя пакета источника.

scope

список / элементы=словарь

Область.

name

строка

Имя.

vdom

строка

Vdom.

workspace_locking_adom

строка

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

workspace_locking_timeout

целое число

Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем.

По умолчанию: 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

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Copy and install a policy package to devices.
      fortinet.fortimanager.fmgr_securityconsole_install_package:
        bypass_validation: false
        securityconsole_install_package:
          adom: ansible
          adom_rev_comments: ansible-comment
          adom_rev_name: ansible-test
          dev_rev_comments: ansible-comment
          flags:
            - none
            - cp_all_objs
            - preview
            - generate_rev
            - copy_assigned_pkg
            - unassign
            - ifpolicy_only
            - no_ifpolicy
            - objs_only
            - auto_lock_ws
            - check_pkg_st
            - copy_only
          pkg: ansible
          scope:
            - name: Ansible-test
              vdom: root

- name: INSTALL PREVIEW - POLICY PACKAGE
  hosts: fmg
  connection: httpapi
  vars:
    adom: demo
    ppkg: ppkg_hubs
    device: fgt_00_1
  tasks:
    - name: Install for policy package [preview mode] {{ ppkg }}
      fortinet.fortimanager.fmgr_securityconsole_install_package:
        securityconsole_install_package:
          adom: "{{ adom }}"
          flags:
            - preview
          pkg: "{{ ppkg }}"
          scope:
            - name: "{{ device }}"
              vdom: root
      register: r
    - name: Poll the task
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "task_task"
          params:
            task: "{{ r.meta.response_data.task }}"
      register: taskinfo
      until: taskinfo.meta.response_data.percent == 100
      retries: 30
      delay: 5
    - name: Trigger the preview report generation for policy package {{ ppkg }}
      fortinet.fortimanager.fmgr_securityconsole_install_preview:
        securityconsole_install_preview:
          adom: "{{ adom }}"
          device: "{{ device }}"
          flags:
            - json
          vdoms: root
      register: r
    - name: Poll the task
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "task_task"
          params:
            task: "{{ r.meta.response_data.task }}"
      register: taskinfo
      until: taskinfo.meta.response_data.percent == 100
      retries: 30
      delay: 5
    - name: Get the preview report for policy package {{ ppkg }}
      fortinet.fortimanager.fmgr_securityconsole_preview_result:
        securityconsole_preview_result:
          adom: "{{ adom }}"
          device: "{{ device }}"
      register: r
    - name: Cancel install task for policy package {{ ppkg }}
      fortinet.fortimanager.fmgr_securityconsole_package_cancel_install:
        securityconsole_package_cancel_install:
          adom: "{{ adom }}"
    - name: Show preview report
      ansible.builtin.debug:
        msg: "{{ r }}"

Значения возврата

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

Ключ

Описание

meta

словарь

Результат запроса.

Возвращается: всегда

request_url

строка

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

целое число

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

список / элементы=строка

Ответ API.

Возвращается: всегда

response_message

строка

Дескриптивное сообщение ответа API.

Возвращается: всегда

Пример: "OK."

system_information

словарь

Информация о целевой системе.

Возвращается: всегда

rc

целое число

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

список / элементы=строка

Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_securityconsole_install_package_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API