JSON RPC

Module description

Storage - a subsystem that manages guest vm storage (libvirt + SP)

Operations

Clear libvirt storage pool

Context model: LibvirtStoragePoolsQ

Request data

{
    "context": {
        "op": "libvirt_pool_clear"
    },
    "data": {
        "uuid": "<uuid>",
        "name": "<name>",
        "sc_node": "<sc_node>"
    }
}

Description

uuid [ ] - UUID

name [ required ] - name

sc_node [ ] - Node UUID location (default - current node)

Add libvirt storage pool

Context model: LibvirtStoragePoolsQ

Request data

{
    "context": {
        "op": "libvirt_pool_add"
    },
    "data": {
        "name": "<name>",
        "descr": "<descr>",
        "sc_node": "<sc_node>",
        "labels": "<labels>"
    }
}

Description

name [ required ] - name

descr [ ] - Pool description

sc_node [ ] - Node UUID location (default - current node)

labels [ ] - Pool Labels

Show libvirt storage pool

Context model: LibvirtStoragePoolsQ

Request data

{
    "context": {
        "op": "libvirt_pool_show"
    },
    "data": {
        "uuid": "<uuid>",
        "name": "<name>",
        "sc_node": "<sc_node>"
    }
}

Description

uuid [ ] - UUID

name [ required ] - name

sc_node [ ] - Node UUID location (default - current node)

List libvirt storage pools

Context model: LibvirtStoragePoolsQ

Request data

{
    "context": {
        "op": "libvirt_pool_list"
    },
    "data": {
        "sc_node": "<sc_node>"
    }
}

Description

sc_node [ ] - Node UUID location (default - current node)

Clear libvirt storage volume

Context model: LibvirtStorageVolsQ

Request data

{
    "context": {
        "op": "libvirt_volume_clear"
    },
    "data": {
        "uuid": "<uuid>",
        "name": "<name>",
        "pool": "<pool>",
        "sc_node": "<sc_node>"
    }
}

Description

uuid [ ] - UUID

name [ required ] - Volume name

pool [ required ] - Pool name

sc_node [ ] - Node UUID location (default - current node)

Upload image to libvirt storage

Context model: LibvirtStorageVolsQ

Request data

{
    "context": {
        "op": "libvirt_image_upload"
    },
    "data": {
        "name": "<name>",
        "pool": "<pool>",
        "path": "<path>",
        "descr": "<descr>",
        "sc_node": "<sc_node>",
        "path_to": "<path_to>"
    }
}

Description

name [ required ] - Volume name

pool [ required ] - Pool name

path [ string required ] - Image path

descr [ ] - Volume description

sc_node [ ] - Node UUID location (default - current node)

path_to [ str ] - Placing an object in the directory structure

Add libvirt storage volume

Context model: LibvirtStorageVolsQ

Request data

{
    "context": {
        "op": "libvirt_volume_add"
    },
    "data": {
        "name": "<name>",
        "pool": "<pool>",
        "capacity": "<capacity>",
        "frmt": "<frmt>",
        "source": "<source>",
        "descr": "<descr>",
        "sc_node": "<sc_node>",
        "labels": "<labels>",
        "path_to": "<path_to>"
    }
}

Description

name [ required ] - Volume name

pool [ required ] - Pool name

capacity [ memstr required ] - Volume size

frmt [ ] - Volume format (default - qcow2)

source [ ] - Source volume name (clone)

descr [ ] - Volume description

sc_node [ ] - Node UUID location (default - current node)

labels [ ] - Volume Labels

path_to [ string ] - Placing an object in the directory structure

Add more capacity to libvirt storage volume

Context model: LibvirtStorageVolsQ

Request data

{
    "context": {
        "op": "libvirt_volume_update"
    },
    "data": {
        "name": "<name>",
        "pool": "<pool>",
        "capacity": "<capacity>",
        "sc_node": "<sc_node>"
    }
}

Description

name [ required ] - Volume name

pool [ required ] - Pool name

capacity [ memstr required ] - Volume size

sc_node [ ] - Node UUID location (default - current node)

Show libvirt storage volume

Context model: LibvirtStorageVolsQ

Request data

{
    "context": {
        "op": "libvirt_volume_show"
    },
    "data": {
        "uuid": "<uuid>",
        "name": "<name>",
        "pool": "<pool>",
        "sc_node": "<sc_node>"
    }
}

Description

uuid [ ] - UUID

name [ required ] - Volume name

pool [ required ] - Pool name

sc_node [ ] - Node UUID location (default - current node)

List libvirt storage volumes

Context model: LibvirtStorageVolsQ

Request data

{
    "context": {
        "op": "libvirt_volume_list"
    },
    "data": {
        "pool": "<pool>",
        "sc_node": "<sc_node>"
    }
}

Description

pool [ required ] - Pool name

sc_node [ ] - Node UUID location (default - current node)

Del libvirt storage volume

Context model: LibvirtStorageVolsQ

