Spec-Zone.ru › Ansible 2.9

gcp_compute_address_info – Сбор информации об адресе GCP

Новое в версии 2.7.

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

Обзор

  • Сбор информации об адресе GCP
  • Этот модуль назывался gcp_compute_address_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_compute_address_facts

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
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, используя переменную окружения c(gcp_service_account_file).
  • для аутентификации можно установить service_account_contents, используя переменную окружения c(GCP_SERVICE_ACCOUNT_CONTENTS).
  • для аутентификации можно установить service_account_email, используя переменную окружения GCP_SERVICE_ACCOUNT_EMAIL.
  • для аутентификации можно установить 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
сложное
всегда
Список ресурсов

address
строка
успех
Статический внешний IP-адрес, представленный этим ресурсом. Поддерживается только IPv4. Для адресов типа INTERNAL адрес может быть указан только для адресов типа INTERNAL. IP-адрес должен находиться в указанном подсети, если таковая имеется.

addressType
строка
успех
Тип адреса для резервирования, либо INTERNAL, либо EXTERNAL.
Если не указан, по умолчанию используется EXTERNAL.

creationTimestamp
строка
успех
Дата создания в формате RFC3339.

description
строка
успех
Необязательное описание этого ресурса.

id
целое число
успех
Уникальный идентификатор ресурса.

name
строка
успех
Имя ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

networkTier
строка
успех
Используемый уровень сети для настройки этого адреса. Это поле может принимать следующие значения: PREMIUM или STANDARD. Если это поле не указано, предполагается PREMIUM.

region
строка
успех
URL региона, в котором находится региональный адрес.
Для глобальных адресов это поле не применяется.

subnetwork
словарь
успех
URL подсети, в которой нужно зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети.
Это поле может быть использовано только с типом INTERNAL для целей GCE_ENDPOINT/DNS_RESOLVER.

users
список
успех
URL ресурсов, использующих этот адрес.



Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [предварительная версия]
  • Этот модуль содержится в сообществе Ansible. [сообщество]

Авторы

  • Google Inc. (@googlecloudplatform)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_address_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API