Spec-Zone.ru › Ansible

google.cloud.gcp_compute_instance модуль – Создаёт виртуальную машину GCP

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

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

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в плейбуке укажите: google.cloud.gcp_compute_instance.

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

Описание

  • Виртуальная машина (ВМ) – это виртуальный сервер, размещённый на инфраструктуре Google.

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип аутентификации accesstoken.

auth_kind

строка / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

can_ip_forward

псевдонимы: ip_forward

булево

Разрешает этому экземпляру отправлять и получать пакеты с несовпадающими IP-адресами назначения или источника. Это необходимо, если вы планируете использовать этот экземпляр для переадресации маршрутов.

Варианты:

  • false
  • true

confidential_instance_config

словарь

Настройка для конфиденциального вычисления (требует установки типа машины любого из типов n2d-* и системного диска типа pd-ssd).

enable_confidential_compute

булево

Включает конфиденциальное вычисление.

Варианты:

  • false
  • true

deletion_protection

булево

Следует ли защищать ресурс от удаления.

Варианты:

  • false
  • true

disks

список / элементы=словарь

Массив дисков, ассоциированных с экземплярами, созданными по этому шаблону.

auto_delete

булево

Указывает, будет ли диск автоматически удален при удалении экземпляра (но не при отделении диска от экземпляра).

Совет: Диски следует установить autoDelete=true, чтобы при удалении машины не остались ненужные диски.

Варианты:

  • false
  • true

boot

булево

Указывает, что это системный диск. Виртуальная машина будет использовать первый раздел диска для своей корневой файловой системы.

Варианты:

  • false
  • true

device_name

строка

Указывает уникальное имя устройства по вашему выбору, которое отражается в дереве /dev/disk/by-id/google-* операционной системы Linux, работающей внутри экземпляра. Это имя можно использовать для ссылки на устройство для монтирования, изменения размера и т. д. внутри экземпляра.

disk_encryption_key

словарь

Шифрует или расшифровывает диск с помощью предоставленного пользователем ключа шифрования.

raw_key

строка

Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64 для шифрования или дешифрования данного ресурса.

rsa_encrypted_key

строка

Указывает закодированный в RFC 4648 base64 ключ шифрования, предоставленный пользователем, обернутый RSA, 2048-бит для шифрования или дешифрования этого ресурса.

index

целое число

Присваивает этому диску индекс, начинающийся с нуля, где 0 зарезервирован для системного диска. Например, если к экземпляру подключено много дисков, каждый диск будет иметь уникальный индекс. Если не указано, сервер выберет подходящее значение.

initialize_params

словарь

Указывает параметры для нового диска, который будет создан вместе с новым экземпляром. Используйте параметры инициализации для создания системных дисков или локальных SSD, подключенных к новому экземпляру.

disk_name

строка

Указывает имя диска. Если не указано, используется имя экземпляра по умолчанию.

disk_size_gb

целое число

Указывает размер диска в гигабайтах (base-2).

disk_type

строка

Ссылка на тип диска.

Указывает тип диска для создания экземпляра.

Если не указано, по умолчанию используется pd-standard.

source_image

псевдонимы: image, image_family

строка

Источник образа для создания этого диска. При создании нового экземпляра требуется initializeParams.sourceImage или disks.source. Для создания диска с использованием одного из общедоступных образов операционных систем укажите образ по его семейному имени.

END_OF_DOCUMENT_MARKER

source_image_encryption_key

словарь

Ключ шифрования исходного образа, предоставленный клиентом. Требуется, если исходный образ защищен ключом шифрования, предоставленным клиентом.

Шаблоны виртуальных машин не хранят ключи шифрования, предоставленные клиентом, поэтому вы не можете создать диски для виртуальных машин в группе управляемых виртуальных машин, если исходные образы зашифрованы собственными ключами.

raw_key

строка

Указывает ключ шифрования, предоставленный клиентом, длиной 256 бит, закодированный в формате RFC 4648 base64 для шифрования или расшифровки этого ресурса.

