Get Virtual Hardware

Get Virtual Hardware

This request returns basic hardware information about the replicated VM.

Request
URI
GET
https://{api_host}/vm-replications/{replicationId}/virtual-hardware
COPY
Path Parameters
string
replicationId
Required

Cloud VM-level replication identifier

replicationId example
C4-ec991bd5-af9d-446a-8599-5b693842c4a3
Query Parameters
string
site
Optional

Optional site to run the operation on. When omitted, defaults to the local site.

site example
site1
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VirtualHardware of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "coresPerSocket": 1,
    "cpus": 4,
    "memoryMB": 8192,
    "storageMB": 10240
}
integer As int32 As int32
coresPerSocket
Optional

Number of virtual CPU cores per socket. When not available value is null.

integer As int32 As int32
cpus
Optional

Number of virtual CPUs in the virtual machine. When not available the value is -1.

integer As int32 As int32
memoryMB
Optional

Amount of virtual machine memory in megabytes. When not available the value is -1.

integer As int32 As int32
storageMB
Optional

Sum of the capacities of all replicated source disks in megabytes. When not available the value is null.


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.