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

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general

Для использования в плейбуке укажите: community.general.gce_labels

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

Обзор

Создание, обновление или удаление меток 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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
credentials_file строка		Путь к JSON-файлу, связанному с электронным адресом учетной записи службы.
labels словарь		Список меток (пар ключ/значение) для добавления или удаления для ресурса.
pem_file строка		Путь к PEM-файлу, связанному с электронным адресом учетной записи службы. Этот параметр устарел и может быть удален в будущих выпусках. Используйте credentials_file вместо него.
project_id строка		Идентификатор проекта Google Cloud Platform для использования.
resource_location строка		Расположение ресурса (global, us-central1-f и т. д.).
resource_name строка		Имя ресурса.
resource_type строка		Тип ресурса (виртуальные машины, диски, снимки, образы).
resource_url строка		«self_link» для ресурса (виртуальная машина, диск, снимок и т. д.).
service_account_email строка		Электронный адрес учетной записи службы.
service_account_permissions список / элементы=строка		Электронный адрес учетной записи службы.
state строка	Варианты: present ← absent	Состояние меток. Допустимы только значения `present` или `absent`.

Примечания

Примечание

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

Примеры

- name: Add labels on an existing instance (using resource_url)
  community.general.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)
  community.general.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
  community.general.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 словарь	Всегда.	Список меток, которые существуют на ресурсе. Пример: [{'environment': 'test', 'environment-name': 'kennedy', 'webserver-frontend': 'homepage'}]
resource_location строка	Всегда.	Расположение ресурса GCE. Пример: us-central1-f
resource_name строка	Всегда.	Имя ресурса GCE. Пример: my-happy-little-instance
resource_type строка	Всегда.	Тип ресурса GCE. Пример: виртуальные машины
resource_url строка	Всегда.	«self_link» ресурса GCE. Пример: https://www.googleapis.com/compute/beta/projects/myproject/zones/us-central1-f/instances/example-instance
state строка	Всегда.	Состояние меток. Пример: present

Авторы

Eric Johnson (@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.10/collections/community/general/gce_labels_module.html