interface

строка

Указывает интерфейс диска для подключения, который может быть SCSI или NVME. По умолчанию используется SCSI.

Постоянные диски всегда должны использовать SCSI, и запрос завершится ошибкой, если вы попытаетесь подключить постоянный диск в другом формате, кроме SCSI.

Некоторые допустимые значения: «SCSI», «NVME»

mode

строка

Режим подключения диска, READ_WRITE или READ_ONLY. Если не указан, диск подключается в режиме READ_WRITE по умолчанию.

Некоторые допустимые значения: «READ_WRITE», «READ_ONLY»

source

словарь

Ссылка на диск. При создании новой виртуальной машины требуется либо initializeParams.sourceImage, либо disks.source.

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

Это поле представляет ссылку на ресурс Disk в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_compute_disk, а затем установить это поле source в «{{ name-of-resource }}»

type

строка

Указывает тип диска, SCRATCH или PERSISTENT. Если не указан, используется значение PERSISTENT по умолчанию.

Некоторые допустимые значения: «SCRATCH», «PERSISTENT»

env_type

строка

Указывает среду Ansible, в которой выполняется данный модуль.

Это не следует устанавливать, если вы не знаете, что делаете.

Это изменяет только строку User Agent для всех запросов к API.

guest_accelerators

список / элементы=словарь

Список типов и количества ускорителей, подключенных к виртуальной машине.

accelerator_count

целое число

Количество ускорителей, доступных для этой виртуальной машины.

accelerator_type

строка

Полный или частичный URL-адрес ресурса типа ускорителя, который необходимо предоставить этой виртуальной машине.

hostname

строка

