Модуль fortinet.fortimanager.fmgr_system_sdnconnector_gcpprojectlist – настройка списка проектов GCP.

Примечание

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

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

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

Чтобы использовать коллекцию в playbook, укажите: fortinet.fortimanager.fmgr_system_sdnconnector_gcpprojectlist.

Добавлено в 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`
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	Примечание об изменении, которое можно указать при создании или обновлении объекта.
sdn-connector string	Устарел, используйте “sdn_connector”.
sdn_connector string	Параметр (sdn-connector) в запрошенном URL.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
system_sdnconnector_gcpprojectlist dictionary	Набор параметров верхнего уровня.
gcp_zone_list псевдонимы: gcp-zone-list any	(список) Настройка списка зон GCP.
id string / обязательный	Идентификатор проекта GCP.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме workspace. Значением может быть global или другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания (в секундах) освобождения блокировки workspace другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются по соглашению с использованием подчёркивания (snake_case). Измените аргументы, например “var-name” на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; параметры верхнего уровня 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: Configure GCP project list.
      fortinet.fortimanager.fmgr_system_sdnconnector_gcpprojectlist:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        sdn_connector: <your own value>
        state: present # <value in [present, absent]>
        system_sdnconnector_gcpprojectlist:
          id: "your value" # Required variable, string
          # gcp_zone_list: <list or string>

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

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

Ключ	Описание
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	Предупреждение о том, что используемые в playbook параметры не поддерживаются текущей версией 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_system_sdnconnector_gcpprojectlist_module.html