Share via


VirtualNetworkAdapters

 

Applies To: System Center 2016 - Service Provider Foundation, System Center Technical Preview

VirtualNetworkAdapters

Reads, creates, updates, or deletes virtual network adapters that are assigned to virtual machines or virtual machine templates.

HTTP Verbs

GET POST PUT DELETE
Yes Yes Yes Yes

GET

Gets all virtual network adapters. This GET operation is further restricted by the available properties that you can add.

If you supply the ID property, the virtual network adapter with that identifier is returned

If you supply the VMId property, the virtual network adapters that are assigned to the identified virtual machine are returned.

If you supply the TemplateId property, the virtual network adapters that are assigned to the identified virtual machine template are returned.

If you supply only the StampId property, all virtual network adapters for every virtual machine and virtual machine template that are assigned to that stamp are returned.

Entity Properties

Name Type Mandatory Description
ID Edm.Guid No The identifier of the virtual network adapter
TemplateId Edm.Guid No The identifier of the virtual machine template
VMId Edm.Guid No The identifier of the virtual machine
StampId Edm.Guid Yes The identifier of the stamp to restrict the query to

POST

Creates a new virtual network adapter and attaches it to the specified virtual machine.

Entity Properties

Name Type Mandatory Description
VMId Edm.Guid Yes The identifier of the virtual machine
StampId Edm.Guid Yes The identifier of the stamp to restrict the query to
IsSynthetic Edm.Boolean No When this property is set to false, the virtual network adapter is created as an emulated virtual network adapter; otherwise, it is a high-performance Hyper-V-specific virtual network adapter.

PUT

Updates an existing virtual network adapter.

Entity Properties

Name Type Mandatory Description
StampId Edm.Guid Yes The identifier of the stamp to restrict the query to
ID Edm.Guid Yes The identifier of the virtual network adapter
IPv4AddressType Edm.String No Sets the IPv4 addressing type. Use either “Dynamic” or “Static.”
IPv6AddressType Edm.String No Sets the IPv6 addressing type. Use either “Dynamic” or “Static.”
VirtualNetwork Edm.String No Specifies the virtual network that this adapter is assigned to.
VMNetworkName Edm.String No Specifies the virtual machine network (VMNetwork) that the virtual network adapter is assigned to. Use an empty string to specify “no connection.”
VMNetworkId Edm.Guid No The identifier of the network that is assigned to this adapter
MACAddressType Edm.String No Sets the media access control (MAC) addressing type. Use either “Dynamic” or “Static.”
MACAddress Edm.String No A comma-delimited list of MAC address values
EnableMACAddressSpoofing Edm.Boolean No When this property is set to true, enables MAC address spoofing.

DELETE

Deletes the specified virtual network adapter.

Entity Properties

Name Type Mandatory Description
ID Edm.Guid No The identifier of the virtual network adapter
StampId Edm.Guid Yes The identifier of the stamp to restrict the query to

See Also

VMM Collections Reference