Spec-Zone.ru › Ansible

Модуль openstack.cloud.share_type — управление типами общих ресурсов OpenStack

Примечание

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

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

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

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

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

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

  • Добавление, удаление и обновление типов общих ресурсов в OpenStack Manila.

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

  • 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

Описание типа общего ресурса.

driver_handles_share_servers

boolean

Логический флаг, указывающий, управляет ли драйвер серверами общих ресурсов.

Обязательный параметр при создании типа общего ресурса.

Автоматически добавляется в extra_specs как ‘driver_handles_share_servers’.

Варианты:

  • false
  • true ← (по умолчанию)

extra_specs

dictionary

Словарь дополнительных спецификаций типа общего ресурса.

interface

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

string

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

Варианты:

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

is_public

boolean

Сделать тип общего ресурса общедоступным.

После создания можно изменить с помощью прямых запросов к API Manila.

Варианты:

  • false
  • true ← (по умолчанию)

name

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

Имя или идентификатор типа общего ресурса.

Для частных типов общих ресурсов вместо имени необходимо использовать UUID.

region_name

string

Имя региона.

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

state

string

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

Варианты:

  • "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 share type by name
  openstack.cloud.share_type:
    name: test_share_type
    state: absent

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

- name: Create share type
  openstack.cloud.share_type:
    name: manila-generic-share
    state: present
    driver_handles_share_servers: true
    extra_specs:
      share_backend_name: GENERIC_BACKEND
      snapshot_support: true
      create_share_from_snapshot_support: true
    description: Generic share type
    is_public: true

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

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

Ключ

Описание

share_type

dictionary

Словарь с описанием типа общего ресурса.

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

description

string

Описание типа общего ресурса.

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

Пример: "Generic share type"

driver_handles_share_servers

boolean

Указывает, управляет ли драйвер серверами общих ресурсов.

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

Пример: true

extra_specs

dictionary

Дополнительные спецификации типа общего ресурса.

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

Пример: {"share_backend_name": "GENERIC_BACKEND", "snapshot_support": "true"}

id

string

UUID типа общего ресурса.

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

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

is_public

boolean

Указывает, является ли тип общего ресурса общедоступным.

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

Пример: true

name

string

Имя типа общего ресурса.

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

Пример: "manila-generic-share"

Авторы

  • Специальная группа 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/share_type_module.html

Spec-Zone.ru

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