модуль openstack.cloud.server_metadata — добавление/обновление/удаление метаданных в вычислительных экземплярах OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: openstack.cloud.server_metadata.

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

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

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

Требования

Следующие требования необходимы на узле, который выполняет этот модуль.

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Как долго уровень сокетов должен ожидать ответа перед истечением времени ожидания вызовов API. Если этот параметр не указан, библиотеке requests ничего не передаётся.
auth dictionary	Словарь с данными аутентификации, необходимыми выбранному облачному модулю аутентификации. Для стандартного модуля password здесь должны быть указаны auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других модулей этот параметр должен содержать все необходимые им параметры. Этот параметр не нужен, если указано именованное облако или заданы переменные окружения OpenStack OS_*.
auth_type string	Имя используемого модуля аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя модуля и соответствующим образом обновить содержимое параметра auth.
ca_cert псевдонимы: cacert string	Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL.
client_cert псевдонимы: cert string	Путь к клиентскому сертификату, который будет использоваться при SSL-соединении.
client_key псевдонимы: key string	Путь к клиентскому ключу, который будет использоваться при SSL-соединении.
cloud any	Именованное облако или конфигурация облака, с которой нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или заданы переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml.
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемой из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
metadata псевдонимы: meta dictionary / обязательный	Список пар «ключ-значение», которые следует передать в качестве метаданных экземпляра, или строка со списком пар «ключ-значение». Например: meta: “key1=value1,key2=value2” Обратите внимание: если state равен `true`, существующие на сервере метаданные не будут удалены.
name псевдонимы: server string / обязательный	Имя экземпляра, метаданные которого нужно обновить
region_name string	Имя региона.
sdk_log_level string	Уровень журналирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся
state string	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Как долго Ansible должен ждать запрошенный ресурс. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы API SSL. До Ansible 2.3 значением по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ждать завершения операции над запрошенным ресурсом. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо указания явных значений можно использовать стандартные переменные окружения 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
# Note that existing keys will not be cleared
- name: add metadata to instance
  openstack.cloud.server_metadata:
      state: present
      cloud: "{{ cloud }}"
      name: vm1
      metadata:
          hostname: test1
          group: group1