Имя хоста виртуальной машины. Указанное имя хоста должно соответствовать RFC1035. Если имя хоста не указано, по умолчанию используется [INSTANCE_NAME].c.[PROJECT_ID].internal при использовании глобального DNS и [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal при использовании зонального DNS.

labels

словарь

Метки, которые необходимо применить к этой виртуальной машине. Список пар ключ-значение.

machine_type

строка

Ссылка на тип виртуальной машины, определяющий тип виртуальной машины.

metadata

словарь

Ключи и значения метаданных, которые необходимо назначить виртуальным машинам, созданным из этого шаблона. Эти пары могут содержать пользовательские метаданные или предопределенные ключи.

min_cpu_platform

строка

Указывает минимальную платформу процессора для виртуальной машины. Допустимые значения — это удобочитаемые имена платформ процессоров.

name

строка

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

network_interfaces

список / элементы=словарь

Массив конфигураций для этого интерфейса. Это определяет, как этот интерфейс взаимодействует с другими сетевыми службами, например, подключением к интернету. Поддерживается только один сетевой интерфейс на виртуальную машину.

access_configs

список / элементы=словарь

Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа ONE_TO_ONE_NAT. Если accessConfigs не указаны, у этой виртуальной машины не будет внешнего доступа к интернету.

name

строка / обязательно

Имя этой конфигурации доступа. Рекомендуемое имя — External NAT, но вы можете использовать любое произвольное имя. Например, Мой внешний IP-адрес или Сетевой доступ.

nat_ip

словарь

Ссылка на адрес.

Внешний IP-адрес, связанный с этим экземпляром.

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

Это поле представляет собой ссылку на ресурс Address в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «address» и значением адреса вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_address и затем установить это поле nat_ip на «{{ имя-ресурса }}»

network_tier

строка

Это обозначает сетевой уровень, используемый для настройки этой конфигурации доступа. Если AccessConfig указан без действительного внешнего IP-адреса, будет создан временный IP с этим networkTier. Если AccessConfig с действительным внешним IP-адресом указан, он должен совпадать с networkTier, связанным с ресурсом Address, владеющим этим IP.

Некоторые допустимые значения включают: «PREMIUM», «STANDARD»

public_ptr_domain_name

строка

Имя домена DNS для публичной записи PTR. Вы можете установить это поле только если включено поле setPublicPtr.

set_public_ptr

булево

Указывает, следует ли создавать публичную запись DNS PTR для сопоставления внешнего IP-адреса экземпляра с именем домена DNS.

Варианты:

  • false
  • true

type

строка / обязательно

Тип конфигурации. По умолчанию и единственный вариант — ONE_TO_ONE_NAT.

Некоторые допустимые значения включают: «ONE_TO_ONE_NAT»

alias_ip_ranges

список / элементы=словарь

Массив диапазонов IP-адресов для этого сетевого интерфейса. Может быть указан только для сетевых интерфейсов в сетях subnet-mode.

ip_cidr_range

строка

Диапазон IP CIDR, представленный этим диапазоном IP-адресов.

Этот диапазон IP CIDR должен принадлежать указанной подсети и не должен содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Этот диапазон может быть одним IP-адресом (например, 10.2.3.4), маской сети (например, /24) или строкой в формате CIDR (например, 10.1.2.0/24).

subnetwork_range_name

строка

Необязательное имя вторичного диапазона подсети, указывающее вторичный диапазон, из которого нужно выделить диапазон IP CIDR для этого диапазона IP-адресов. Если не указано, будет использован первичный диапазон подсети.

network

словарь

Указывает заголовок существующей сети. Если заголовок сети не установлен, будет выбран сетевой интерфейс по умолчанию, который может иметь уже настроенный SSH.

Это поле представляет собой ссылку на ресурс Network в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_network и затем установить это поле network на «{{ имя-ресурса }}»

network_ip

строка

Внутренний IPv4-адрес сети, который нужно назначить экземпляру для этого сетевого интерфейса. Если пользователь его не укажет, система назначит неиспользуемый внутренний IP-адрес.

subnetwork

словарь

Ссылка на виртуальную сеть VPC.

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

Это поле представляет собой ссылку на ресурс Subnetwork в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_subnetwork и затем установить это поле subnetwork на «{{ имя-ресурса }}»

project

строка

Проект Google Cloud Platform, который следует использовать.

scheduling

словарь

Устанавливает параметры планирования для этого экземпляра.

automatic_restart

булево

Указывает, должен ли экземпляр автоматически перезапускаться, если он был завершен Compute Engine (не пользователем).

Вы можете установить параметр автоматического перезапуска только для стандартных экземпляров. Для предварительно выделенных экземпляров автоматический перезапуск невозможен.

Варианты:

  • false
  • true

on_host_maintenance

строка

Определяет поведение при обслуживании хоста для этого экземпляра. Для стандартных экземпляров поведение по умолчанию — MIGRATE. Для предварительно выделенных экземпляров поведение по умолчанию и единственно возможное — TERMINATE.

Дополнительную информацию см. в разделе Настройка параметров планирования экземпляров.

preemptible

булево

Определяет, является ли экземпляр предварительно выделенным. Это можно установить только при создании экземпляра, изменить после создания экземпляра нельзя.

Варианты:

  • false
  • true

scopes

список / элементы=строка

Массив используемых областей

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы, представленное либо в виде словаря, либо как строка JSON.

service_account_email

string

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

service_account_file

path

Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран в качестве типа.

service_accounts

list / elements=dictionary

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

email

string

Адрес электронной почты учетной записи службы.

scopes

list / elements=string

Список областей действия, которые будут доступны для этой учетной записи службы.

shielded_instance_config

dictionary

Настройка различных параметров, связанных с защищенными виртуальными машинами.

enable_integrity_monitoring

boolean

Определяет, включен ли мониторинг целостности для экземпляра.

Варианты:

  • false
  • true

enable_secure_boot

boolean

Определяет, включен ли Secure Boot для экземпляра.

Варианты:

  • false
  • true

enable_vtpm

boolean

Определяет, включен ли vTPM для экземпляра.

Варианты:

  • false
  • true

state

string

Указывает, должен ли объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

status

string

Статус экземпляра. Одно из следующих значений: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, и TERMINATED.

Для пользователей используйте RUNNING, чтобы поддерживать машину «включенной», и TERMINATED, чтобы выключить машину.

Некоторые допустимые значения: «PROVISIONING», «STAGING», «RUNNING», «STOPPING», «SUSPENDING», «SUSPENDED», «TERMINATED»

tags

dictionary

Список тегов для применения к этому экземпляру. Теги используются для определения допустимых источников или целевых адресов для брандмауэров сети и указываются клиентом при создании экземпляра. Теги могут быть изменены позже методом setTags. Каждый тег в списке должен соответствовать RFC1035.

fingerprint

string

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

Отпечаток изначально генерируется Compute Engine и меняется после каждого запроса на изменение или обновление метаданных. Вы всегда должны предоставлять актуальный хеш отпечатка для обновления или изменения метаданных.

items

list / elements=string

Массив тегов. Каждый тег должен иметь длину от 1 до 63 символов и соответствовать RFC1035.

zone

string / обязательно

Ссылка на зону, где находится виртуальная машина.

Примеры

- name: create a disk
  google.cloud.gcp_compute_disk:
    name: disk-instance
    size_gb: 50
    source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: disk

- name: create a network
  google.cloud.gcp_compute_network:
    name: network-instance
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a address
  google.cloud.gcp_compute_address:
    name: address-instance
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a instance
  google.cloud.gcp_compute_instance:
    name: test_object
    machine_type: n1-standard-1
    disks:
    - auto_delete: 'true'
      boot: 'true'
      source: "{{ disk }}"
    - auto_delete: 'true'
      interface: NVME
      type: SCRATCH
      initialize_params:
        disk_type: local-ssd
    metadata:
      startup-script-url: gs:://graphite-playground/bootstrap.sh
      cost-center: '12345'
    labels:
      environment: production
    network_interfaces:
    - network: "{{ network }}"
      access_configs:
      - name: External NAT
        nat_ip: "{{ address }}"
        type: ONE_TO_ONE_NAT
    zone: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

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

Ключ

Описание

canIpForward

boolean

Разрешает этому экземпляру отправлять и получать пакеты с несоответствующими IP-адресами назначения или источника. Это необходимо, если вы планируете использовать этот экземпляр для переадресации маршрутов.

Возвращается: success

confidentialInstanceConfig

complex

Настройка для конфиденциального вычисления (требует установки типа машины на любой из типов n2d-* и системного диска типа pd-ssd).

Возвращается: success

enableConfidentialCompute

boolean

Включает конфиденциальное вычисление.

Возвращается: success

cpuPlatform

string

Платформа процессора, используемая этим экземпляром.

Возвращается: success

creationTimestamp

string

Дата и время создания в формате RFC3339.

Возвращается: success

deletionProtection

boolean

Защищает ли ресурс от удаления.

Возвращается: success

disks

complex

Массив дисков, связанных с экземплярами, созданными по этому шаблону.

Возвращается: success

autoDelete

boolean

Указывает, будет ли диск автоматически удален при удалении экземпляра (но не при отсоединении диска от экземпляра).

Совет: Диски должны быть настроены autoDelete=true, чтобы не оставлять лишних дисков при удалении машины.

Возвращается: success

boot

boolean

Указывает, что это системный диск. Виртуальная машина будет использовать первый раздел диска для своей корневой файловой системы.

Возвращается: success

deviceName

string

Указывает уникальное имя устройства по вашему выбору, которое отражается в дереве /dev/disk/by-id/google-* операционной системы Linux, работающей внутри экземпляра. Это имя можно использовать для ссылки на устройство для монтирования, изменения размера и т. д. внутри экземпляра.

Возвращается: success

diskEncryptionKey

complex

Шифрует или расшифровывает диск с помощью предоставленного пользователем ключа шифрования.

Возвращается: success

rawKey

string

Указывает 256-битный ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64, для шифрования или расшифрования этого ресурса.

Возвращается: success

rsaEncryptedKey

string

Указывает ключ шифрования, предоставленный пользователем, закодированный в RFC 4648 base64, защищённый RSA с 2048 битами, для шифрования или расшифрования этого ресурса.

Возвращается: success

sha256

string

Хеш SHA-256 ключа шифрования, предоставленного пользователем, закодированный в RFC 4648 base64, который защищает этот ресурс.

Возвращается: success

index

integer

Присваивает этому диску индекс от нуля, где 0 зарезервирован для системного диска. Например, если к экземпляру подключено много дисков, каждый диск будет иметь свой уникальный индекс. Если не указано, сервер выберет подходящее значение.

Возвращается: success

initializeParams

complex

Указывает параметры для нового диска, который будет создан вместе с новым экземпляром. Используйте параметры инициализации для создания системных дисков или локальных SSD, подключенных к новому экземпляру.

Возвращается: success

diskName

string

Указывает имя диска. Если не указано, по умолчанию используется имя экземпляра.

Возвращается: success

diskSizeGb

integer

Указывает размер диска в ГБ (в двоичной системе).

Возвращается: success

diskType

string

Ссылка на тип диска.

Указывает тип диска для создания экземпляра.

Если не указано, по умолчанию используется pd-standard.

Возвращается: success

sourceImage

string

Изображение источника для создания этого диска. При создании нового экземпляра требуется один из параметров initializeParams.sourceImage или disks.source. Для создания диска с одним из общедоступных образов операционной системы укажите имя семейства образа.

Возвращается: success

sourceImageEncryptionKey

complex

Ключ шифрования источника образа, предоставленный клиентом. Требуется, если образ источника защищен ключом шифрования, предоставленным клиентом.

В шаблонах экземпляров ключи шифрования, предоставленные клиентом, не хранятся, поэтому вы не можете создать диски для экземпляров в управляемой группе экземпляров, если образы-источники зашифрованы с помощью ваших собственных ключей.

Возвращается: success

rawKey

string

Указывает 256-битный ключ шифрования, предоставленный клиентом, закодированный в формате RFC 4648 base64 для шифрования или дешифрования этого ресурса.

Возвращается: success

sha256

string

Закодированный в формате RFC 4648 base64 хеш SHA-256 ключа шифрования, предоставленного клиентом, который защищает этот ресурс.

Возвращается: success

interface

string

Указывает интерфейс диска для подключения, который может быть SCSI или NVME. По умолчанию используется SCSI.

Постоянные диски всегда должны использовать SCSI, и запрос завершится ошибкой, если вы попытаетесь подключить постоянный диск в формате, отличном от SCSI.

Возвращается: success

mode

string

Режим подключения диска: READ_WRITE или READ_ONLY. Если не указано, диск подключается в режиме READ_WRITE.

Возвращается: success

source

dictionary

Ссылка на диск. При создании нового экземпляра требуется один из параметров initializeParams.sourceImage или disks.source.

При необходимости вы также можете подключить существующие некорневые постоянные диски с помощью этого свойства. Это поле применимо только к постоянным дискам.

Возвращается: success

type

string

Указывает тип диска: SCRATCH или PERSISTENT. По умолчанию используется PERSISTENT.

Возвращается: success

guestAccelerators

complex

Список типов и количества адаптеров ускорения, подключенных к экземпляру.

Возвращается: success

acceleratorCount

integer

Количество адаптеров ускорения, доступных данному экземпляру.

Возвращается: success

acceleratorType

string

Полный или частичный URL-адрес ресурса типа ускорителя, предоставляемого данному экземпляру.

Возвращается: success

hostname

string

Имя хоста экземпляра, подлежащего созданию. Указанное имя хоста должно соответствовать RFC1035. Если имя хоста не указано, по умолчанию используется [INSTANCE_NAME].c.[PROJECT_ID].internal при использовании глобального DNS и [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal при использовании зонального DNS.

Возвращается: success

id

integer

Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.

Возвращается: success

labelFingerprint

string

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

Возвращается: success

labels

dictionary

Метки для применения к этому экземпляру. Список пар ключ-значение.

Возвращается: success

machineType

string

Ссылка на тип машины, определяющий тип виртуальной машины. Список допустимых типов машин см. на странице https://cloud.google.com/compute/docs/machine-types.

Возвращается: success

metadata

dictionary

Ключи/значения метаданных для назначения экземплярам, созданным из этого шаблона. Эти пары могут состоять из пользовательских метаданных или предопределенных ключей.

Возвращается: success

minCpuPlatform

string

Указывает минимальную платформу процессора для виртуальной машины. Допустимые значения — имена платформ процессоров.

Возвращается: success

name

string

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

Возвращается: success

networkInterfaces

complex

Массив конфигураций для этого интерфейса. Это указывает, как этот интерфейс настроен для взаимодействия с другими сетевыми службами, например, для подключения к Интернету. Поддерживается только один сетевой интерфейс на экземпляр.

Возвращается: success

accessConfigs

complex

Массив конфигураций для этого интерфейса. В настоящее время поддерживается только одна конфигурация доступа, ONE_TO_ONE_NAT. Если конфигурации accessConfigs не указаны, этот экземпляр не будет иметь доступа к внешнему Интернету.

Возвращается: success

name

string

Имя этой конфигурации доступа. Имя по умолчанию и рекомендуемое имя - External NAT, но вы можете использовать любую произвольную строку. Например, My external IP или Network Access.

Возвращается: success

natIP

dictionary

Ссылка на адрес.

Внешний IP-адрес, связанный с этим экземпляром.

Укажите неиспользуемый статический внешний IP-адрес, доступный для проекта, или оставьте это поле неопределенным, чтобы использовать IP-адрес из общего пула эфемерных IP-адресов. Если вы указываете статический внешний IP-адрес, он должен находиться в том же регионе, что и зона экземпляра.

Возвращается: success

networkTier

string

Это обозначает уровень сети, используемый для настройки этой конфигурации доступа. Если AccessConfig указан без допустимого внешнего IP-адреса, будет создан эфемерный IP-адрес с этим networkTier. Если указан AccessConfig с допустимым внешним IP-адресом, он должен соответствовать networkTier, связанному с ресурсом Address, владеющим этим IP-адресом.

Возвращается: success

publicPtrDomainName

string

Доменное имя DNS для общедоступной записи PTR. Вы можете установить это поле только в том случае, если поле setPublicPtr включено.

Возвращается: success

setPublicPtr

boolean

Указывает, следует ли создавать общедоступную запись DNS PTR для сопоставления внешнего IP-адреса экземпляра с доменным именем DNS.

Возвращается: success

type

string

Тип конфигурации. Единственный вариант по умолчанию - ONE_TO_ONE_NAT.

Возвращается: success

aliasIpRanges

complex

Массив диапазонов алиасов IP-адресов для этого сетевого интерфейса. Может быть указан только для сетевых интерфейсов в сетях в режиме подсети.

Возвращается: success

ipCidrRange

string

Диапазон IP CIDR, представленный этим диапазоном алиасов IP-адресов.

Этот диапазон IP CIDR должен принадлежать указанной подсети и не может содержать IP-адреса, зарезервированные системой или используемые другими сетевыми интерфейсами. Этот диапазон может быть одним IP-адресом (например, 10.2.3.4), маской сети (например, /24) или строкой в формате CIDR (например, 10.1.2.0/24).

Возвращается: success

subnetworkRangeName

string

Необязательное имя вторичного диапазона подсети, указывающее вторичный диапазон, из которого следует выделять диапазон IP CIDR для этого диапазона алиасов IP-адресов. Если не указано, будет использоваться основной диапазон подсети.

Возвращается: success

name

string

Имя сетевого интерфейса, генерируемое сервером. Для сетевых устройств это eth0, eth1 и т. д.

Возвращается: success

network

dictionary

Указывает название существующей сети. Если не указать название сети, будет выбран сетевой интерфейс по умолчанию, для которого SSH уже может быть настроен.

Возвращается: success

networkIP

string

Внутренний сетевой адрес IPv4 для назначения экземпляру для этого сетевого интерфейса. Если не указан пользователем, система назначает неиспользуемый внутренний IP-адрес.

Возвращается: success

subnetwork

dictionary

Ссылка на сеть VPC.

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

Возвращается: success

расписание

сложный

Устанавливает параметры планирования для этого экземпляра.

Возвращаемое значение: успех

automaticRestart

логическое

Указывает, следует ли автоматически перезапускать экземпляр, если он был завершен Compute Engine (а не пользователем).

Вы можете задать параметр автоматического перезапуска только для стандартных экземпляров. Для предварительно выделенных экземпляров автоматический перезапуск невозможен.

Возвращаемое значение: успех

onHostMaintenance

строка

Определяет поведение при обслуживании узла для данного экземпляра. Для стандартных экземпляров поведение по умолчанию — MIGRATE. Для предварительно выделенных экземпляров поведение по умолчанию и единственное возможное — TERMINATE.

Дополнительную информацию см. в разделе Установка параметров планирования экземпляров.

Возвращаемое значение: успех

preemptible

логическое

Определяет, является ли экземпляр предварительно выделенным. Это значение можно задать только при создании экземпляра, изменить его после создания экземпляра нельзя.

Возвращаемое значение: успех

serviceAccounts

сложный

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

Возвращаемое значение: успех

email

строка

Электронный адрес учетной записи службы.

Возвращаемое значение: успех

scopes

список / элементы=строка

Список областей действия, которые должны быть доступны для этой учетной записи службы.

Возвращаемое значение: успех

shieldedInstanceConfig

сложный

Настройка различных параметров, связанных с защищёнными экземплярами.

Возвращаемое значение: успех

enableIntegrityMonitoring

логическое

Указывает, включено ли мониторинг целостности для экземпляра.

Возвращаемое значение: успех

enableSecureBoot

логическое

Указывает, включен ли Secure Boot для экземпляра.

Возвращаемое значение: успех

enableVtpm

логическое

Указывает, включён ли vTPM для экземпляра.

Возвращаемое значение: успех

состояние

строка

Состояние экземпляра. Одно из следующих значений: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED и TERMINATED.

В качестве пользователя используйте RUNNING, чтобы машина оставалась «включённой», и TERMINATED, чтобы выключить машину.

Возвращаемое значение: успех

statusMessage

строка

Необязательное понятное для человека объяснение состояния.

Возвращаемое значение: успех

теги

сложный

Список тегов для применения к этому экземпляру. Теги используются для идентификации допустимых источников или целей для сетевых брандмауэров и задаются клиентом при создании экземпляра. Теги можно позже изменить с помощью метода setTags. Каждый тег в списке должен соответствовать RFC1035.

Возвращаемое значение: успех

отпечаток

строка

Указывает отпечаток для этого запроса, который по существу является хешем содержимого метаданных и используется для оптимистической блокировки.

Отпечаток первоначально генерируется Compute Engine и изменяется после каждого запроса на изменение или обновление метаданных. Для обновления или изменения метаданных необходимо всегда указывать актуальный хэш отпечатка.

Возвращаемое значение: успех

элементы

список / элементы=строка

Массив тегов. Каждый тег должен иметь длину от 1 до 63 символов и соответствовать RFC1035.

Возвращаемое значение: успех

зона

строка

Ссылка на зону, в которой находится машина.

Возвращаемое значение: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекции

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

© 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_instance_module.html

Spec-Zone.ru

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