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
Параметры
| параметр | обязательно | значение по умолчанию | варианты | примечания |
|---|---|---|---|---|
| метки | нет | Список меток (пар ключ/значение) для добавления или удаления для ресурса. | ||
| resource_location | нет | Расположение ресурса (global, us-central1-f и т. д.) | ||
| resource_name | нет | Имя ресурса. | ||
| resource_type | нет | Тип ресурса (экземпляры, диски, моментальные снимки, изображения) | ||
| resource_url | нет | «self_link» ресурса (экземпляр, диск, моментальный снимок и т. д.) |
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| метки | Список меток, существующих на ресурсе. | Всегда. | словарь | [{'environment': 'test', 'webserver-frontend': 'homepage', '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 |
| состояние | состояние меток | Всегда. | строка | наличие |
Примечания
Примечание
- Метки поддерживают ресурсы, такие как экземпляры, диски, изображения и т. д. Список доступных ресурсов в API GCE v1 см. в документе https://cloud.google.com/compute/docs/labeling-resources (не альфа- или бета-версии).
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется как обратный.
Для получения помощи в разработке модулей, если вы это сделаете, обратитесь к документам Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/gce_labels_module.html