Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Обзор

  • Добавление, удаление или изменение шифрования типа тома в 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

Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов 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.

encryption_cipher

string

Алгоритм или режим шифрования

Только для администратора

encryption_control_location

string

Задает предполагаемую службу, в которой выполняется шифрование

Только для администратора

Варианты:

  • "front-end"
  • "back-end"

encryption_key_size

integer

Задает размер ключа шифрования для этого типа тома

Только для администратора

Варианты:

  • 128
  • 256
  • 512

encryption_provider

string

Класс, обеспечивающий поддержку шифрования для типа тома

Только для администратора

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

region_name

string

Имя региона.

sdk_log_level

string

Уровень журналирования OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведется.

state

string

Требуемое состояние ресурса.

Если значение state равно present, необходимо указать параметры шифрования.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

Время ожидания запрошенного ресурса Ansible.

По умолчанию: 180

validate_certs

псевдонимы: verify

boolean

Следует ли проверять запросы API по SSL.

До Ansible 2.3 значением по умолчанию было true.

Варианты:

  • false
  • true

volume_type

string / обязательный

Имя или идентификатор типа тома.

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: Create volume type encryption
  openstack.cloud.volume_type_encryption:
    volume_type: test_type
    state: present
    encryption_provider: nova.volume.encryptors.luks.LuksEncryptor
    encryption_cipher: aes-xts-plain64
    encryption_control_location: front-end
    encryption_key_size: 256

- name: Delete volume type encryption
  openstack.cloud.volume_type_encryption:
    volume_type: test_type
    state: absent
  register: the_result

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

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

Ключ

Описание

encryption

dictionary

Словарь с описанием шифрования типа тома

Возвращается: При успешном выполнении, если state имеет значение ‘present’

cipher

string

Алгоритм шифрования

Возвращается: При успешном выполнении

Пример: "aes-xts-plain64"

control_location

string

Расположение шифрования

Возвращается: При успешном выполнении

Пример: "front-end"

created_at

string

Дата и время создания ресурса

Возвращается: При успешном выполнении

Пример: "2023-08-04T10:23:03.000000"

deleted

string

Логическое значение, указывающее, был ли удален ресурс

Возвращается: При успешном выполнении

Пример: "false,"

deleted_at

string

Дата и время удаления ресурса

Возвращается: При успешном выполнении

Пример: "null,"

encryption_id

string

UUID шифрования типа тома

Возвращается: При успешном выполнении

Пример: "b75d8c5c-a6d8-4a5d-8c86-ef4f1298525d"

id

string

Псевдоним для encryption_id

Возвращается: При успешном выполнении

Пример: "b75d8c5c-a6d8-4a5d-8c86-ef4f1298525d"

key_size

string

Размер ключа

Возвращается: При успешном выполнении

Пример: "256,"

provider

string

Поставщик шифрования

Возвращается: При успешном выполнении

Пример: "nova.volume.encryptors.luks.LuksEncryptor"

updated_at

string

Дата и время последнего обновления ресурса

Возвращается: При успешном выполнении

Авторы

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

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)

© 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_encryption_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API