Net3 API Interface for Customer Portal

VMWareManage

The following routes are available for this service:
POST	/vmwaremanage

**VMWareManage** Parameters:
Name	Parameter	Data Type	Required	Description
JobId	body	string	No
StartVM	body	bool	No

**VMWareManageBase** Parameters:
Name	Parameter	Data Type	Required
userId	form	string	No
ORGName	form	string	No
DataCenterLocation	form	string	No
VMName	form	string	No

**VMWareManageResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	TypeVM	No
ResponseStatus	form	ResponseStatus	No

**TypeVM** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
NameLong	form	string	No
Status	form	string	No
CPU	form	int	No
Memory	form	ulong	No
DiskSize	form	List<ulong>	No
Href	form	string	No
Id	form	string	No
DiskCount	form	int	No
catalogName	form	string	No
container	form	string	No
containerName	form	string	No
guestOs	form	string	No
hardwareVersion	form	int	No
hardwareVersionSpecified	form	bool	No
isBusy	form	bool	No
isBusySpecified	form	bool	No
isDeleted	form	bool	No
isDeletedSpecified	form	bool	No
isDeployed	form	bool	No
isDeployedSpecified	form	bool	No
isInMaintenanceMode	form	bool	No
isInMaintenanceModeSpecified	form	bool	No
isPublished	form	bool	No
isPublishedSpecified	form	bool	No
isVAppTemplate	form	bool	No
isVAppTemplateSpecified	form	bool	No
memoryMB	form	int	No
memoryMBSpecified	form	bool	No
numberOfCpus	form	int	No
numberOfCpusSpecified	form	bool	No
storageProfileName	form	string	No
vdc	form	string	No
hasDR	form	bool	No
isDRActive	form	bool	No
CpuHotAddEnabledSpecified	form	bool	No
CpuHotAddEnabled	form	bool	No
MemoryHotAddEnabledSpecified	form	bool	No
MemoryHotAddEnabled	form	bool	No
vmToolsVersion	form	int	No
vmToolsVersionSpecified	form	bool	No
vc	form	string	No
moref	form	string	No
hostName	form	string	No
vmHostType	form	string	No
networkInfoRaw	form	string	No
vmInstanceType	form	string	No
Metric	form	SimpleMetricType[]	No
Disks	form	List<TypeDisk>	No
Nics	form	List<TypeNic>	No
NetworkConnectionSection	form	NetworkConnectionSection	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required
Content	form	string	No
errorMessage	form	string	No
errorCode	form	int	No
errorStatus	form	bool	No

**SimpleMetricType** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
unit	form	string	No
value	form	decimal	No

**TypeDisk** Parameters:
Name	Parameter	Data Type	Required
autoDelete	form	bool	No
boot	form	bool	No
deviceName	form	string	No
index	form	int	No
interface__	form	string	No
kind	form	string	No
licenses	form	string[]	No
mode	form	string	No
source	form	string	No
type	form	string	No
size	form	ulong	No

**TypeNic** Parameters:
Name	Parameter	Data Type	Required
VMId	form	string	No
VMName	form	string	No
NicId	form	string	No
NicName	form	string	No
IsConnected	form	bool	No
NetworkName	form	string	No
NetworkId	form	string	No
IsPrimaryNic	form	bool	No
IPMode	form	string	No
IPAddress	form	string	No
MacAddress	form	string	No
NetworkAdapterType	form	string	No

**NetworkConnectionSection** Parameters:
Name	Parameter	Data Type	Required
Info	form	string	No
PrimaryNetworkConnectionIndex	form	int	No
NetworkConnection	form	NetworkConnection	No
Link	form	LinkType	No
required	form	bool	No
href	form	string	No
type	form	string	No

**NetworkConnection** Parameters:
Name	Parameter	Data Type	Required
NetworkConnectionIndex	form	int	No
IpAddress	form	string	No
ExternalIpAddress	form	string	No
IsConnected	form	bool	No
MACAddress	form	string	No
IpAddressAllocationMode	form	string	No
needsCustomization	form	bool	No
network	form	string	No

**LinkType** Parameters:
Name	Parameter	Data Type	Required
href	form	string	No
id	form	string	No
type	form	string	No
name	form	string	No
rel	form	string	No

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	jobId: String,
	startVM: False,
	userId: String,
	orgName: String,
	dataCenterLocation: String,
	vmName: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}