3.1.5.21 virtualServers
The virtualServers resource corresponds to a virtual machine (VM). Such resources MUST be created for VMs that correspond to gateway resources (section 3.1.5.4) and MUX resources (section 3.1.5.7).
It is invoked through the following URI.
-
https://<url>/networking/v1/virtualServers/{resourceId}
url: The address or name of the REST server of the Network Controller.
resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.
Note The server MAY support additional versions, v1 or later, in the URI.
The following HTTP methods can be performed on this resource.
|
HTTP method |
Section |
Description |
|---|---|---|
|
PUT |
Create a new virtualServers resource or update an existing virtualServers resource. |
|
|
GET |
Get one virtualServers resource. |
|
|
GET ALL |
List all virtualServers resources in the Network Controller. |
|
|
DELETE |
Deletes a virtualServers resource. |
The following property elements are valid.
|
Element name |
Type |
Description |
|---|---|---|
|
etag |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
provisioningState |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
connections |
Optional |
Indicates an array of connections that specifies the information needed to connect to the specific device for the purposes of managing and controlling the device. |
|
connections.credential |
Optional |
Indicates a reference to a credential resource that can be used to connect to the device for management purposes. |
|
connections.credentialType |
Optional |
Indicates a reference to a credentials resource that specifies the type of credential. |
|
connections.managementAddresses |
Optional |
Indicates the management address used to connect to the server. This is in the form of an IPv4 IP address, an IPv6 IP address, a DNS name or a flat (NetBIOS) name. |
|
gateway |
Read-only |
Indicates a reference to the gateway resource representing the gateway running on this virtualServer. This element will not be returned if there is not a gateway running on the virtual server. |
|
loadBalancerMuxes |
Read-only |
Indicates a reference to the loadBalancerMuxes resource representing the loadBalancer MUX running on this virtualServer. This element will not be returned if there is not a loadBalancer MUX running on the virtual server. |
|
server |
Read-only |
Indicates a reference to the servers resource this virtualServer is located on. The server reference is automatically created when a corresponding NIC arrival notification from the south bound is handled. |
|
vmGuid |
Required |
Indicates the GUID of the VM object as found in the Hyper-V Windows Management Instrumentation (WMI). |