get_virtual_clients

(GET)/virtual_clients

Description

Gets the information of WIR virtual clients and of IR sessions for VMware or Hyper-V.

Request

Syntax

GET /api/virtual_clients/?type={type}&sid=1
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Optional filters include:

Filter	Description	Example
?sid={sid}	return only the virtual client on system id {sid}	GET /api/virtual_clients/?sid=1
type={type}	type of virtual clients to be returned either, "wir" or "vm_ir" or "hv_ir"	GET /api/virtual_clients/?type=wir&sid=1

Response

200 success

Parameters

Index	Value	Type	Returned
wir	windows instant recovery client information	array	always, may be empty
hv_ir	hyper-v instant recovery information	array	always, may be empty
vm_ir	VMware instant recovery information	array	always, may be empty
system_id	system id	long	always
system_name	system name	string	always

The information about virtual client instant recovery sessions includes:

Index	Value	Type	Returned
virtual_id	virtual id for the session appended with '.wir', '.hv_ir' or '.vm_ir'	string	always
id	virtual id	int	always
type	type of session, either "wir", "hv_ir", or "vm_ir"	string	always
hypervisor_type	type of hypervisor, "VMware Host" or "Hyper-V Host"	string	if WIR
vm_name	name of VM	string	always
server_name	name of host if vm_ir or client if hv_ir or wir	string	always
mode	mode of the VM	string	always

• | "new" |
• | "restore" |
• | "audit" |
• | "live" | pending_state | pending state of VM | string | if defined in case of WIR port | VNC port used by a virtual client hosted on the appliance | if exists in case of WIR valid | whether auto-restores are allowed | boolean | in case of WIR live_time | time when VM was first put in live mode | string | if WIR and if VM was in live mode ip_address | IP Address for a VFC hosted on a hypervisor | string | if exists in case of WIR vm_guid | GUID of the VM | string | if exists in case of WIR grandclient | whether the "real" client is grandclient | boolean | if WIR system_id | source system ID when "real" client is grandclient | long | if "grandclient" is true in case of WIR system_name | source system name when "real" client is grandclient | string | if "grandclient" is true in case of WIR status | status of the VM | string | always (1) created | date created, formatted as a string | string | always (1) duration | time this VM has existed, formatted as a string | string | always (1) comment | additional details for IR sessions | string | if vm_ir or hv_ir moref | Moref ID of the VM | int | if vm_ir GUID | GUID of the Hyper-V VM | string | if hv_ir

(1) - these fields are not supported in Release 1.

Example

Sample Request

GET /api/virtual_clients
GET /api/virtual_clients/?type=wir
GET /api/virtual_clients/?type=wir&sid=2
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

Sample Response

{
    "data": [
        {
            "hv_ir": [],
            "system_id": 5,
            "system_name": "UEB-2",
            "vm_ir": [],
            "wir": []
        },
         {
            "system_id": 2,
            "system_name": "UEB-CentOS6-lmc",
            "vm_ir": [
                 {
                     "created": "10/31/2014 01:08:43PM",
                     "duration": "24d 19h 43m",
                     "mode": "Audit",
                     "server_name": "vCenter-lmc",
                     "status": "error",
                     "type": "vm_ir",
                     "virtual_id": "34.vm_ir",
                     "id": 34,
                     "moref": 284,
                     "vm_name": "BoltVTA"
                 }
            ]
            "wir": [
                 {
                     "mode": "audit",
                     "server_name": "vCenter-lmc",
                     "hypervisor_type": "VMware Host",
                     "type": "wir",
                     "virtual_id": "34.wir",
                     "id": 34,
                     "vm_name": "BoltVTA",
                     "ip_addr": "192.168.10.56",
                     "vm_guid": "422ae741-9e05-57ab-0aa6-b06a54bdf513",
                     "grandclient": false
                  }
             ]
        }
    ],
    "timestamp": 1416919956
}