Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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. Если это пропущено, ничего не будет передано в библиотеку запросов.

auth

dictionary

Словарь, содержащий информацию об аутентификации, необходимую стратегии подключаемого модуля аутентификации облака. Для плагина password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен будет содержать любые параметры, которые требуются этому подключаемому модулю аутентификации. Этот параметр не нужен, если указано именованное облако или присутствуют переменные среды OpenStack OS_*.

auth_type

string

Имя подключаемого модуля аутентификации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом.

ca_cert

aliases: cacert

string

Путь к пакету сертификатов CA, который может использоваться в качестве части проверки запросов API SSL.

client_cert

aliases: cert

string

Путь к клиентскому сертификату, который нужно использовать в рамках транзакции SSL.

client_key

aliases: 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

aliases: 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

aliases: verify

boolean

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

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

Варианты:

  • false
  • true

volume_type

строка / обязательно

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

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: 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

словарь

Словарь, описывающий шифрование типа тома

Возвращается: при успехе, когда state равен ‘present’

cipher

строка

шифр шифрования

Возвращается: успех

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

control_location

строка

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

Возвращается: успех

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

created_at

строка

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

Возвращается: успех

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

deleted

строка

Булево значение, если ресурс был удален

Возвращается: успех

Пример: "false,"

deleted_at

строка

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

Возвращается: успех

Пример: "null,"

encryption_id

строка

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

Возвращается: успех

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

id

строка

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

Возвращается: успех

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

key_size

строка

Размер ключа

Возвращается: успех

Пример: "256,"

provider

строка

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

Возвращается: успех

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

updated_at

строка

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

Возвращается: успех

Авторы

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

Spec-Zone.ru

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