openstack.cloud.server_info модуль – Получение информации об одном или нескольких вычислительных экземплярах
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в playbook укажите: openstack.cloud.server_info.
Описание
- Получение информации о серверных экземплярах из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
all_projects boolean | Указывает, следует ли перечислять серверы из всех проектов или только из текущего проекта, ограниченного аутентификацией. Варианты:
|
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 aliases: cacert string | Путь к пакету сертификатов CA, который может быть использован для проверки SSL API-запросов. |
client_cert aliases: cert string | Путь к клиенту сертификата для использования в рамках SSL транзакции. |
client_key aliases: key string | Путь к ключу клиента для использования в рамках SSL транзакции. |
cloud any | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, аналогично той, что будет в секции clouds.yaml. |
detailed boolean | При значении Варианты:
|
filters dictionary | Используется для дополнительной фильтрации результатов. Либо строка, содержащая выражение JMESPath, либо словарь метаданных. Элементы последнего могут быть словарями. |
interface aliases: endpoint_type string | Тип URL конечной точки для извлечения из каталога сервисов. Варианты:
|
name aliases: server string | Ограничивает результаты серверами с именами или UUID, соответствующими этому шаблону, например |
region_name string | Имя региона. |
sdk_log_level string | Уровень логов OpenStackSDK. Варианты:
|
sdk_log_path string | Путь к лог-файлу OpenStackSDK. Если пусто, лог не записывается. |
timeout integer | Время ожидания Ansible для запрошенного ресурса. По умолчанию: |
validate_certs aliases: verify boolean | Указывает, должны ли проверяться SSL API-запросы. До Ansible 2.3 по умолчанию было Варианты:
|
wait boolean | Ansible должен ожидать завершения запрошенного ресурса. Варианты:
|
Примечания
Примечание
- Результат содержит список серверов.
- Стандартные переменные окружения OpenStack, такие как
OS_USERNAME, могут использоваться вместо явных значений. - Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем из явных параметров в playbooks. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Gather information about all 'web*' servers in active state
openstack.cloud.server_info:
cloud: devstack
name: web*
filters:
vm_state: active
- name: Filter servers with nested dictionaries
openstack.cloud.server_info:
cloud: devstack
filters:
metadata:
key1: value1
key2: value2
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
servers list / elements=dictionary | Список серверов, соответствующих фильтрам Возвращается: всегда |
|
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 |
Имя экземпляра. 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 |
Идентификатор проекта, с которым связан этот сервер. Возвращено: success |
|
ramdisk_id string |
UUID образа ramdisk при использовании AMI. Будет null, если нет. По умолчанию, отображается в ответе только для административных пользователей. Возвращено: success |
|
reservation_id string |
Идентификатор резервирования для сервера. Это идентификатор, который может быть полезен при отслеживании групп серверов, созданных с помощью множественного создания, которые будут иметь один и тот же 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. Возвращено: успешно |
Ссылки на сборки
© 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_info_module.html
