os_server_metadata - Добавление/обновление/удаление метаданных в вычислительных экземплярах из OpenStack
Новая версия с 2.6.
Описание
- Добавление, обновление или удаление метаданных в вычислительных экземплярах из OpenStack.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должен ожидать уровень сокета перед истечением времени ожидания для вызовов API. Если это значение опущено, ничего не будет передано в библиотеку запросов. | |
| auth | Словарь, содержащий информацию об аутентификации, необходимую стратегии плагина аутентификации облака. Для стандартного плагина password в него войдут auth_url, username, password, project_name и любая информация о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина аутентификации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type | Имя плагина аутентификации для использования. Если облако использует что-то помимо аутентификации по паролю, имя плагина следует указать здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Зона доступности, в которой необходимо создать моментальный снимок. | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. | |
| cert | Путь к клиентскому сертификату для использования в рамках транзакции SSL. | |
| cloud | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml. | |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога сервисов. Псевдонимы: endpoint_type |
| key | Путь к клиентскому ключу для использования в рамках транзакции SSL. | |
| meta обязательно | Список пар ключ-значение, которые должны быть предоставлены в качестве метаданных экземпляру, или строка, содержащая список пар ключ-значение. Пример: meta: "key1=value1,key2=value2" | |
| region_name | Имя региона. | |
| server обязательно | Имя экземпляра для обновления метаданных. Псевдонимы: name | |
| state |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| verify bool |
| Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs |
| wait bool |
| Ansible должен ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Могут использоваться стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об аутентификации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в задачах. Более подробная информация доступна по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# Creates or updates hostname=test1 as metadata of the server instance vm1
- name: add metadata to compute instance
hosts: localhost
tasks:
- name: add metadata to instance
os_server_metadata:
state: present
auth:
auth_url: https://openstack-api.example.com:35357/v2.0/
username: admin
password: admin
project_name: admin
name: vm1
meta:
hostname: test1
group: group1
# Removes the keys under meta from the instance named vm1
- name: delete metadata from compute instance
hosts: localhost
tasks:
- name: delete metadata from instance
os_server_metadata:
state: absent
auth:
auth_url: https://openstack-api.example.com:35357/v2.0/
username: admin
password: admin
project_name: admin
name: vm1
meta:
hostname:
group:
Возвращаемые значения
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| metadata dict | успешно | Метаданные вычислительного экземпляра после изменения. Пример: {'key1': 'value1', 'key2': 'value2'} |
| server_id строка | успешно | Идентификатор вычислительного экземпляра, где были внесены изменения. Пример: 324c4e91-3e03-4f62-9a4d-06119a8a8d16 |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в Руководстве по поддержке модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- Mario Santos (@ruizink)
Подсказка
Если вы обнаружите проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/os_server_metadata_module.html
