VirtualNetworkAdapters

System Center
 

Updated: June 27, 2017

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

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

GETPOSTPUTDELETE
YesYesYesYes

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

NameTypeMandatoryDescription
IDEdm.GuidNoThe identifier of the virtual network adapter
TemplateIdEdm.GuidNoThe identifier of the virtual machine template
VMIdEdm.GuidNoThe identifier of the virtual machine
StampIdEdm.GuidYesThe 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

NameTypeMandatoryDescription
VMIdEdm.GuidYesThe identifier of the virtual machine
StampIdEdm.GuidYesThe identifier of the stamp to restrict the query to
IsSyntheticEdm.BooleanNoWhen 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

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp to restrict the query to
IDEdm.GuidYesThe identifier of the virtual network adapter
IPv4AddressTypeEdm.StringNoSets the IPv4 addressing type. Use either “Dynamic” or “Static.”
IPv6AddressTypeEdm.StringNoSets the IPv6 addressing type. Use either “Dynamic” or “Static.”
VirtualNetworkEdm.StringNoSpecifies the virtual network that this adapter is assigned to.
VMNetworkNameEdm.StringNoSpecifies the virtual machine network (VMNetwork) that the virtual network adapter is assigned to. Use an empty string to specify “no connection.”
VMNetworkIdEdm.GuidNoThe identifier of the network that is assigned to this adapter
MACAddressTypeEdm.StringNoSets the media access control (MAC) addressing type. Use either “Dynamic” or “Static.”
MACAddressEdm.StringNoA comma-delimited list of MAC address values
EnableMACAddressSpoofingEdm.BooleanNoWhen this property is set to true, enables MAC address spoofing.

DELETE

Deletes the specified virtual network adapter.

Entity Properties

NameTypeMandatoryDescription
IDEdm.GuidNoThe identifier of the virtual network adapter
StampIdEdm.GuidYesThe identifier of the stamp to restrict the query to

VMM Collections Reference

Show: