os_server_metadata – Добавление/обновление/удаление метаданных в вычислительных экземплярах из OpenStack

Новое в версии 2.6.

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

Описание

Добавление, обновление или удаление метаданных в вычислительных экземплярах из OpenStack.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

openstack
openstacksdk
python >= 2.7

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать сокетная связь, прежде чем произойдет таймаут API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку запросов.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля для проверки подлинности облака. Для стандартного плагина password это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать требуемые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения 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 строка добавлено в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
meta - / обязательно		Список пар ключ-значение, которые должны быть предоставлены в качестве метаданных экземпляру, или строка, содержащая список пар ключ-значение. Пример: meta: "key1=value1,key2=value2"
region_name строка		Имя региона.
server - / обязательно		Имя экземпляра для обновления метаданных псевдонимы: name
state -	Варианты: present ← absent	Должен ли ресурс быть 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, затем из стандартных переменных окружения, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти на 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
    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 словарь	успех	Метаданные вычислительного экземпляра после изменения Пример: {'key1': 'value1', 'key2': 'value2'}
server_id строка	успех	Идентификатор вычислительного экземпляра, в котором были внесены изменения Пример: 324c4e91-3e03-4f62-9a4d-06119a8a8d16

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.8/modules/os_server_metadata_module.html