cs_volume - Управляет томами на облаках Apache CloudStack.
Новая версия 2.1.
- Краткий обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Краткий обзор
- Создание, удаление, подключение, отключение томов.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| account |
нет | Аккаунт, к которому относится том. |
||
| api_http_method |
нет | get |
|
Используемый HTTP-метод. |
| api_key |
нет | Ключ API CloudStack API. |
||
| api_region |
нет | cloudstack | Имя раздела ini в файле cloustack.ini. |
|
| api_secret |
нет | Секретный ключ CloudStack API. |
||
| api_timeout |
нет | 10 | Таймаут HTTP. |
|
| api_url |
нет | URL CloudStack API, например, https://cloud.example.com/client/api. |
||
| custom_id |
нет | Пользовательский идентификатор ресурса. Доступно только для администраторов Root. |
||
| disk_offering |
нет | Имя предлагаемого диска. Требуется один из disk_offering, snapshot, если том еще не state=present. |
||
| display_volume |
нет | True | Отображать ли том конечному пользователю. Доступно только для администраторов Root. |
|
| domain |
нет | Имя домена, в котором должен быть развернут том. |
||
| force |
нет | Принудительно удалить том, даже если он подключен к виртуальной машине. Рассматривается только в state=absnet. |
||
| max_iops |
нет | Максимальное количество операций ввода-вывода в секунду. |
||
| min_iops |
нет | Минимальное количество операций ввода-вывода в секунду. |
||
| name |
да | Имя тома. name может содержать только символы ASCII. |
||
| poll_async |
нет | True | Ожидать завершения асинхронных задач. |
|
| project |
нет | Имя проекта, в котором должен быть развернут том. |
||
| shrink_ok |
нет | Разрешить уменьшение размера тома. |
||
| size |
нет | Размер диска в ГБ |
||
| snapshot |
нет | Имя моментального снимка для тома. Требуется один из disk_offering, snapshot, если том еще не state=present. |
||
| state |
нет | present |
|
Состояние тома. |
| tags (добавлено в 2.4)
|
нет | Список тегов. Теги представляют собой список словарей, имеющих ключи key и value. Чтобы удалить все теги, задайте пустой список, например, tags: []. псевдонимы: тег |
||
| vm |
нет | Имя виртуальной машины, к которой нужно подключить том. |
||
| zone |
нет | Имя зоны, в которой должен быть развернут том. Если не задано, используется зона по умолчанию. |
Примеры
# Create volume within project, zone with specified storage options
- local_action:
module: cs_volume
name: web-vm-1-volume
project: Integration
zone: ch-zrh-ix-01
disk_offering: PerfPlus Storage
size: 20
# Create/attach volume to instance
- local_action:
module: cs_volume
name: web-vm-1-volume
disk_offering: PerfPlus Storage
size: 20
vm: web-vm-1
state: attached
# Detach volume
- local_action:
module: cs_volume
name: web-vm-1-volume
state: detached
# Remove volume
- local_action:
module: cs_volume
name: web-vm-1-volume
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| подключен | Дата подключения тома. |
успешно | строка | 2014-12-01T14:57:57+0100 |
| создан | Дата создания тома. |
успешно | строка | 2014-12-01T14:57:57+0100 |
| device_id | Идентификатор устройства на виртуальной машине пользователя, к которому подключен том (не возвращается при отключении). |
успешно | строка | 1 |
| display_name | Имя отображения тома. |
успешно | строка | web-volume-01 |
| domain | Домен, к которому принадлежит том. |
успешно | строка | example domain |
| group | Группа, к которой принадлежит том. |
успешно | строка | web |
| id | Идентификатор тома. |
успешно | строка | None |
| name | Имя тома. |
успешно | строка | web-volume-01 |
| project | Проект, к которому принадлежит том. |
успешно | строка | Production |
| size | Размер тома. |
успешно | строка | 20 |
| state | Состояние тома. |
успешно | строка | Подключен |
| type | Тип тома. |
успешно | строка | DATADISK |
| vm | Имя виртуальной машины, к которой подключен том (не возвращается при отключении). |
успешно | строка | web-01 |
| zone | Имя зоны, в которой находится том. |
успешно | строка | ch-gva-2 |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких источников в указанном порядке: -CLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. Переменные средыCLOUDSTACK_TIMEOUT. - Переменная средыCLOUDSTACK_CONFIG, указывающая на файл.ini. - Файлcloudstack.iniв текущей рабочей директории. - Файл.cloudstack.iniв домашней директории пользователя. Допустимо указывать несколько учетных данных и конечных точек, используя разделы ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используетсяcloudstack. Более подробная информация на https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack доступно на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что авторы модуля гарантируют отсутствие несовместимых изменений в интерфейсе.
Для получения помощи в разработке модулей обратитесь к Информация о сообществе и сотрудничество, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_volume_module.html