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 (не alpha или beta).
Примеры
- 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 словарь | Всегда. | Список меток, существующих на ресурсе. Пример: [{'webserver-frontend': 'homepage', 'environment': 'test', 'environment-name': 'kennedy'}] |
| 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 |
Статус
- Гарантия обратной совместимости этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/gce_labels_module.html