модуль fortinet.fortimanager.fmgr_fmg_device_blueprint — чертёж устройства Fmg

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
fmg_device_blueprint dictionary	Набор параметров верхнего уровня.
auth_template псевдонимы: auth-template any	(список) Шаблон аутентификации.
cliprofs any	(список) Cliprofs.
description string	Описание.
dev_group псевдонимы: dev-group any	(список) Группа устройств.
enforce_device_config псевдонимы: enforce-device-config string	Принудительно применить конфигурацию устройства. Варианты: `"disable"` `"enable"`
folder string	Папка.
ha_config псевдонимы: ha-config string	Конфигурация HA. Варианты: `"disable"` `"enable"`
ha_hbdev псевдонимы: ha-hbdev any	Устройство сердцебиения HA.
ha_monitor псевдонимы: ha-monitor any	(список) Мониторинг HA.
ha_password псевдонимы: ha-password any	(список) Пароль HA.
linked_to_model псевдонимы: linked-to-model string	Связь с моделью. Варианты: `"disable"` `"enable"`
name string / обязательный	Имя.
pkg string	Пакет.
platform string	Платформа.
port_provisioning псевдонимы: port-provisioning integer	Подготовка портов.
prefer_img_ver псевдонимы: prefer-img-ver string	Предпочитаемая версия образа.
prerun_cliprof псевдонимы: prerun-cliprof any	(список) Профиль CLI, выполняемый перед запуском.
prov_type псевдонимы: prov-type string	Тип подготовки. Варианты: `"none"` `"templates"` `"template-group"`
sdwan_management псевдонимы: sdwan-management string	Управление SD-WAN. Варианты: `"disable"` `"enable"`
split_switch_port псевдонимы: split-switch-port string	Разделение порта коммутатора. Варианты: `"disable"` `"enable"`
template_group псевдонимы: template-group string	Группа шаблонов.
templates any	(список) Шаблоны.
vm_log_disk псевдонимы: vm-log-disk string	Диск журнала виртуальной машины. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая 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: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Fmg device blueprint
      fortinet.fortimanager.fmgr_fmg_device_blueprint:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        fmg_device_blueprint:
          name: "your value" # Required variable, string
          # cliprofs: <list or string>
          # description: <string>
          # dev_group: <list or string>
          # folder: <string>
          # pkg: <string>
          # platform: <string>
          # prefer_img_ver: <string>
          # prerun_cliprof: <list or string>
          # prov_type: <value in [none, templates, template-group]>
          # template_group: <string>
          # templates: <list or string>
          # enforce_device_config: <value in [disable, enable]>
          # auth_template: <list or string>
          # ha_config: <value in [disable, enable]>
          # ha_hbdev: <any type>
          # ha_monitor: <list or string>
          # ha_password: <list or string>
          # linked_to_model: <value in [disable, enable]>
          # port_provisioning: <integer>
          # sdwan_management: <value in [disable, enable]>
          # split_switch_port: <value in [disable, enable]>
          # vm_log_disk: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=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_device_blueprint_module.html