openstack.cloud.volume_info – Получение информации о томах
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в книге задач укажите: openstack.cloud.volume_info.
Обзор
- Получение информации о хранилище блочных данных в OpenStack
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| all_projects boolean |
| Указывает, следует ли вернуть тома всех проектов |
| api_timeout integer | Время ожидания сокета перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан библиотеке requests. | |
| auth dictionary | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password это будет включать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если задан параметр cloud или присутствуют переменные среды OpenStack OS_*. | |
| auth_type string | Имя плагина авторизации, который необходимо использовать. Если облако использует что-то помимо аутентификации по паролю, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone string | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. псевдонимы: cacert | |
| client_cert string | Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key string | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud raw | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если задан параметр auth или присутствуют переменные среды OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| details boolean |
| Указывает, следует ли предоставлять дополнительную информацию о томах |
| interface string |
| Тип URL-адреса конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| name string | Имя тома в виде строки. | |
| region_name string | Имя региона. | |
| status string | Значение состояния тома, например, для фильтрации по состоянию "available" | |
| timeout integer | Значение по умолчанию: 180 | Время ожидания Ansible для запрошенного ресурса. |
| validate_certs boolean |
| Указывает, следует ли проверять запросы API SSL. До версии Ansible 2.3 это было по умолчанию yes.псевдонимы: verify |
| wait boolean |
| Должен ли Ansible ожидать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации определяется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти на странице https://docs.openstack.org/openstacksdk/
Примеры
- openstack.cloud.volume_info:
- openstack.cloud.volume_info:
name: myvolume
- openstack.cloud.volume_info:
all_projects: true
- openstack.cloud.volume_info:
all_projects: true
details: true
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| volumes list / elements=dictionary | всегда | Тома в проекте Пример: [{'attachments': [], 'availability_zone': 'nova', 'consistency_group_id': None, 'created_at': '2017-11-15T10:51:19.000000', 'description': '', 'extended_replication_status': None, 'host': None, 'id': '103ac6ed-527f-4781-8484-7ff4467e34f5', 'image_id': None, 'is_bootable': True, 'is_encrypted': False, 'links': [{'href': 'https://...', 'rel': 'self'}, {'href': 'https://...', 'rel': 'bookmark'}], 'location': {'cloud': 'cloud', 'project': {'domain_id': None, 'domain_name': 'По умолчанию', 'id': 'cfe04702154742fc964d9403c691c76e', 'name': 'username'}, 'region_name': 'regionOne', 'zone': 'nova'}, 'metadata': {'readonly': 'False'}, 'migration_id': None, 'migration_status': None, 'name': '', 'project_id': 'cab34702154a42fc96ed9403c691c76e', 'replication_driver_data': None, 'replication_status': 'disabled', 'size': 9, 'snapshot_id': None, 'source_volume_id': None, 'status': 'available', 'volume_image_metadata': {'checksum': 'a14e113deeee3a3392462f167ed28cb5', 'container_format': 'bare', 'disk_format': 'raw', 'family': 'centos-7', 'image_id': 'afcf3320-1bf8-4a9a-a24d-5abd639a6e33', 'image_name': 'CentOS-7-x86_64-GenericCloud-1708', 'latest': 'centos-7-latest', 'min_disk': '0', 'min_ram': '0', 'official': 'True', 'official-image': 'True', 'size': '8589934592'}, 'volume_type': None}] |
Авторы
- Sagi Shnaidman (@sshnaidm)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/volume_info_module.html
