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

Примечание

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

id string	Идентификатор сервера. Возвращено: success
image dictionary	Свойство image, как возвращено сервером. Возвращено: success
image_id string	Ссылка на образ, как ID или полный URL, для использования на этом сервере. Возвращено: success
instance_name string	Имя экземпляра. Compute API генерирует имя экземпляра из шаблона имени экземпляра. Появляется в ответе только для административных пользователей. Возвращено: success
is_locked boolean	Заблокирован ли сервер. Возвращено: success
kernel_id string	UUID образа ядра при использовании AMI. Будет null, если нет. По умолчанию, отображается в ответе только для административных пользователей. Возвращено: success
key_name string	Имя связанного ключа. Возвращено: success
launch_index integer	Когда серверы запускаются с помощью множественного создания, это последовательность, в которой серверы были запущены. По умолчанию, отображается в ответе только для административных пользователей. Возвращено: success
launched_at string	Метка времени запуска сервера. Возвращено: success
links string	Список словарей, содержащих ссылки, относящиеся к этому серверу. Возвращено: success
max_count string	Максимальное количество серверов для создания. Возвращено: success
metadata dictionary	Список тегов. Возвращено: success
min_count string	Минимальное количество серверов для создания. Возвращено: success
name string	Имя сервера. Возвращено: success
networks string	Объект сетей. Обязательный параметр, когда для клиента определено несколько сетей. Если параметр networks не указан, сервер подключается к единственной сети, созданной для текущего клиента. Возвращено: success
power_state string	Состояние питания этого сервера. Возвращено: success
progress integer	Пока сервер строится, это значение представляет процент завершения. После завершения он будет равен 100. Возвращено: success
project_id string	ID проекта, с которым связан этот сервер. Возвращено: success
ramdisk_id string	UUID образа ramdisk при использовании AMI. Будет null, если нет. По умолчанию, отображается в ответе только для административных пользователей. Возвращено: success
reservation_id string	ID резервирования для сервера. Это ID, который может быть полезен для отслеживания групп серверов, созданных с помощью множественного создания, которые будут иметь один и тот же reservation_id. По умолчанию, отображается в ответе только для административных пользователей. Возвращено: success
root_device_name string	Имя корневого устройства для экземпляра. По умолчанию, отображается в ответе только для административных пользователей. Возвращено: success

scheduler_hints словарь	Словарь данных, отправляемых планировщику. Возвращаемое значение: успех
security_groups список / элементы=словарь	Список применимых групп безопасности. Каждая группа содержит ключи для: описания, имени, идентификатора и правил. Возвращаемое значение: успех
server_groups список / элементы=строка	UUID групп серверов, к которым принадлежит сервер. В настоящее время может содержать не более одной записи. Возвращаемое значение: успех
status строка	Состояние сервера. Допустимые значения включают «ACTIVE», «BUILDING», «DELETED», «ERROR», «HARD_REBOOT», «PASSWORD», «PAUSED», «REBOOT», «REBUILD», «RESCUED», «RESIZED», «REVERT_RESIZE», «SHUTOFF», «SOFT_DELETED», «STOPPED», «SUSPENDED», «UNKNOWN» или «VERIFY_RESIZE». Возвращаемое значение: успех
tags список / элементы=строка	Список ассоциированных тегов. Возвращаемое значение: успех
task_state строка	Состояние задачи этого сервера. Возвращаемое значение: успех
terminated_at строка	Отметка времени завершения работы сервера (если он был завершен). Возвращаемое значение: успех
trusted_image_certificates список / элементы=строка	Список идентификаторов доверенных сертификатов, которые использовались во время проверки подписи изображения для проверки сертификата подписи. Возвращаемое значение: успех
updated_at строка	Отметка времени последнего обновления сервера. Возвращаемое значение: успех
user_data строка	Конфигурационная информация или скрипты для использования при запуске. Кодируется в Base64. Возвращаемое значение: успех
user_id строка	Идентификатор владельцев этого сервера. Возвращаемое значение: успех
vm_state строка	Состояние виртуальной машины этого сервера. Возвращаемое значение: успех
volumes список / элементы=строка	То же самое, что и attached_volumes. Возвращаемое значение: успех

Авторы

OpenStack Ansible SIG

Ссылки на сборку

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