Модуль google.cloud.gcp_compute_address_info — Сбор информации о GCP-адресе
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Для использования в книге задач укажите: google.cloud.gcp_compute_address_info.
Описание
- Сбор информации о GCP-адресе
Требования
Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип аутентификации accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это лишь изменяет строку User Agent для всех запросов API. |
filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform для использования. |
region строка / обязательно | URL региона, где находится региональный адрес. Это поле не применимо к глобальным адресам. |
scopes список / элементы=строка | Массив используемых областей |
service_account_contents jsonarg | Содержание файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, представляющей его. |
service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран тип machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on an address
gcp_compute_address_info:
region: us-west1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
address string |
Статический внешний IP-адрес, представляемый этим ресурсом. Поддерживается только IPv4. Адрес может быть указан только для типов адресов INTERNAL. IP-адрес должен находиться внутри указанной подсети, если таковая имеется. Возвращается: успех |
|
addressType string |
Тип адреса для резервирования. Возвращается: успех |
|
creationTimestamp string |
Метка времени создания в текстовом формате RFC3339. Возвращается: успех |
|
description string |
Необязательное описание этого ресурса. Возвращается: успех |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: успех |
|
name string |
Имя ресурса. Имя должно состоять из 1-63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается: успех |
|
network dictionary |
URL сети, в которой необходимо зарезервировать адрес. Это поле может использоваться только с типом INTERNAL с целями VPC_PEERING и IPSEC_INTERCONNECT. Возвращается: успех |
|
networkTier string |
Уровень сети, используемый для настройки этого адреса. Если это поле не указано, предполагается, что оно равно PREMIUM. Возвращается: успех |
|
prefixLength integer |
Длина префикса, если ресурс представляет диапазон IP-адресов. Возвращается: успех |
|
purpose string |
Цель этого ресурса, которая может быть одним из следующих значений: * GCE_ENDPOINT для адресов, используемых экземплярами виртуальных машин, диапазонами псевдонимов IP-адресов, внутренними балансировщиками нагрузки и аналогичными ресурсами. * SHARED_LOADBALANCER_VIP для адреса, который может использоваться несколькими внутренними балансировщиками нагрузки. * VPC_PEERING для адресов, зарезервированных для виртуальных сетей VPC. * IPSEC_INTERCONNECT для адресов, созданных из частного диапазона IP-адресов, которые зарезервированы для подключения VLAN в конфигурации Cloud Interconnect с шифрованием IPsec. Эти адреса являются региональными ресурсами. Это должно быть установлено только при использовании внутреннего адреса. Возвращается: успех |
|
region string |
URL региона, где находится региональный адрес. Это поле не применимо к глобальным адресам. Возвращается: успех |
|
status string |
Статус адреса, который может быть одним из RESERVING, RESERVED или IN_USE. Адрес, который находится в состоянии RESERVING, в настоящее время находится в процессе резервирования. Зарезервированный адрес (RESERVED) в настоящее время зарезервирован и доступен для использования. Адрес IN_USE в настоящее время используется другим ресурсом и недоступен. Возвращается: успех |
|
subnetwork dictionary |
URL подсети, в которой необходимо зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети. Это поле может использоваться только с типом INTERNAL с целями GCE_ENDPOINT/DNS_RESOLVER. Возвращается: успех |
|
users list / elements=string |
URL-адреса ресурсов, использующих этот адрес. Возвращается: успех |
Ссылки на коллекцию
© 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/google/cloud/gcp_compute_address_info_module.html