cs_storage_pool - Управляет первичными пулами хранилищ в облаках на базе Apache CloudStack.
Новая версия 2.4.
Обзор
- Создание, обновление, перевод в режим технического обслуживания, отключение, включение и удаление пулов хранилищ.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allocation_state |
| Состояние распределения пула хранилищ. |
| api_http_method |
| Метод HTTP, используемый для запроса к API-точке. Если не указано, используется переменная окружения CLOUDSTACK_METHOD. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию get, если не указано. |
| api_key | Ключ API API CloudStack. Если не указано, используется переменная окружения CLOUDSTACK_KEY. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. | |
| api_region | Значение по умолчанию: cloudstack | Имя раздела ini в файле cloustack.ini. Если не указано, используется переменная окружения CLOUDSTACK_REGION. |
| api_secret | Секретный ключ API CloudStack. Если не задано, используется переменная среды CLOUDSTACK_SECRET. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. | |
| api_timeout | Таймаут HTTP в секундах. Если не указано, используется переменная окружения CLOUDSTACK_TIMEOUT. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано. | |
| api_url | URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется переменная окружения CLOUDSTACK_ENDPOINT. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. | |
| capacity_bytes | Байты, которые CloudStack может выделять из этого пула хранилища. | |
| capacity_iops | Байты, которые CloudStack может выделять из этого пула хранилища. | |
| cluster | Имя кластера. | |
| hypervisor |
| Требуется при создании пула уровня зоны. |
| managed | Указывает, должен ли пул хранилищ управляться CloudStack. Учитывается только при создании. | |
| name обязательно | Имя пула хранилища. | |
| pod | Имя подсети. | |
| provider | Значение по умолчанию: DefaultPrimary | Имя поставщика хранилищ, например, SolidFire, SolidFireShared, DefaultPrimary, CloudByte. |
| scope |
| Область применения пула хранилища. По умолчанию задается как cluster, если cluster указан, в противном случае zone. |
| state |
| Состояние пула хранилища. |
| storage_tags | Теги, связанные с этим пулом хранилища. | |
| storage_url | URL пула хранилища. Требуется, если state=present. | |
| zone | Имя зоны, в которой должен быть развернут хост. Если не указано, используется зона по умолчанию. |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких источников в следующем порядке. Переменные средыCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. Переменная средыCLOUDSTACK_TIMEOUT, указывающая на файлCLOUDSTACK_CONFIG. Файл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
local_action:
module: cs_storage_pool
zone: zone01
storage_url: rbd://admin:SECRET@ceph-mons.domain/poolname
provider: DefaultPrimary
name: Ceph RBD
scope: zone
hypervisor: KVM
- name: ensure a cluster scoped storage_pool is disabled
local_action:
module: 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
- name: ensure a cluster scoped storage_pool is in maintenance
local_action:
module: 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
- name: ensure a storage_pool is absent
local_action:
module: cs_storage_pool
name: Ceph RBD
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Автор
- 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.5/modules/cs_storage_pool_module.html