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

Примечание

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

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

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

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

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Добавление, удаление или обновление типов томов в OpenStack.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 3.6
openstacksdk >= 1.0.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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 Cert, который может использоваться для проверки запросов API SSL.
client_cert алиасы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key алиасы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
description строка	Описание типа тома.
extra_specs словарь	Список свойств типа тома.
interface алиасы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_public булево	Сделать тип тома доступным для публичного использования. Может быть установлено только при создании. Варианты: `false` `true`
name строка / обязательно	Имя или идентификатор типа тома.
region_name строка	Имя региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к журналу OpenStackSDK. Если пусто, журнал не записывается.
state строка	Укажите желаемое состояние ресурса. Когда state равно `present`, тогда is_public требуется. Варианты: `"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/

Примеры

- 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 словарь	Словарь, описывающий тип тома Возвращается: при успехе, когда state равен ‘present’
description строка	Описание типа тома Возвращается: успех Пример: `"Unencrypted volume type"`
extra_specs словарь	Дополнительные параметры типа тома Возвращается: успех
is_public булево	Является ли тип тома общедоступным Возвращается: успех Пример: `true`
name строка	Имя типа тома Возвращается: успех Пример: `"test_type"`

Авторы

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