Модуль openstack.cloud.volume_type — управление типами томов OpenStack

Примечание

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

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

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

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

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

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

Добавление, удаление и обновление типов томов в 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.
description string	Описание типа тома.
extra_specs dictionary	Список свойств типа тома
interface псевдонимы: endpoint_type string	Тип URL конечной точки, используемый для получения данных из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_public boolean	Сделать тип тома общедоступным. Можно задать только при создании Варианты: `false` `true`
name string / обязательный	Имя или идентификатор типа тома.
region_name string	Название региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается
state string	Требуемое состояние ресурса. Если state имеет значение `present`, необходимо указать is_public. Варианты: `"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/

Примеры

- name: Delete volume type by name
  openstack.cloud.volume_type:
    name: test_type
    state: absent

- name: Delete volume type by id
  openstack.cloud.volume_type:
    name: fbadfa6b-5f17-4c26-948e-73b94de57b42
    state: absent

- name: Create volume type
  openstack.cloud.volume_type:
    name: unencrypted_volume_type
    state: present
    extra_specs:
      volume_backend_name: LVM_iSCSI
    description: Unencrypted volume type
    is_public: True

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

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

Ключ	Описание
volume_type dictionary	Словарь с описанием типа тома Возвращается: При успешном выполнении, если state имеет значение ‘present’
description string	описание типа тома Возвращается: при успешном выполнении Пример: `"Unencrypted volume type"`
extra_specs dictionary	дополнительные параметры типа тома Возвращается: при успешном выполнении
is_public boolean	является ли тип тома общедоступным Возвращается: при успешном выполнении Пример: `true`
name string	имя типа тома Возвращается: при успешном выполнении Пример: `"test_type"`

Авторы

Специальная группа Ansible по OpenStack

Ссылки на коллекцию

© 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/volume_type_module.html