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

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

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

Краткое описание

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

Требования

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

openstacksdk
python >= 2.7
shade

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout -		Сколько времени должно ожидать сокетное подключение перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку requests.
auth -		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменных именах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type -		Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone -		Зона доступности, в которой необходимо создать снимок.
cacert -		Путь к файлу с пакетом сертификатов CA, который можно использовать для проверки SSL-API-запросов.
cert -		Путь к клиенту сертификату для использования в рамках SSL-транзакции.
cloud -		Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
interface - добавлено в 2.3	Варианты: public ← internal admin	Тип URL-адреса конечной точки для получения из каталога сервисов. псевдонимы: endpoint_type
key -		Путь к клиенту ключу для использования в рамках SSL-транзакции.
meta - / обязательно		Список пар ключ-значение, которые необходимо предоставить в качестве метаданных экземпляру или строка, содержащая список пар ключ-значение. Пример: meta: "key1=value1,key2=value2"
region_name -		Имя региона.
server - / обязательно		Имя экземпляра, для которого необходимо обновить метаданные псевдонимы: name
state -	Варианты: present ← absent	Ресурс должен быть присутствовать или отсутствовать.
timeout -	По умолчанию: 180	Сколько времени Ansible должен ждать запрашиваемый ресурс.
verify boolean	Варианты: no yes	Необходимо ли проверять SSL-API-запросы. До версии 2.3 значение по умолчанию было True. псевдонимы: validate_certs
wait boolean	Варианты: no yes ←	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 словарь	успех	Метаданные экземпляра вычислительной машины после изменения Пример: {'key1': 'value1', 'key2': 'value2'}
server_id строка	успех	Идентификатор экземпляра вычислительной машины, где были внесены изменения Пример: 324c4e91-3e03-4f62-9a4d-06119a8a8d16

Статус

Гарантируется обратная совместимость интерфейса этого модуля. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/os_server_metadata_module.html