# Removes the keys under meta from the instance named vm1
- name: delete metadata from instance
  openstack.cloud.server_metadata:
        state: absent
        cloud: "{{ cloud }}"
        name: vm1
        meta:
            hostname:
            group:
            public_keys:

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
server dictionary	Словарь с описанием обновлённого сервера. Возвращается: При успешном выполнении, если state имеет значение ‘present’.
access_ipv4 string	Адрес IPv4, который следует использовать для доступа к этому серверу. Может автоматически задаваться поставщиком. Возвращается: при успешном выполнении
access_ipv6 string	Адрес IPv6, который следует использовать для доступа к этому серверу. Может автоматически задаваться поставщиком. Возвращается: при успешном выполнении
addresses dictionary	Словарь адресов, через которые можно получить доступ к этому серверу. Словарь содержит такие ключи, как ‘private’ и ‘public’, каждый из которых содержит список словарей адресов соответствующего типа. Адреса представлены в словаре с ключами ‘addr’ и ‘version’; значение последнего — 4 или 6 в зависимости от протокола IP-адреса. Возвращается: при успешном выполнении
admin_password string	При первоначальном создании сервера возвращает пароль администратора. Возвращается: при успешном выполнении
attached_volumes list / elements=string	Список подключённых томов. Каждый элемент списка содержит как минимум ключ ‘id’, идентифицирующий соответствующий том. Возвращается: при успешном выполнении
availability_zone string	Название зоны доступности, к которой относится этот сервер. Возвращается: при успешном выполнении
block_device_mapping string	Позволяет точно настроить сопоставление блочных устройств для экземпляра. Обычно это используется для загрузки серверов с томов. Возвращается: при успешном выполнении
compute_host string	Имя вычислительного узла, на котором работает этот экземпляр. Отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
config_drive string	Указывает, использовался ли для этого сервера диск конфигурации. Возвращается: при успешном выполнении
created_at string	Метка времени создания сервера. Возвращается: при успешном выполнении
description string	Описание сервера. До микроверсии 2.19 в этом поле указывалось имя сервера. Возвращается: при успешном выполнении
disk_config string	Конфигурация диска: AUTO или MANUAL. Возвращается: при успешном выполнении
flavor dictionary	Свойство flavor в том виде, в котором оно возвращается сервером. Возвращается: при успешном выполнении
flavor_id string	Ссылка на flavor, представленная идентификатором или полным URL, который следует использовать для этого сервера. Возвращается: при успешном выполнении
has_config_drive string	Указывает, поддерживает ли диск конфигурации внедрение метаданных. Эту функцию поддерживают не все облачные поставщики. Возвращается: при успешном выполнении
host_id string	Идентификатор узла, на котором размещён этот сервер. Возвращается: при успешном выполнении
host_status string	Состояние узла. Возвращается: при успешном выполнении
hostname string	Имя узла, назначаемое экземпляру при загрузке. По умолчанию отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
hypervisor_hostname string	Имя узла гипервизора. Отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
id string	Идентификатор сервера. Возвращается: при успешном выполнении
image dictionary	Свойство image в том виде, в котором оно возвращается сервером. Возвращается: при успешном выполнении
image_id string	Ссылка на образ, представленная идентификатором или полным URL, который следует использовать для этого сервера. Возвращается: при успешном выполнении
instance_name string	Имя экземпляра. Compute API формирует его на основе шаблона имени экземпляра. Отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
is_locked boolean	Состояние блокировки сервера. Возвращается: при успешном выполнении
kernel_id string	UUID образа ядра при использовании AMI. Если образ не используется, значение будет null. По умолчанию отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
key_name string	Имя связанной пары ключей. Возвращается: при успешном выполнении
launch_index integer	Если серверы запускаются одним запросом на создание нескольких экземпляров, это порядковый номер запуска сервера. По умолчанию отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
launched_at string	Метка времени запуска сервера. Возвращается: при успешном выполнении
links string	Список словарей со ссылками, относящимися к этому серверу. Возвращается: при успешном выполнении
max_count string	Максимальное количество создаваемых серверов. Возвращается: при успешном выполнении
metadata dictionary	Список строк тегов. Возвращается: при успешном выполнении
min_count string	Минимальное количество создаваемых серверов. Возвращается: при успешном выполнении
name string	Имя сервера. Возвращается: при успешном выполнении
networks string	Объект сетей. Обязательный параметр, если для арендатора определено несколько сетей. Если параметр networks не указан, сервер подключается к единственной сети, созданной для текущего арендатора. Возвращается: при успешном выполнении
power_state string	Состояние питания этого сервера. Возвращается: при успешном выполнении
progress integer	Пока сервер создаётся, это значение показывает процент выполнения. После завершения оно равно 100. Возвращается: при успешном выполнении
project_id string	Идентификатор проекта, с которым связан этот сервер. Возвращается: при успешном выполнении
ramdisk_id string	UUID образа ramdisk при использовании AMI. Если образ не используется, значение будет null. По умолчанию отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
reservation_id string	Идентификатор резервирования сервера. Он может быть полезен для отслеживания групп серверов, созданных одним запросом на создание нескольких экземпляров: у всех них будет одинаковый reservation_id. По умолчанию отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
root_device_name string	Имя корневого устройства экземпляра. По умолчанию отображается в ответе только для пользователей с правами администратора. Возвращается: при успешном выполнении
scheduler_hints dictionary	Словарь данных, передаваемых планировщику. Возвращается: при успешном выполнении
security_groups list / elements=dictionary	Список применимых групп безопасности. Каждая группа содержит ключи description, name, id и rules. Возвращается: при успешном выполнении
server_groups list / elements=string	UUID групп серверов, к которым относится этот сервер. В настоящее время список может содержать не более одного элемента. Возвращается: при успешном выполнении
status string	Текущее состояние сервера. Допустимые значения: ‘ACTIVE’, ‘BUILDING’, ‘DELETED’, ‘ERROR’, ‘HARD_REBOOT’, ‘PASSWORD’, ‘PAUSED’, ‘REBOOT’, ‘REBUILD’, ‘RESCUED’, ‘RESIZED’, ‘REVERT_RESIZE’, ‘SHUTOFF’, ‘SOFT_DELETED’, ‘STOPPED’, ‘SUSPENDED’, ‘UNKNOWN’ или ‘VERIFY_RESIZE’. Возвращается: при успешном выполнении
tags list / elements=string	Список связанных тегов. Возвращается: при успешном выполнении
task_state string	Состояние задачи этого сервера. Возвращается: при успешном выполнении
terminated_at string	Метка времени завершения работы сервера (если он был завершён). Возвращается: при успешном выполнении
trusted_image_certificates list / elements=string	Список идентификаторов доверенных сертификатов, использованных при проверке подписи образа для подтверждения сертификата подписи. Возвращается: при успешном выполнении
updated_at string	Метка времени последнего обновления этого сервера. Возвращается: при успешном выполнении
user_data string	Данные конфигурации или сценарии, используемые при запуске. Закодированы в Base64. Возвращается: при успешном выполнении
user_id string	Идентификатор владельца этого сервера. Возвращается: при успешном выполнении
vm_state string	Состояние виртуальной машины этого сервера. Возвращается: при успешном выполнении
volumes list / elements=string	То же, что и attached_volumes. Возвращается: при успешном выполнении

Авторы

OpenStack Ansible SIG

Ссылки коллекции

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/server_metadata_module.html