Spec-Zone.ru › Ansible 2.7

gcp_compute_address – Создаёт адрес GCP

Новая версия 2.6.

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

Обзор

  • Представляет ресурс Address.
  • Каждый виртуальный экземпляр машины имеет временный внутренний IP-адрес и, по желанию, внешний IP-адрес. Для связи между экземплярами в одной сети можно использовать внутренний IP-адрес экземпляра. Для связи с Интернетом и экземплярами за пределами той же сети необходимо указать внешний IP-адрес экземпляра.
  • Внутренние IP-адреса являются временными и принадлежат экземпляру только на время существования экземпляра; если экземпляр удаляется и воссоздаётся, экземпляру назначается новый внутренний IP-адрес, либо системой Compute Engine, либо вами. Внешние IP-адреса могут быть временными или статическими.

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
-
Статический внешний IP-адрес, представленный этим ресурсом. Поддерживается только IPv4. Адрес может быть указан только для типов адресов INTERNAL. IP-адрес должен находиться в указанной подсети, если таковая имеется.
address_type
-
добавлен в 2.7
    Варианты:
  • INTERNAL
  • EXTERNAL ←
Тип адреса для резервирования, либо INTERNAL, либо EXTERNAL.
Если не указано, по умолчанию используется EXTERNAL.
auth_kind
- / обязательно
    Варианты:
  • machineaccount
  • serviceaccount
  • application
Тип используемых учетных данных.
description
-
Необязательное описание этого ресурса.
name
- / обязательно
Имя ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
project
-
По умолчанию:
null
Проект Google Cloud Platform, который необходимо использовать.
region
- / обязательно
URL региона, в котором находится региональный адрес.
Это поле не применимо к глобальным адресам.
scopes
-
Массив используемых областей.
service_account_email
-
Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file
-
Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state
-
    Варианты:
  • present ←
  • absent
Нужно ли данному объекту существовать в GCP
subnetwork
-
добавлен в 2.7
URL подсети, в которой необходимо зарезервировать адрес. Если указан IP-адрес, он должен находиться в диапазоне IP-адресов подсети.
Это поле может быть использовано только с типом INTERNAL для целей GCE_ENDPOINT/DNS_RESOLVER.

Примечания

Примечание

  • Ссылка на API: https://cloud.google.com/compute/docs/reference/beta/addresses
  • Зарезервировать статический внешний IP-адрес: https://cloud.google.com/compute/docs/instances-and-network
  • Зарезервировать статический внутренний IP-адрес: https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address
  • Для проверки подлинности можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • Для проверки подлинности можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • Для проверки подлинности можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
  • Для проверки подлинности можно установить scopes с помощью переменной среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не установлены.
  • Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a address
  gcp_compute_address:
      name: test-address1
      region: us-west1
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

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

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

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

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

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

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

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

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

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

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

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



Статус

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

Авторы

  • 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.7/modules/gcp_compute_address_module.html

Spec-Zone.ru

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