Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_securityconsole_reinstall_package — Переустановка пакета политики, ранее установленного.

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_securityconsole_reinstall_package.

Добавлен в fortinet.fortimanager 2.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_reinstall_package

словарь

Установленные параметры верхнего уровня.

adom

строка

Имя исходного ADOM.

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"

target

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

Цель.

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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Re-install a policy package that had been previously installed.
      fortinet.fortimanager.fmgr_securityconsole_reinstall_package:
        # 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, ...]
        securityconsole_reinstall_package:
          adom: <string>
          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
          target:
            -
              pkg: <string>
              scope:
                -
                  name: <string>
                  vdom: <string>

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

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

Ключ

Описание

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_reinstall_package_module.html

Spec-Zone.ru

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