Request data

{
    "context": {
        "op": "libvirt_volume_del"
    },
    "data": {
        "uuid": "<uuid>",
        "name": "<name>",
        "pool": "<pool>",
        "sc_node": "<sc_node>",
        "del_type": "<del_type>",
        "del_iter": "<del_iter>"
    }
}

Description

uuid [ ] - UUID

name [ required ] - Volume name

pool [ required ] - Pool name

sc_node [ ] - Node UUID location (default - current node)

del_type [ ] - {{ no such element: dict object['desc'] }}

del_iter [ int ] - {{ no such element: dict object['desc'] }}

Del backup task

Context model: SnapshotsQ

Request data

{
    "context": {
        "op": "libvirt_backup_del"
    },
    "data": {
        "name": "<name>",
        "sc_node": "<sc_node>"
    }
}

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

{
    "context": {
        "op": "libvirt_backup_list"
    },
    "data": {
        "sc_node": "<sc_node>"
    }
}

Description

sc_node [ ] - Node UUID location (default - current node)

View full VM description from backup

Request data

{
    "context": {
        "op": "libvirt_backup_lookup"
    },
    "data": {
        "name": "<name>"
    }
}

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

Del libvirt storage pool

Context model: LibvirtStoragePoolsQ

Request data

{
    "context": {
        "op": "libvirt_pool_del"
    },
    "data": {
        "uuid": "<uuid>",
        "name": "<name>",
        "sc_node": "<sc_node>"
    }
}

Description

uuid [ ] - UUID

name [ required ] - name

sc_node [ ] - Node UUID location (default - current node)

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

