Модуль openstack.cloud.volume_type_info – Получение подробных сведений о типе тома OpenStack
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля вам потребуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: openstack.cloud.volume_type_info.
Краткое описание
- Получение подробных сведений о типе тома в OpenStack.
- Получение подробных сведений о шифровании типа тома в OpenStack
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Как долго уровень сокета должен ждать, прежде чем истечет время ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов. |
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-адреса конечной точки для извлечения из каталога служб. Варианты:
|
name строка / обязательно | Имя или идентификатор типа тома. |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается. |
timeout целое число | Как долго ansible должен ждать запрашиваемого ресурса. По умолчанию: |
validate_certs псевдонимы: verify логическое значение | Следует ли проверять запросы API SSL. До Ansible 2.3 это значение по умолчанию было Варианты:
|
wait логическое значение | Должен ли ansible ждать, пока запрашиваемый ресурс не будет завершен. Варианты:
|
Примечания
Примечание
- Стандартные переменные среды OpenStack, такие как
OS_USERNAME, могут быть использованы вместо явных значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в играх. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Get volume type details
openstack.cloud.volume_type_info:
name: test_type
- name: Get volume type details by id
openstack.cloud.volume_type_info:
name: fbadfa6b-5f17-4c26-948e-73b94de57b42
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
access_project_ids список / элементы=строка | Список идентификаторов проектов, имеющих разрешение доступа к типу тома. Для общедоступных типов томов возвращается значение ‘null’, так как оно не применимо. Возвращается: при успехе, когда state равен ‘present’ |
encryption словарь | Словарь, описывающий шифрование типа тома. Возвращается: при успехе, когда state равен ‘present’ |
|
cipher строка |
шифр шифрования Возвращается: при успехе Пример: |
|
control_location строка |
местоположение шифрования Возвращается: при успехе Пример: |
|
created_at строка |
Дата и время создания ресурса Возвращается: при успехе Пример: |
|
deleted строка |
Булево значение, если ресурс был удален Возвращается: при успехе Пример: |
|
deleted_at строка |
Дата и время удаления ресурса Возвращается: при успехе |
|
encryption_id строка |
UUID шифрования типа тома Возвращается: при успехе Пример: |
|
id строка |
Псевдоним для encryption_id Возвращается: при успехе Пример: |
|
key_size строка |
Размер ключа Возвращается: при успехе Пример: |
|
provider строка |
Поставщик шифрования Возвращается: при успехе Пример: |
|
updated_at строка |
Дата и время последнего обновления ресурса Возвращается: при успехе |
volume_type словарь | Словарь, описывающий тип тома. Возвращается: при успехе, когда state равен ‘present’ |
|
description строка |
Описание типа тома Возвращается: при успехе Пример: |
|
extra_specs словарь |
Дополнительные параметры типа тома Возвращается: при успехе |
|
id строка |
uuid типа тома Возвращается: при успехе Пример: |
|
is_public логическое |
является ли тип тома общедоступным Возвращается: при успехе Пример: |
|
name строка |
имя типа тома Возвращается: при успехе Пример: |
Справочные ссылки
© 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/volume_type_info_module.html