Net3 API Interface for Customer Portal

<back to all web services

VMWareManage

Requires Authentication
The following routes are available for this service:
POST/vmwaremanage
VMWareManage Parameters:
NameParameterData TypeRequiredDescription
JobIdbodystringNo
StartVMbodyboolNo
VMWareManageBase Parameters:
NameParameterData TypeRequiredDescription
userIdformstringNo
ORGNameformstringNo
DataCenterLocationformstringNo
VMNameformstringNo
VMWareManageResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeVMNo
ResponseStatusformResponseStatusNo
TypeVM Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
NameLongformstringNo
StatusformstringNo
CPUformintNo
MemoryformulongNo
DiskSizeformList<ulong>No
HrefformstringNo
IdformstringNo
DiskCountformintNo
catalogNameformstringNo
containerformstringNo
containerNameformstringNo
guestOsformstringNo
hardwareVersionformintNo
hardwareVersionSpecifiedformboolNo
isBusyformboolNo
isBusySpecifiedformboolNo
isDeletedformboolNo
isDeletedSpecifiedformboolNo
isDeployedformboolNo
isDeployedSpecifiedformboolNo
isInMaintenanceModeformboolNo
isInMaintenanceModeSpecifiedformboolNo
isPublishedformboolNo
isPublishedSpecifiedformboolNo
isVAppTemplateformboolNo
isVAppTemplateSpecifiedformboolNo
memoryMBformintNo
memoryMBSpecifiedformboolNo
numberOfCpusformintNo
numberOfCpusSpecifiedformboolNo
storageProfileNameformstringNo
vdcformstringNo
hasDRformboolNo
isDRActiveformboolNo
CpuHotAddEnabledSpecifiedformboolNo
CpuHotAddEnabledformboolNo
MemoryHotAddEnabledSpecifiedformboolNo
MemoryHotAddEnabledformboolNo
vmToolsVersionformintNo
vmToolsVersionSpecifiedformboolNo
vcformstringNo
morefformstringNo
hostNameformstringNo
vmHostTypeformstringNo
networkInfoRawformstringNo
vmInstanceTypeformstringNo
MetricformSimpleMetricType[]No
DisksformList<TypeDisk>No
NicsformList<TypeNic>No
NetworkConnectionSectionformNetworkConnectionSectionNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
errorMessageformstringNo
errorCodeformintNo
errorStatusformboolNo
SimpleMetricType Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
unitformstringNo
valueformdecimalNo
TypeDisk Parameters:
NameParameterData TypeRequiredDescription
autoDeleteformboolNo
bootformboolNo
deviceNameformstringNo
indexformintNo
interface__formstringNo
kindformstringNo
licensesformstring[]No
modeformstringNo
sourceformstringNo
typeformstringNo
sizeformulongNo
TypeNic Parameters:
NameParameterData TypeRequiredDescription
VMIdformstringNo
VMNameformstringNo
NicIdformstringNo
NicNameformstringNo
IsConnectedformboolNo
NetworkNameformstringNo
NetworkIdformstringNo
IsPrimaryNicformboolNo
IPModeformstringNo
IPAddressformstringNo
MacAddressformstringNo
NetworkAdapterTypeformstringNo
NetworkConnectionSection Parameters:
NameParameterData TypeRequiredDescription
InfoformstringNo
PrimaryNetworkConnectionIndexformintNo
NetworkConnectionformNetworkConnectionNo
LinkformLinkTypeNo
requiredformboolNo
hrefformstringNo
typeformstringNo
NetworkConnection Parameters:
NameParameterData TypeRequiredDescription
NetworkConnectionIndexformintNo
IpAddressformstringNo
ExternalIpAddressformstringNo
IsConnectedformboolNo
MACAddressformstringNo
IpAddressAllocationModeformstringNo
needsCustomizationformboolNo
networkformstringNo
LinkType Parameters:
NameParameterData TypeRequiredDescription
hrefformstringNo
idformstringNo
typeformstringNo
nameformstringNo
relformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /vmwaremanage HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"jobId":"String","startVM":false,"userId":"String","orgName":"String","dataCenterLocation":"String","vmName":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":{"name":"String","nameLong":"String","status":"String","cpu":0,"memory":0,"diskSize":[0],"href":"String","id":"String","diskCount":1,"catalogName":"String","container":"String","containerName":"String","guestOs":"String","hardwareVersion":0,"hardwareVersionSpecified":false,"isBusy":false,"isBusySpecified":false,"isDeleted":false,"isDeletedSpecified":false,"isDeployed":false,"isDeployedSpecified":false,"isInMaintenanceMode":false,"isInMaintenanceModeSpecified":false,"isPublished":false,"isPublishedSpecified":false,"isVAppTemplate":false,"isVAppTemplateSpecified":false,"memoryMB":0,"memoryMBSpecified":false,"numberOfCpus":0,"numberOfCpusSpecified":false,"storageProfileName":"String","vdc":"String","hasDR":false,"isDRActive":false,"cpuHotAddEnabledSpecified":false,"cpuHotAddEnabled":false,"memoryHotAddEnabledSpecified":false,"memoryHotAddEnabled":false,"vmToolsVersion":0,"vmToolsVersionSpecified":false,"vc":"String","moref":"String","hostName":"String","vmHostType":"String","networkInfoRaw":"String","vmInstanceType":"String","metric":[{"name":"String","unit":"String","value":0}],"disks":[{"autoDelete":false,"boot":false,"deviceName":"String","index":0,"interface__":"String","kind":"String","licenses":["String"],"mode":"String","source":"String","type":"String","size":0,"content":"String","errorMessage":"String","errorCode":0,"errorStatus":false}],"nics":[{"vmId":"String","vmName":"String","nicId":"String","nicName":"String","isConnected":false,"networkName":"String","networkId":"String","isPrimaryNic":false,"ipMode":"String","ipAddress":"String","macAddress":"String","networkAdapterType":"String","content":"String","errorMessage":"String","errorCode":0,"errorStatus":false}],"networkConnectionSection":{"info":"String","primaryNetworkConnectionIndex":0,"networkConnection":{"networkConnectionIndex":0,"ipAddress":"String","externalIpAddress":"String","isConnected":false,"macAddress":"String","ipAddressAllocationMode":"String","needsCustomization":false,"network":"String"},"link":{"href":"String","id":"String","type":"String","name":"String","rel":"String"},"required":false,"href":"String","type":"String"},"content":"String","errorMessage":"String","errorCode":0,"errorStatus":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}