{
    "context": {
        "op": "sp_template_show"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - The name of the template

List SP volumes templates

Context model: SPTemplate

Request data

{
    "context": {
        "op": "sp_template_list"
    }
}

Clear SP volumes templates

Context model: SPTemplate

Request data

{
    "context": {
        "op": "sp_template_clear"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - The name of the template

Delete SP volumes template

Context model: SPTemplate

Request data

{
    "context": {
        "op": "sp_template_del"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - The name of the template

List SP volumes template limit

Context model: SPTemplate

Request data

{
    "context": {
        "op": "sp_template_limit_list"
    }
}

View SP volumes template limit

Context model: SPTemplate

Request data

{
    "context": {
        "op": "sp_template_limit_show"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ required ] - The name of the template

The name of a placement group which describes the disks to be used

Request data

{
    "context": {
        "op": "sp_placementGroup_list"
    }
}

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

{
    "context": {
        "op": "sp_placementGroup_resources_reserved_del"
    },
    "data": {
        "place": "<place>"
    }
}

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

{
    "context": {
        "op": "sp_placementGroup_resources_reserved_list"
    }
}

Resource show for placement group

Request data

{
    "context": {
        "op": "sp_placementGroup_resources_show"
    },
    "data": {
        "place": "<place>"
    }
}

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>"
    }
}

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

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

{
    "context": {
        "op": "sp_volume_show"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

List SP volumes

Context model: SPVolume

Request data

{
    "context": {
        "op": "sp_volume_list"
    },
    "data": {
        "all": "<all>",
        "template": "<template>"
    }
}

Description

all [ ] - List all volumes ['yes', 'no']

template [ str ] - {{ no such element: dict object['desc'] }}

Clear SP volume

Context model: SPVolume

Request data

{
    "context": {
        "op": "sp_volume_clear"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

Delete SP volume

Context model: SPVolume

Request data

{
    "context": {
        "op": "sp_volume_del"
    },
    "data": {
        "uuid": "<uuid>",
        "force": "<force>"
    }
}

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

{
    "context": {
        "op": "sp_attach_list"
    }
}

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

{
    "context": {
        "op": "sp_snapshot_del"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

Clear SP volume snapshot

Context model: SPSnapshots

Request data

{
    "context": {
        "op": "sp_snapshot_clear"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

Show SP volume snapshot

Context model: SPSnapshots

Request data

{
    "context": {
        "op": "sp_snapshot_show"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

List SP volume snapshot

Context model: SPSnapshots

Request data

{
    "context": {
        "op": "sp_snapshot_list"
    },
    "data": {
        "volume_uuid": "<volume_uuid>"
    }
}

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

{
    "context": {
        "op": "sp_volume_freeze"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

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

{
    "context": {
        "op": "sp_volume_used_update"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

Add new mount to DB

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>"
    }
}

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 [ string ] - {{ no such element: dict object['desc'] }}

nodes [ str * required ] - Nodes to mount

ns [ str * required ] - Namespaces to access this mount

autocheck [ str ] - Enable autocheck for this mount ['yes', 'no']

check_timeout [ int ] - Time between checks in seconds (if autocheck is enabled)

descr [ str ] - Mount description

Mount the NFS file share

Request data

{
    "context": {
        "op": "nfs_mount_connect"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ str required ] - Mount UUID

Unmount the NFS file share

Request data

{
    "context": {
        "op": "nfs_mount_disconnect"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ str required ] - Mount UUID

Show mount info

Request data

{
    "context": {
        "op": "nfs_mount_show"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ str required ] - Mount UUID

List all mounts

Request data

{
    "context": {
        "op": "nfs_mount_list"
    }
}

Update mount settings (perform only if unmounted)

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>"
    }
}

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 [ string ] - {{ no such element: dict object['desc'] }}

autocheck [ str ] - Enable autocheck for this mount ['yes', 'no']

check_timeout [ int ] - Time between checks in seconds (if autocheck is enabled)

descr [ str ] - Mount description

Delete mount from DB

Request data

{
    "context": {
        "op": "nfs_mount_del"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ str required ] - Mount UUID

Add new nodes and mount them immediately (perform if the rest of nodes is already mounted)

Request data

{
    "context": {
        "op": "nfs_mount_nodes_add"
    },
    "data": {
        "nodes": "<nodes>",
        "uuid": "<uuid>"
    }
}

Description

nodes [ str * required ] - Nodes

uuid [ str required ] - Mount UUID

Delete some of the nodes from a mount (perform only if unmounted)

Request data

{
    "context": {
        "op": "nfs_mount_nodes_del"
    },
    "data": {
        "nodes": "<nodes>",
        "uuid": "<uuid>"
    }
}

Description

nodes [ str * required ] - Nodes

uuid [ str required ] - Mount UUID

Add new namespaces to a mount (perform only if mounted)

Request data

{
    "context": {
        "op": "nfs_mount_ns_add"
    },
    "data": {
        "uuid": "<uuid>",
        "ns": "<ns>"
    }
}

Description

uuid [ str required ] - Mount UUID

ns [ str * required ] - Namespaces to add

Delete some of the namespaces from a mount (perform only if unmounted)

Request data

{
    "context": {
        "op": "nfs_mount_ns_del"
    },
    "data": {
        "uuid": "<uuid>",
        "ns": "<ns>"
    }
}

Description

uuid [ str required ] - Mount UUID

ns [ str * required ] - Namespaces to delete

Check if connection is up for this mount (either on one node or all of them)

Request data

{
    "context": {
        "op": "nfs_mount_test"
    },
    "data": {
        "uuid": "<uuid>",
        "nodes": "<nodes>"
    }
}

Description

uuid [ str required ] - Mount UUID

nodes [ str * ] - Nodes to test

Create volume in nfs storage

Context model: NFSVolume

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>",
        "path_to": "<path_to>"
    }
}

Description

name [ required ] - The name of the volume

mount_uuid [ required ] - NFS mount name

size [ memstr ] - The volume size

type [ required ] - Volume type ['cdrom', 'system', 'datablock']

persistent [ required ] - Volume is persistent ['yes', 'no']

base_on [ ] - The uuid of an already existing volume that the new volume is to be a copy of

descr [ ] - Volume description

path_to [ str ] - Placing an object in the directory structure

Show NFS volume

Context model: NFSVolume

Request data

{
    "context": {
        "op": "nfs_volume_show"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

List NFS volumes

Request data

{
    "context": {
        "op": "nfs_volume_list"
    },
    "data": {
        "mount_uuid": "<mount_uuid>",
        "all": "<all>"
    }
}

Description

mount_uuid [ str ] - {{ no such element: dict object['desc'] }}

all [ ] - List all volumes ['yes', 'no']

Delete NFS volume

Context model: NFSVolume

Request data

{
    "context": {
        "op": "nfs_volume_del"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

Clear NFS volume

Context model: NFSVolume

Request data

{
    "context": {
        "op": "nfs_volume_clear"
    },
    "data": {
        "uuid": "<uuid>"
    }
}

Description

uuid [ required ] - Volume UUID

Import image to NFS storage

Context model: NFSVolume

Request data

{
    "context": {
        "op": "nfs_volume_import"
    },
    "data": {
        "name": "<name>",
        "mount_uuid": "<mount_uuid>",
        "type": "<type>",
        "persistent": "<persistent>",
        "descr": "<descr>",
        "path": "<path>",
        "path_to": "<path_to>"
    }
}

Description

name [ required ] - The name of the volume

mount_uuid [ required ] - NFS mount name

type [ required ] - Volume type ['cdrom', 'system', 'datablock']

persistent [ required ] - Volume is persistent ['yes', 'no']

descr [ ] - Volume description

path [ str required ] - Path to image (path folder or URL)

path_to [ str ] - Placing an object in the directory structure

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

descr [ ] - Pool description

sc_node [ ] - Node UUID location (default - current node)

labels [ ] - Pool Labels

LibvirtStorageVolsQ

uuid [ ] - UUID

name [ required ] - Volume name

pool [ required ] - Pool name

capacity [ memstr required ] - Volume size

frmt [ ] - Volume format (default - qcow2)

descr [ ] - Volume description

sc_node [ ] - Node UUID location (default - current node)

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']