cs_storage_pool – Управляет основными пулами хранилищ на облаках Apache CloudStack

Новое в версии 2.4.

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

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

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
allocation_state строка	Варианты: enabled disabled maintenance	Состояние выделения пула хранилищ.
api_http_method строка	Варианты: get post	Метод HTTP, используемый для запроса к API-точке. Если не указано, используется значение переменной окружения `CLOUDSTACK_METHOD`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию — `get`, если не указано.
api_key строка		Ключ API CloudStack API. Если не указано, используется значение переменной окружения `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region строка	Значение по умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не указано, используется значение переменной окружения `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ API CloudStack API. Если не задано, используется значение переменной окружения `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не указано, используется значение переменной окружения `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию — 10 секунд, если не указано.
api_url строка		URL CloudStack API, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной окружения `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
capacity_bytes целое число		Объем, который CloudStack может предоставить из этого пула хранилищ (в байтах).
capacity_iops целое число		Объем, который CloudStack может предоставить из этого пула хранилищ (в IOPS).
cluster строка		Имя кластера.
hypervisor строка		Обязательно при создании пула, ограниченного зоной. Возможные значения: `KVM`, `VMware`, `BareMetal`, `XenServer`, `LXC`, `HyperV`, `UCS`, `OVM`, `Simulator`.
managed булево	Варианты: no yes	Управляется ли пул хранилищ CloudStack. Учитывается только при создании.
name строка / обязательно		Имя пула хранилищ.
pod строка		Имя подсети.
provider строка	Значение по умолчанию: "DefaultPrimary"	Имя поставщика хранилищ, например, SolidFire, SolidFireShared, DefaultPrimary, CloudByte.
scope строка	Варианты: cluster zone	Область действия пула хранилищ. По умолчанию — cluster, если указан параметр `cluster`, в противном случае — zone.
state строка	Варианты: present ← absent	Состояние пула хранилищ.
storage_tags список		Теги, связанные с этим пулом хранилищ. псевдонимы: storage_tag
storage_url строка		URL пула хранилищ. Обязательно, если state=present.
zone строка		Имя зоны, в которой должен быть развернут хост. Если не задано, используется зона по умолчанию.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены параметрами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в следующем порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD переменные среды. Переменная среды CLOUDSTACK_TIMEOUT, указывающая на файл .ini. Файл cloudstack.ini в текущем рабочем каталоге. Файл .cloudstack.ini в домашнем каталоге пользователя. Допускается указание нескольких учетных данных и точек доступа, используя разделы ini в cloudstack.ini. Используйте параметр api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Дополнительная информация доступна на странице https://github.com/exoscale/cs.
Подробное руководство по модулям CloudStack можно найти в Руководстве по облакам CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: ensure a zone scoped storage_pool is present
  cs_storage_pool:
    zone: zone01
    storage_url: rbd://admin:SECRET@ceph-mons.domain/poolname
    provider: DefaultPrimary
    name: Ceph RBD
    scope: zone
    hypervisor: KVM
  delegate_to: localhost

- name: ensure a cluster scoped storage_pool is disabled
  cs_storage_pool:
    name: Ceph RBD
    zone: zone01
    cluster: cluster01
    pod: pod01
    storage_url: rbd://admin:SECRET@ceph-the-mons.domain/poolname
    provider: DefaultPrimary
    scope: cluster
    allocation_state: disabled
  delegate_to: localhost

- name: ensure a cluster scoped storage_pool is in maintenance
  cs_storage_pool:
    name: Ceph RBD
    zone: zone01
    cluster: cluster01
    pod: pod01
    storage_url: rbd://admin:SECRET@ceph-the-mons.domain/poolname
    provider: DefaultPrimary
    scope: cluster
    allocation_state: maintenance
  delegate_to: localhost

- name: ensure a storage_pool is absent
  cs_storage_pool:
    name: Ceph RBD
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
allocation_state строка	успех	Состояние хранилища. Пример: enabled
capacity_iops целое число	при доступности	IOPS, которые CloudStack может предоставить из этого хранилища. Пример: 60000
cluster строка	при области действия кластера	Имя кластера. Пример: Cluster01
created строка	успех	Дата создания пула. Пример: 2014-12-01T14:57:57+0100
disk_size_allocated целое число	успех	Текущий размер выделенного дискового пространства пула. Пример: 2443517624320
disk_size_total целое число	успех	Общий размер пула. Пример: 3915055693824
disk_size_used целое число	успех	Текущий размер используемого дискового пространства пула. Пример: 1040862622180
hypervisor строка	при доступности	Гипервизор, связанный с этим хранилищем. Пример: KVM
id строка	успех	UUID пула. Пример: a3fca65a-7db1-4891-b97c-48806a978a96
overprovision_factor строка	успех	Коэффициент перевыделения хранилища. Пример: 2.0
path строка	успех	Путь к хранилищу, используемый в storage_url. Пример: poolname
pod строка	при области действия кластера	Имя подсети. Пример: Cluster01
scope строка	успех	Область действия хранилища. Пример: cluster
state строка	успех	Состояние хранилища, возвращаемое API. Пример: Up
storage_capabilities словарь	успех	Возможности хранилища. Пример: {'VOLUME_SNAPSHOT_QUIESCEVM': 'false'}
storage_tags список	успех	Теги для хранилища. Пример: ['perf', 'ssd']
suitable_for_migration булево	успех	Подходит ли хранилище для миграции тома.
zone строка	успех	Имя зоны. Пример: Zone01

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Netservers Ltd. (@netservers)
René Moser (@resmo)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cs_storage_pool_module.html