openstack.cloud.os_server_metadata – Добавление/обновление/удаление метаданных в вычислительных экземплярах из OpenStack
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook, укажите: openstack.cloud.os_server_metadata.
Обзор
- Добавление, обновление или удаление метаданных в вычислительных экземплярах из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться данный модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ждать сокетное соединение перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, ничего не будет передано в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password, он будет содержать auth_url, username, password, project_name и любую информацию о доменных именах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не требуется, если задан параметр cloud или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации, который необходимо использовать. Если облако использует что-то кроме парольной авторизации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом. | |
| availability_zone строка | Зона доступности для создания моментальной копии. | |
| ca_cert строка | Путь к пакету сертификатов CA, который может быть использован для проверки SSL API-запросов. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату, который будет использоваться в рамках SSL-транзакции. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента, который будет использоваться в рамках SSL-транзакции. псевдонимы: key | |
| cloud сырые данные | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан auth или присутствуют переменные окружения OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как и в секции clouds.yaml. | |
| interface строка |
| Тип URL-адреса конечной точки для получения из каталога сервисов. псевдонимы: endpoint_type |
| meta словарь / обязательно | Список пар ключ-значение, которые должны быть предоставлены в качестве метаданных экземпляру или строка, содержащая список пар ключ-значение. Пример: meta: "key1=value1,key2=value2" | |
| region_name строка | Имя региона. | |
| server строка / обязательно | Имя экземпляра для обновления метаданных псевдонимы: name | |
| state строка |
| Ресурс должен быть present или absent. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| validate_certs логическое значение |
| Требуется ли проверка SSL API-запросов. До Ansible 2.3 значение по умолчанию было yes.псевдонимы: verify |
| wait логическое значение |
| Ansible должно ожидать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут браться из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а в последнюю очередь из явных параметров в playbook. Дополнительную информацию можно найти на сайте https://docs.openstack.org/openstacksdk/
Примеры
# 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
openstack.cloud.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
openstack.cloud.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 словарь | успех | Метаданные вычислительного экземпляра после изменения Пример: {'key1': 'value1', 'key2': 'value2'} |
| server_id строка | успех | ID вычислительного экземпляра, где были внесены изменения Пример: 324c4e91-3e03-4f62-9a4d-06119a8a8d16 |
Авторы
- Группа OpenStack Ansible SIG
© 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/openstack/cloud/os_server_metadata_module.html
