JSON RPC
Module description
Storage - a subsystem that manages guest vm storage (libvirt + SP)
Operations
Del backup task
Context model: SnapshotsQ
Request data
Description
name [ ] - Snapshot name
sc_node [ ] - Node UUID location (default - current node)
Create backup task
Context model: SnapshotsQ
Request data
{
"context": {
"op": "libvirt_backup_add"
},
"data": {
"vm_name": "<vm_name>",
"sc_node": "<sc_node>",
"disks": "<disks>",
"timeout": "<timeout>"
}
}
Description
vm_name [ required ] - VM name
sc_node [ ] - Node, where vm located
disks [ * ] - vm disks to backup
timeout [ ] - timeout for backup
Show Backup
Context model: SnapshotsQ
Request data
{
"context": {
"op": "libvirt_backup_show"
},
"data": {
"name": "<name>",
"sc_node": "<sc_node>"
}
}
Description
name [ ] - Snapshot name
sc_node [ ] - Node UUID location (default - current node)
List Libvirt Backups
Context model: SnapshotsQ
Request data
Description
sc_node [ ] - Node UUID location (default - current node)
View full VM description from backup
Request data
Description
name [ required ] - VM name
Clear Snapshot definition
Context model: SnapshotsQ
Request data
{
"context": {
"op": "libvirt_snapshot_clear"
},
"data": {
"name": "<name>",
"vm_name": "<vm_name>",
"vcluster_name": "<vcluster_name>"
}
}
Description
name [ ] - Snapshot name
vm_name [ required ] - VM name
vcluster_name [ str required ] - Vcluster name
Add Snapshot
Context model: SnapshotsQ
Request data
{
"context": {
"op": "libvirt_snapshot_add"
},
"data": {
"uuid": "<uuid>",
"name": "<name>",
"vm_name": "<vm_name>",
"disks": "<disks>",
"descr": "<descr>",
"labels": "<labels>",
"vcluster_name": "<vcluster_name>"
}
}
Description
uuid [ ] - Snapshot UUID
name [ ] - Snapshot name
vm_name [ required ] - VM name
disks [ * ] - List of disks images
descr [ ] - Snapshot description
labels [ ] - {{ no such element: dict object['desc'] }}
vcluster_name [ str required ] - Vcluster name
Show Snapshot
Context model: SnapshotsQ
Request data
{
"context": {
"op": "libvirt_snapshot_show"
},
"data": {
"name": "<name>",
"vm_name": "<vm_name>",
"vcluster_name": "<vcluster_name>"
}
}
Description
name [ ] - Snapshot name
vm_name [ required ] - VM name
vcluster_name [ str required ] - Vcluster name
List Snapshots
Context model: SnapshotsQ
Request data
{
"context": {
"op": "libvirt_snapshot_list"
},
"data": {
"vm_name": "<vm_name>",
"request_name": "<request_name>",
"vcluster_name": "<vcluster_name>"
}
}
Description
vm_name [ str ] - Vm name
request_name [ str ] - Request name
vcluster_name [ str required ] - Vcluster name
Del Snapshot
Context model: SnapshotsQ
Request data
{
"context": {
"op": "libvirt_snapshot_del"
},
"data": {
"name": "<name>",
"vm_name": "<vm_name>",
"vcluster_name": "<vcluster_name>"
}
}
Description
name [ ] - Snapshot name
vm_name [ required ] - VM name
vcluster_name [ str required ] - Vcluster name
Update SP volume template
Context model: SPTemplate
Request data
{
"context": {
"op": "sp_template_update"
},
"data": {
"bw": "<bw>",
"iops": "<iops>",
"descr": "<descr>",
"name": "<name>",
"parent": "<parent>",
"replication": "<replication>",
"reuse_server": "<reuse_server>",
"capacity": "<capacity>",
"ns": "<ns>"
}
}
Description
bw [ ] - Bandwidth limit in KB
iops [ ] - Iops limit
descr [ ] - Volume template description
name [ required ] - The name of the template
parent [ ] - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
replication [ int ] - Replication copies count
reuse_server [ ] - Allow placement of replicas on same server
capacity [ memstr ] - Template size limit
ns [ str ] - Namespace owner
Add SP volume template
Context model: SPTemplate
Request data
{
"context": {
"op": "sp_template_add"
},
"data": {
"bw": "<bw>",
"iops": "<iops>",
"descr": "<descr>",
"name": "<name>",
"parent": "<parent>",
"place": "<place>",
"replication": "<replication>",
"reuse_server": "<reuse_server>",
"capacity": "<capacity>",
"ns": "<ns>"
}
}
Description
bw [ ] - Bandwidth limit in KB
iops [ ] - Iops limit
descr [ ] - Volume template description
name [ required ] - The name of the template
parent [ ] - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
place [ required ] - The name of a placement group which describes the disks to be used for all but the last replica
replication [ required ] - A default number of copies to be kept by StoragePool.The value must be of one of the following types: Replication
reuse_server [ ] - Allow placement of replicas on same server
capacity [ memstr required ] - capacity
ns [ required ] - Virtual DC
Show SP volumes template
Context model: SPTemplate
Request data
Description
name [ required ] - The name of the template
List SP volumes templates
Context model: SPTemplate
Request data
Clear SP volumes templates
Context model: SPTemplate
Request data
Description
name [ required ] - The name of the template
Delete SP volumes template
Context model: SPTemplate
Request data
Description
name [ required ] - The name of the template
List SP volumes template limit
Context model: SPTemplate
Request data
View SP volumes template limit
Context model: SPTemplate
Request data
Description
name [ required ] - The name of the template
The name of a placement group which describes the disks to be used
Request data
Add amount reserved inside placementGroup
Context model: SPResources
Request data
{
"context": {
"op": "sp_placementGroup_resources_reserved_add"
},
"data": {
"place": "<place>",
"reserved": "<reserved>"
}
}
Description
place [ str required ] - PlacementGroup name
reserved [ memstr ] - Value subtituted from placementGroup limit
Update amount reserved inside placementGroup
Context model: SPResources
Request data
{
"context": {
"op": "sp_placementGroup_resources_reserved_update"
},
"data": {
"place": "<place>",
"reserved": "<reserved>"
}
}
Description
place [ str required ] - PlacementGroup name
reserved [ memstr ] - Value subtituted from placementGroup limit
Del reserved inside placementGroup
Context model: SPResources
Request data
Description
place [ str required ] - PlacementGroup name
Show reserved inside placementGroup
Context model: SPResources
Request data
{
"context": {
"op": "sp_placementGroup_resources_reserved_show"
},
"data": {
"place": "<place>"
}
}
Description
place [ str required ] - PlacementGroup name
List reserved inside placementGroup
Context model: SPResources
Request data
Resource show for placement group
Request data
Description
place [ str required ] - {{ no such element: dict object['desc'] }}
Update SP volume
Context model: SPVolume
Request data
{
"context": {
"op": "sp_volume_update"
},
"data": {
"uuid": "<uuid>",
"name": "<name>",
"descr": "<descr>",
"bw": "<bw>",
"iops": "<iops>",
"reuse_server": "<reuse_server>",
"size": "<size>",
"type": "<type>",
"persistent": "<persistent>"
}
}
Description
uuid [ required ] - Volume UUID
name [ str ] - Volume name
descr [ ] - Volume description
bw [ ] - Bandwidth limit in KB
iops [ ] - Iops limit
reuse_server [ ] - Allow placement of replicas on same server
size [ memstr ] - The volume size.
type [ ] - Volume type ['cdrom', 'system', 'datablock']
persistent [ ] - Volume type ['yes', 'no']
Import iso/qcow2 image to SP storage
Context model: SPVolume
Request data
{
"context": {
"op": "sp_volume_import"
},
"data": {
"name": "<name>",
"descr": "<descr>",
"type": "<type>",
"template": "<template>",
"persistent": "<persistent>",
"path": "<path>",
"path_to": "<path_to>",
"md5hash": "<md5hash>",
"sha256hash": "<sha256hash>"
}
}
Description
name [ required ] - The name of the volume
descr [ ] - Volume description
type [ required ] - Volume type ['cdrom', 'system', 'datablock']
template [ required ] - The template that the volume settings are inherited from
persistent [ required ] - Volume is persistent ['yes', 'no']
path [ str required ] - Path to iso/qcow2 image (path folder or URL)
path_to [ str ] - Placing an object in the directory structure
md5hash [ str ] - Volume hash for validation
sha256hash [ str ] - Volume hash for validation
Export SP volume from storage to local storage
Context model: SPVolume
Request data
{
"context": {
"op": "sp_volume_export"
},
"data": {
"uuid": "<uuid>",
"export_name": "<export_name>",
"export_format": "<export_format>"
}
}
Description
uuid [ required ] - Volume UUID
export_name [ str required ] - Export name
export_format [ ] - Export format ['qcow2', 'iso']
Add SP volume
Context model: SPVolume
Request data
{
"context": {
"op": "sp_volume_add"
},
"data": {
"bw": "<bw>",
"iops": "<iops>",
"descr": "<descr>",
"name": "<name>",
"parent": "<parent>",
"reuse_server": "<reuse_server>",
"size": "<size>",
"template": "<template>",
"base_on": "<base_on>",
"type": "<type>",
"persistent": "<persistent>",
"path_to": "<path_to>"
}
}
Description
bw [ ] - Bandwidth limit in KB
iops [ ] - Iops limit
descr [ ] - Volume description
name [ required ] - The name of the volume
parent [ ] - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
reuse_server [ ] - Allow placement of replicas on same server
size [ memstr required ] - The volume size in bytes.
template [ required ] - The template that the volume settings are inherited from
base_on [ ] - The name of an already existing volume that the new volume is to be a copy of
type [ required ] - Volume type ['cdrom', 'system', 'datablock']
persistent [ required ] - Volume is persistent ['yes', 'no']
path_to [ str ] - Placing an object in the directory structure
Show SP volume
Context model: SPVolume
Request data
Description
uuid [ required ] - Volume UUID
List SP volumes
Context model: SPVolume
Request data
Description
all [ ] - List all volumes ['yes', 'no']
template [ str ] - {{ no such element: dict object['desc'] }}
Clear SP volume
Context model: SPVolume
Request data
Description
uuid [ required ] - Volume UUID
Delete SP volume
Context model: SPVolume
Request data
Description
uuid [ required ] - Volume UUID
force [ ] - Forced removal of snapshots. Default - no ['yes', 'no']
Attach SP volume
Request data
{
"context": {
"op": "sp_attach_volume"
},
"data": {
"volume_uuid": "<volume_uuid>",
"mode": "<mode>",
"sc_uuid": "<sc_uuid>"
}
}
Description
volume_uuid [ str required ] - Volume uuid
mode [ required ] - The mode of the volume ['rw', 'ro']
sc_uuid [ str required ] - UUID node to attach
Show attach SP volume
Request data
{
"context": {
"op": "sp_attach_show"
},
"data": {
"volume_uuid": "<volume_uuid>",
"sc_uuid": "<sc_uuid>"
}
}
Description
volume_uuid [ str required ] - Volume UUID
sc_uuid [ str ] - UUID node to attach
List SP volumes attached
Request data
Detach SP volume
Request data
{
"context": {
"op": "sp_detach_volume"
},
"data": {
"volume_uuid": "<volume_uuid>",
"sc_uuid": "<sc_uuid>",
"force": "<force>"
}
}
Description
volume_uuid [ str required ] - Volume uuid
sc_uuid [ str required ] - UUID node to attach
force [ bool ] - The clients on which to attach the volume as read only
Add SP volume snapshot
Context model: SPSnapshots
Request data
{
"context": {
"op": "sp_snapshot_add"
},
"data": {
"name": "<name>",
"descr": "<descr>",
"volume_uuid": "<volume_uuid>"
}
}
Description
name [ required ] - The name of the volume
descr [ ] - Volume description
volume_uuid [ required ] - Volume UUID
Update SP volume snapshot
Context model: SPSnapshots
Request data
{
"context": {
"op": "sp_snapshot_update"
},
"data": {
"uuid": "<uuid>",
"name": "<name>",
"descr": "<descr>",
"delete_after": "<delete_after>"
}
}
Description
uuid [ required ] - Volume UUID
name [ str ] - Snapshot name
descr [ str ] - Description of snapshot
delete_after [ int ] - Delete snapshots after X seconds (If not 0 set targetDeleteDate relative to the current time)
Del SP volume snapshot
Context model: SPSnapshots
Request data
Description
uuid [ required ] - Volume UUID
Clear SP volume snapshot
Context model: SPSnapshots
Request data
Description
uuid [ required ] - Volume UUID
Show SP volume snapshot
Context model: SPSnapshots
Request data
Description
uuid [ required ] - Volume UUID
List SP volume snapshot
Context model: SPSnapshots
Request data
Description
volume_uuid [ string ] - {{ no such element: dict object['desc'] }}
Create SP volume from volume or snapshot
Request data
{
"context": {
"op": "sp_volume_fromparent"
},
"data": {
"name": "<name>",
"snapshot_uuid": "<snapshot_uuid>",
"type": "<type>",
"persistent": "<persistent>"
}
}
Description
name [ string required ] - {{ no such element: dict object['desc'] }}
snapshot_uuid [ string required ] - {{ no such element: dict object['desc'] }}
type [ required ] - Volume type ['cdrom', 'system', 'datablock']
persistent [ required ] - Volume is persistent ['yes', 'no']
Convert the SP volume to a snapshot (volume to be removed)
Context model: SPVolume
Request data
Description
uuid [ required ] - Volume UUID
Revert SP volume to snapshot
Context model: SPVolume
Request data
{
"context": {
"op": "sp_volume_revert"
},
"data": {
"uuid": "<uuid>",
"snapshot_uuid": "<snapshot_uuid>"
}
}
Description
uuid [ required ] - Volume UUID
snapshot_uuid [ string required ] - Snapshot uuid
Update the used status for SP volume
Context model: SPVolume
Request data
Description
uuid [ required ] - Volume UUID
libvirt_pool_add
Request data
{
"context": {
"op": "libvirt_pool_add"
},
"data": {
"name": "<name>",
"capacity": "<capacity>",
"ns": "<ns>",
"descr": "<descr>"
}
}
Description
name [ str required ] - Name of Lidvirt pool
capacity [ str required ] - Pool capacity
ns [ str required ] - Namespace what is attached libvirt pool
descr [ str ] - Libvirt pool description
libvirt_pool_list
Request data
Description
ns [ str ] - Name of Namespace
libvirt_pool_show
Request data
{
"context": {
"op": "libvirt_pool_show"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"get_pool_full_info": "<get_pool_full_info>"
}
}
Description
name [ str ] - Name of Lidvirt pool
uuid [ str ] - Libvirt pool UUID
get_pool_full_info [ str ] - Get pool full information ['yes', 'no']
libvirt_pool_del
Request data
{
"context": {
"op": "libvirt_pool_del"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"get_pool_full_info": "<get_pool_full_info>"
}
}
Description
name [ str ] - Name of Lidvirt pool
uuid [ str ] - Libvirt pool UUID
get_pool_full_info [ str ] - Get pool full information ['yes', 'no']
libvirt_pool_clear
Request data
{
"context": {
"op": "libvirt_pool_clear"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"get_pool_full_info": "<get_pool_full_info>"
}
}
Description
name [ str ] - Name of Lidvirt pool
uuid [ str ] - Libvirt pool UUID
get_pool_full_info [ str ] - Get pool full information ['yes', 'no']
libvirt_pool_resources_show
Request data
libvirt_pool_update
Request data
{
"context": {
"op": "libvirt_pool_update"
},
"data": {
"name": "<name>",
"capacity": "<capacity>",
"descr": "<descr>"
}
}
Description
name [ str required ] - Name of Lidvirt pool
capacity [ str ] - Pool capacity
descr [ str ] - Libvirt pool description
libvirt_image_upload
Request data
{
"context": {
"op": "libvirt_image_upload"
},
"data": {
"name": "<name>",
"path": "<path>",
"local_path": "<local_path>",
"type": "<type>",
"persistent": "<persistent>",
"description": "<description>"
}
}
Description
name [ str required ] - Name of Libvirt volume what will be created
path [ str required ] - Path image in file system
local_path [ str ] - Path image in local file system
type [ str required ] - The volume type ['cdrom', 'system', 'datablock']
persistent [ str required ] - Volume is persistent (yes or no) ['yes', 'no']
description [ str ] - Volume description
libvirt_volume_add
Request data
{
"context": {
"op": "libvirt_volume_add"
},
"data": {
"name": "<name>",
"capacity": "<capacity>",
"type": "<type>",
"frmt": "<frmt>",
"persistent": "<persistent>",
"base_on": "<base_on>",
"source": "<source>",
"descr": "<descr>",
"labels": "<labels>"
}
}
Description
name [ str required ] - Name of Lidvirt volume
capacity [ str required ] - Volume capacity
type [ str required ] - The volume type ['cdrom', 'system', 'datablock']
frmt [ str ] - Volume format (default - qcow2)
persistent [ str required ] - Volume is persistent (yes or no) ['yes', 'no']
base_on [ str ] - The volume base on name
source [ str ] - Source volume name (clone)
descr [ str ] - Volume description
labels [ str ] - Volume labels
libvirt_volume_list
Request data
libvirt_volume_show
Request data
{
"context": {
"op": "libvirt_volume_show"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"get_volume_full_info": "<get_volume_full_info>"
}
}
Description
name [ str ] - Name of Libvirt volume
uuid [ str ] - Libvirt volume UUID
get_volume_full_info [ str ] - Get volume full information ['yes', 'no']
libvirt_volume_resources_show
Request data
libvirt_volume_update
Request data
{
"context": {
"op": "libvirt_volume_update"
},
"data": {
"uuid": "<uuid>",
"capacity": "<capacity>",
"type": "<type>",
"persistent": "<persistent>",
"descr": "<descr>"
}
}
Description
uuid [ str required ] - Libvirt pool UUID
capacity [ str ] - Volume capacity
type [ str ] - The volume type ['cdrom', 'system', 'datablock']
persistent [ str ] - Volume is persistent (yes or no) ['yes', 'no']
descr [ str ] - Volume description
libvirt_volume_del
Request data
{
"context": {
"op": "libvirt_volume_del"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"get_volume_full_info": "<get_volume_full_info>"
}
}
Description
name [ str ] - Name of Libvirt volume
uuid [ str ] - Libvirt volume UUID
get_volume_full_info [ str ] - Get volume full information ['yes', 'no']
libvirt_volume_clear
Request data
{
"context": {
"op": "libvirt_volume_clear"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"get_volume_full_info": "<get_volume_full_info>"
}
}
Description
name [ str ] - Name of Libvirt volume
uuid [ str ] - Libvirt volume UUID
get_volume_full_info [ str ] - Get volume full information ['yes', 'no']
nfs_mount_add
Request data
{
"context": {
"op": "nfs_mount_add"
},
"data": {
"name": "<name>",
"nfs_server": "<nfs_server>",
"shared_folder_path": "<shared_folder_path>",
"mount_point": "<mount_point>",
"params": "<params>",
"nodes": "<nodes>",
"ns": "<ns>",
"autocheck": "<autocheck>",
"check_timeout": "<check_timeout>",
"descr": "<descr>",
"capacity": "<capacity>"
}
}
Description
name [ str required ] - Name of NFS mount
nfs_server [ str required ] - IP of NFS server
shared_folder_path [ str required ] - Path to shared folder
mount_point [ str ] - Folder where shared folder should be mounted
params [ str ] - List of params for NFS mount command
nodes [ str * ] - Nodes to mount
ns [ str * required ] - Namespaces to access this mount
autocheck [ str ] - Enable autocheck for this mount
check_timeout [ int ] - Time between checks in seconds
descr [ str ] - Mount description
capacity [ str required ] - Mount capacity limit
nfs_mount_connect
Request data
Description
uuid [ str required ] - Mount UUID
nfs_mount_disconnect
Request data
Description
uuid [ str required ] - Mount UUID
nfs_mount_list
Request data
nfs_mount_show
Request data
Description
uuid [ str required ] - Mount UUID
nfs_mount_update
Request data
{
"context": {
"op": "nfs_mount_update"
},
"data": {
"uuid": "<uuid>",
"name": "<name>",
"nfs_server": "<nfs_server>",
"shared_folder_path": "<shared_folder_path>",
"mount_point": "<mount_point>",
"params": "<params>",
"autocheck": "<autocheck>",
"check_timeout": "<check_timeout>",
"descr": "<descr>",
"capacity": "<capacity>"
}
}
Description
uuid [ str required ] - Mount UUID
name [ str ] - Name of NFS mount
nfs_server [ str ] - IP of NFS server
shared_folder_path [ str ] - Path to shared folder
mount_point [ str ] - Folder where shared folder should be mounted
params [ str ] - List of params for NFS mount command
autocheck [ str ] - Enable autocheck for this mount
check_timeout [ int ] - Time between checks in seconds
descr [ str ] - Mount description
capacity [ str ] - Mount capacity limit
nfs_mount_del
Request data
Description
uuid [ str required ] - Mount UUID
nfs_mount_nodes_add
Request data
Description
uuid [ str required ] - Mount UUID
nodes [ str * ] - Node UUIDs
nfs_mount_nodes_del
Request data
Description
uuid [ str required ] - Mount UUID
nodes [ str * ] - Node UUIDs
nfs_mount_ns_add
Request data
Description
uuid [ str required ] - Mount UUID
ns [ str * required ] - Namespaces
nfs_mount_ns_del
Request data
Description
uuid [ str required ] - Mount UUID
ns [ str * required ] - Namespaces
nfs_mount_test
Request data
Description
uuid [ str required ] - Mount UUID
nodes [ str * ] - Nodes to check
nfs_volume_add
Request data
{
"context": {
"op": "nfs_volume_add"
},
"data": {
"name": "<name>",
"mount_uuid": "<mount_uuid>",
"size": "<size>",
"type": "<type>",
"persistent": "<persistent>",
"base_on": "<base_on>",
"descr": "<descr>",
"vm_uuid": "<vm_uuid>",
"path_to": "<path_to>"
}
}
Description
name [ str required ] - The name of the volume
mount_uuid [ str required ] - NFS mount name
size [ str ] - The volume size
type [ str required ] - The volume type ['cdrom', 'system', 'datablock']
persistent [ str required ] - Volume is persistent (yes or no) ['yes', 'no']
base_on [ str ] - The volume base on name
descr [ str ] - Description of the volume
vm_uuid [ str ] - Vm uuid
path_to [ str ] - Placing an object in the directory structure
nfs_volume_vm_add
Request data
{
"context": {
"op": "nfs_volume_vm_add"
},
"data": {
"volume_uuid": "<volume_uuid>",
"vm_uuid": "<vm_uuid>",
"vm_name": "<vm_name>"
}
}
Description
volume_uuid [ str required ] - The uuid of the volume
vm_uuid [ str required ] - The uuid of the vm
vm_name [ str ] - The name of the vm
nfs_volume_show
Request data
{
"context": {
"op": "nfs_volume_show"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"mount_uuid": "<mount_uuid>",
"get_full_name": "<get_full_name>"
}
}
Description
name [ str ] - The name of the volume
uuid [ str ] - The uuid of the volume
mount_uuid [ str ] - NFS mount uuid
get_full_name [ int ] - Show full name of disk
nfs_volume_list
Request data
{
"context": {
"op": "nfs_volume_list"
},
"data": {
"mount_uuid": "<mount_uuid>",
"get_full_name": "<get_full_name>",
"all": "<all>"
}
}
Description
mount_uuid [ str ] - Show volumes of mount
get_full_name [ str ] - Show full name of disk ['yes', 'no']
all [ str ] - Show vm base_on volumes ['yes', 'no']
nfs_volume_del
Request data
{
"context": {
"op": "nfs_volume_del"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"mount_uuid": "<mount_uuid>",
"get_full_name": "<get_full_name>"
}
}
Description
name [ str ] - The name of the volume
uuid [ str ] - The uuid of the volume
mount_uuid [ str ] - NFS mount uuid
get_full_name [ int ] - Show full name of disk
nfs_volume_clear
Request data
{
"context": {
"op": "nfs_volume_clear"
},
"data": {
"name": "<name>",
"uuid": "<uuid>",
"mount_uuid": "<mount_uuid>",
"get_full_name": "<get_full_name>"
}
}
Description
name [ str ] - The name of the volume
uuid [ str ] - The uuid of the volume
mount_uuid [ str ] - NFS mount uuid
get_full_name [ int ] - Show full name of disk
nfs_volume_vm_del
Request data
{
"context": {
"op": "nfs_volume_vm_del"
},
"data": {
"volume_uuid": "<volume_uuid>",
"vm_uuid": "<vm_uuid>",
"vm_name": "<vm_name>"
}
}
Description
volume_uuid [ str required ] - The uuid of the volume
vm_uuid [ str required ] - The uuid of the vm
vm_name [ str ] - The name of the vm
nfs_volume_import
Request data
{
"context": {
"op": "nfs_volume_import"
},
"data": {
"name": "<name>",
"mount_uuid": "<mount_uuid>",
"type": "<type>",
"descr": "<descr>",
"persistent": "<persistent>",
"path": "<path>",
"path_to": "<path_to>"
}
}
Description
name [ str required ] - The name of the volume
mount_uuid [ str required ] - NFS mount name
type [ str required ] - The volume type ['cdrom', 'system', 'datablock']
descr [ str ] - Description of the volume
persistent [ str required ] - Volume is persistent (yes or no) ['yes', 'no']
path [ str required ] - path or URL of the volume
path_to [ str ] - Placing an object in the directory structure
nfs_volume_used_update
Request data
{
"context": {
"op": "nfs_volume_used_update"
},
"data": {
"volume_uuid": "<volume_uuid>",
"vm_name": "<vm_name>",
"op": "<op>"
}
}
Description
volume_uuid [ str required ] - The uuid of the volume
vm_name [ str required ] - The name of the vm
op [ str required ] - Update volume used ['add', 'del']
nfs_snapshot_add
Request data
{
"context": {
"op": "nfs_snapshot_add"
},
"data": {
"uuid": "<uuid>",
"name": "<name>",
"vm_name": "<vm_name>",
"vcluster_name": "<vcluster_name>",
"disks": "<disks>",
"descr": "<descr>",
"labels": "<labels>"
}
}
Description
uuid [ str ] - Snapshot UUID
name [ str required ] - Snapshot name
vm_name [ str required ] - VM name
vcluster_name [ str required ] - Vcluster name
disks [ str * ] - List of disks
descr [ str ] - Snapshot description
labels [ str ] - Snapshot labels
nfs_snapshot_del
Request data
Description
uuid [ str required ] - Snapshot UUID
nfs_snapshot_show
Request data
Description
uuid [ str required ] - Snapshot UUID
nfs_snapshot_list
Request data
{
"context": {
"op": "nfs_snapshot_list"
},
"data": {
"vcluster_name": "<vcluster_name>",
"request_name": "<request_name>",
"vm_name": "<vm_name>"
}
}
Description
vcluster_name [ str required ] - Vcluster name
request_name [ str ] - Request name
vm_name [ str ] - VM name
sp_volume_status
Request data
Description
uuid [ str required ] - Volume uuid
Models
SnapshotsQ
uuid [ ] - Snapshot UUID
name [ ] - Snapshot name
vm_name [ required ] - VM name
disks [ * ] - List of disks images
descr [ ] - Snapshot description
sc_node [ ] - Node UUID location (default - current node)
labels [ ] - {{ no such element: dict object['desc'] }}
LibvirtStoragePoolsQ
uuid [ ] - UUID
name [ required ] - name
capacity [ memstr required ] - Pool size
ns [ required ] - Namespace to which pool will be attached
descr [ ] - Pool description
LibvirtStorageVolsQ
uuid [ ] - UUID
name [ required ] - Volume name
capacity [ memstr required ] - Volume size
frmt [ ] - Volume format (default - qcow2)
descr [ ] - Volume description
labels [ ] - Volume Labels
SPTemplate
name [ required ] - The name of the template
replication [ required ] - A default number of copies to be kept by StoragePool.The value must be of one of the following types: Replication
bw [ ] - Bandwidth limit in KB
iops [ ] - Iops limit
descr [ ] - Volume template description
parent [ ] - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
place [ required ] - The name of a placement group which describes the disks to be used for all but the last replica
reuse_server [ ] - Allow placement of replicas on same server
capacity [ memstr required ] - capacity
ns [ required ] - Virtual DC
SPVolume
uuid [ required ] - Volume UUID
name [ required ] - The name of the volume
bw [ ] - Bandwidth limit in KB
iops [ ] - Iops limit
descr [ ] - Volume description
parent [ ] - The name of the snapshot on which volumes will be based.The value must be of one of the following types: SnapshotName
reuse_server [ ] - Allow placement of replicas on same server
template [ required ] - The template that the volume settings are inherited from
size [ memstr required ] - The volume size in bytes.
base_on [ ] - The name of an already existing volume that the new volume is to be a copy of
type [ required ] - Volume type ['cdrom', 'system', 'datablock']
persistent [ required ] - Volume is persistent ['yes', 'no']
SPSnapshots
uuid [ required ] - Volume UUID
name [ required ] - The name of the volume
descr [ ] - Volume description
volume_uuid [ required ] - Volume UUID
SPResources
place [ str required ] - PlacementGroup name
reserved [ memstr ] - Value subtituted from placementGroup limit
NFSVolume
uuid [ required ] - Volume UUID
name [ required ] - The name of the volume
mount_uuid [ required ] - NFS mount name
descr [ ] - Volume description
parent [ ] - The name of the snapshot on which volumes will be based
size [ memstr ] - The volume size
base_on [ ] - The uuid of an already existing volume that the new volume is to be a copy of
type [ required ] - Volume type ['cdrom', 'system', 'datablock']
persistent [ required ] - Volume is persistent ['yes', 'no']