gce_labels — Создание, обновление или удаление меток GCE.

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

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

Обзор

Создание, обновление или удаление меток GCE на виртуальных машинах, дисках, моментальных снимках и т. д. При указании ресурса GCE пользователи могут указать полный URL-адрес ресурса (его «self_link») или отдельные параметры ресурса (тип, расположение, имя). Примеры обоих вариантов можно увидеть в документации. Дополнительную информацию о метках GCE можно найти на странице https://cloud.google.com/compute/docs/label-or-tag-resources. Метки постепенно добавляются к большему количеству ресурсов GCE, поэтому этот модуль необходимо будет обновлять по мере добавления новых ресурсов в API GCE (v1).

Требования

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

python >= 2.6
google-api-python-client >= 1.6.2
google-auth >= 1.0.0
google-auth-httplib2 >= 0.0.2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
labels		Список меток (пар ключ/значение) для добавления или удаления для ресурса.
resource_location		Расположение ресурса (global, us-central1-f и т. д.).
resource_name		Имя ресурса.
resource_type		Тип ресурса (виртуальные машины, диски, моментальные снимки, изображения).
resource_url		«self_link» для ресурса (виртуальная машина, диск, моментальный снимок и т. д.).

Примечания

Примечание

Метки поддерживаются для ресурсов, таких как виртуальные машины, диски, изображения и т. д. Список ресурсов, доступных в API GCE v1 (не альфа или бета версии), можно найти по адресу https://cloud.google.com/compute/docs/labeling-resources.

Примеры

- name: Add labels on an existing instance (using resource_url)
  gce_labels:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    labels:
      webserver-frontend: homepage
      environment: test
      experiment-name: kennedy
    resource_url: https://www.googleapis.com/compute/beta/projects/myproject/zones/us-central1-f/instances/example-instance
    state: present
- name: Add labels on an image (using resource params)
  gce_labels:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    labels:
      webserver-frontend: homepage
      environment: test
      experiment-name: kennedy
    resource_type: images
    resource_location: global
    resource_name: my-custom-image
    state: present
- name: Remove specified labels from the GCE instance
  gce_labels:
    service_account_email: "{{ service_account_email }}"
    credentials_file: "{{ credentials_file }}"
    project_id: "{{ project_id }}"
    labels:
      environment: prod
      experiment-name: kennedy
    resource_url: https://www.googleapis.com/compute/beta/projects/myproject/zones/us-central1-f/instances/example-instance
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
labels dict	Всегда.	Список меток, существующих на ресурсе. Пример: [{'environment': 'test', 'webserver-frontend': 'homepage', 'environment-name': 'kennedy'}]
resource_location str	Всегда.	Расположение ресурса GCE. Пример: us-central1-f
resource_name str	Всегда.	Имя ресурса GCE. Пример: my-happy-little-instance
resource_type str	Всегда.	Тип ресурса GCE. Пример: виртуальные машины
resource_url str	Всегда.	«self_link» ресурса GCE. Пример: https://www.googleapis.com/compute/beta/projects/myproject/zones/us-central1-f/instances/example-instance
state str	Всегда.	Состояние меток. Пример: присутствует

Статус

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

Автор

Эрик Джонсон (@erjohnso) <erjohnso@google.com>

Подсказка

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

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