cs_volume — Управляет томами на облаках Apache CloudStack.

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

Описание
- Требования
Параметры
Примечания
Примеры
Значения возврата
Статус
Техническое обслуживание
- Автор

Описание

Создание, удаление, присоединение, отсоединение томов.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account		Аккаунт, к которому относится том.
api_http_method	Варианты: get post	HTTP-метод, используемый для запроса к API-точке. Если не задано, используется переменная среды `CLOUDSTACK_METHOD`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию `get`, если не указано.
api_key		Ключ API для API CloudStack. Если не задано, используется переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region	Значение по умолчанию: "cloudstack"	Имя раздела в файле конфигурации `cloustack.ini`. Если не задано, используется переменная среды `CLOUDSTACK_REGION`.
api_secret		Секретный ключ API для CloudStack API. Если не задано, используется переменная среды `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout		Таймаут HTTP в секундах. Если не задано, используется переменная среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано.
api_url		URL API CloudStack, например, https://cloud.example.com/client/api. Если не задано, используется переменная среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
custom_id		Пользовательский идентификатор ресурса. Доступно только для администраторов.
disk_offering		Имя дискового предложения, которое будет использоваться. Требуется один из `disk_offering`, `snapshot`, если том ещё не `state=present`.
display_volume	Значение по умолчанию: "да"	Отображать ли том для конечного пользователя. Доступно только для администраторов.
domain		Имя домена, в котором должен быть развернут том.
force	Значение по умолчанию: "нет"	Принудительно удалить том, даже если он подключен к виртуальной машине. Применяется только в случае `state=absnet`.
max_iops		Максимальное количество операций ввода-вывода в секунду.
min_iops		Минимальное количество операций ввода-вывода в секунду.
name обязательно		Имя тома. `name` может содержать только символы ASCII.
poll_async	Значение по умолчанию: "да"	Проверять асинхронные задачи до завершения.
project		Имя проекта, в котором должен быть развернут том.
shrink_ok	Значение по умолчанию: "нет"	Разрешить уменьшение размера тома.
size		Размер диска в ГБ.
snapshot		Имя моментального снимка для тома. Требуется один из `disk_offering`, `snapshot`, если том ещё не `state=present`.
state	Варианты: present ← absent attached detached	Состояние тома.
tags (добавлено в 2.4)		Список тегов. Теги — список словарей, содержащих ключи `key` и `value`. Для удаления всех тегов задайте пустой список, например, `tags: []`. псевдонимы: tag
vm		Имя виртуальной машины, к которой необходимо подключить том.
zone		Имя зоны, в которой должен быть развернут том. Если не задано, используется зона по умолчанию.

Примечания

Примечание

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 можно найти в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: create volume within project and 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

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

- name: detach volume
  local_action:
    module: cs_volume
    name: web-vm-1-volume
    state: detached

- name: remove volume
  local_action:
    module: cs_volume
    name: web-vm-1-volume
    state: absent

Значения возврата

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

Ключ	Возвращаемое значение	Описание
attached строка	успех	Дата подключения тома. Пример: 2014-12-01T14:57:57+0100
created строка	успех	Дата создания тома. Пример: 2014-12-01T14:57:57+0100
device_id строка	успех	Идентификатор устройства на виртуальной машине пользователя, к которому подключен том (не возвращается при отключении). Пример: 1
display_name строка	успех	Отображаемое имя тома. Пример: web-volume-01
domain строка	успех	Домен, к которому принадлежит том. Пример: example domain
group строка	успех	Группа, к которой принадлежит том. Пример: web
id строка	успех	Идентификатор тома.
name строка	успех	Имя тома. Пример: web-volume-01
project строка	успех	Проект, к которому принадлежит том. Пример: Production
size строка	успех	Размер диска тома. Пример: 20
state строка	успех	Состояние тома. Пример: Подключен
type строка	успех	Тип диска тома. Пример: DATADISK
vm строка	успех	Имя виртуальной машины, к которой подключен том (не возвращается при отключении). Пример: web-01
zone строка	успех	Название зоны, в которой находится том. Пример: ch-gva-2

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

Jefferson Girão (@jeffersongirao)
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.6/modules/cs_volume_module.html