модуль google.cloud.gcp_compute_address_info — сбор информации об адресе GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это значение изменяет только строку User Agent для любых запросов к API. |
filters list / elements=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
region string / обязательный | URL региона, в котором находится региональный адрес. Это поле неприменимо к глобальным адресам. |
scopes list / elements=string | Массив областей доступа для использования |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_address_info_module.html
