Модуль fortinet.fortios.fortios_system_cloud_service — настройка облачной службы системы в Fortinet FortiOS и FortiGate.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_cloud_service.

Добавлено в fortinet.fortios 2.0.0

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

Обзор

Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), задавая и изменяя параметры функции system и категории cloud_service. Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются косой чертой. Параметр с пометкой member_path поддерживает операции с элементами.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_cloud_service dictionary	Настройка облачной службы системы.
gck_access_token_lifetime integer	Срок действия автоматически созданных токенов доступа в минутах.
gck_keyid string	Идентификатор ключа, также называемый «kid».
gck_private_key string	Закрытый ключ учетной записи службы в формате PEM (например, “-----BEGIN PRIVATE KEY-----\…”).
gck_service_account string	Учетная запись службы (например, “account-id@sampledomain.com”).
name string / обязательный	Имя.
traffic_vdom string	VDOM, используемый для связи с облачной службой. Источник: system.vdom.name.
vendor string	Поставщик облачной службы. Варианты: `"unknown"` `"google-cloud-kms"`
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревшая библиотека fortiosapi больше не рекомендуется; для запуска плейбуков предпочтительно использовать httpapi.

Примеры

- name: Configure system cloud service.
  fortinet.fortios.fortios_system_cloud_service:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_cloud_service:
          gck_access_token_lifetime: "60"
          gck_keyid: "<your_own_value>"
          gck_private_key: "<your_own_value>"
          gck_service_account: "<your_own_value>"
          name: "default_name_7"
          traffic_vdom: "<your_own_value> (source system.vdom.name)"
          vendor: "unknown"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращенный FortiGate при последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

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

© 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/fortios/fortios_system_cloud_service_module.html