Share via

VirtualNetworkAdapter [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

The VirtualNetworkAdapter entity represents a virtual network adapter in Virtual Machine Manager (VMM).

Inheritance Hierarchy

VMM
  VirtualNetworkAdapter

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

Name

Create (POST)

Read (GET)

Update (PUT)

Delete (DELETE)

Type

Nullable

Description

ID

-

Optional

Required

Required

Edm.Guid

False

Key Property

The identifier of the entity.

StampId

Required

Optional

Required

Required

Edm.Guid

False

Key Property

The identifier of the stamp that contains the virtual network adapter.

Accessibility

-

Optional

-

-

Edm.String

True

Not applicable.

AddedTime

-

Optional

-

-

Edm.DateTime

True

When the adapter entity was added.

ChildObjectIDs

-

Optional

-

-

Collection(Edm.Guid)

False

Identifiers of associated VM networks and performance data.

Description

-

Optional

-

-

Edm.String

True

The description of the virtual network adapter.

Enabled

-

Optional

-

-

Edm.Boolean

True

Whether the adapter is enabled.

EnableMACAddressSpoofing

-

Optional

Optional

-

Edm.Boolean

True

Whether MAC address spoofing is enabled.

EthernetAddress

-

Optional

-

-

Edm.String

True

MAC address of the adapter.

EthernetAddressType

-

Optional

-

-

Edm.String

True

Type of MAC address.

  • Static

  • Dynamic

IPv4Addresses

-

Optional

-

-

Collection(Edm.String)

False

The IPv4 addresses configured on the adapter.

IPv4AddressType

-

Optional

Optional

-

Edm.String

True

The type of IPv4 addresses.

  • Static

  • Dynamic

IPv6Addresses

-

Optional

-

-

Collection(Edm.String)

False

The IPv6 addresses configured on the adapter.

IPv6AddressType

-

Optional

Optional

-

Edm.String

True

The type of IPv6 addresses.

  • Static

  • Dynamic

IsSynthetic

Optional

Optional

-

-

Edm.Boolean

True

If True, the adapter is a high-performance Hyper-V virtual network adapter; otherwise it is an emulated virtual network adapter.

Location

-

Optional

-

-

Edm.String

True

Describes the location of the adapter.

MACAddress

-

Optional

Optional

-

Edm.String

True

The media access control (MAC) address.

MACAddressesSpoofingEnabled

-

Optional

-

-

Edm.Boolean

True

Whether MAC address spoofing is enabled.

MACAddressesSpoolingEnabled

-

Optional

-

-

Edm.Boolean

True

Whether MAC address spoofing is enabled.

MACAddressSpoofingEnabled

-

Optional

-

-

Edm.Boolean

True

Whether MAC address spoofing is enabled.

MACAddressType

-

Optional

Optional

-

Edm.String

True

The media access control (MAC) addressing type.

  • Static

  • Dynamic

ModifiedTime

-

Optional

-

-

Edm.DateTime

True

When the adapter was last modified.

Name

-

Optional

-

-

Edm.String

True

The name of the virtual network adapter.

ParentId

-

Optional

-

-

Edm.Guid

True

The owning object of this one. Generally, this will be null.

PhysicalAddress

-

Optional

-

-

Edm.String

True

The physical address (MAC) address of the adapter.

PhysicalAddressType

-

Optional

-

-

Edm.String

True

The type of physical address.

  • Static

  • Dynamic

RequiredBandwidth

-

Optional

-

-

Edm.String

True

The network bandwidth required by a network adapter.

SlotId

-

Optional

-

-

Edm.Int32

True

A numerical ID used to identify a device.

Tag

-

Optional

-

-

Edm.String

True

Not applicable.

TemplateId

-

Optional

-

-

Edm.Guid

True

The identifier of the virtual machine template.

VirtualNetworkAdapterType

-

Optional

-

-

Edm.String

True

Whether the adapter is a Synthetic or Emulated network adapter.

VLanEnabled

-

Optional

-

-

Edm.Boolean

True

Enables a virtual LAN (VLAN) for use by virtual machines on a Hyper-V or Citrix XenServer host.

VLanId

-

Optional

-

-

Edm.Int16

True

The numerical identifier in the range 1-4094 of the VLan when VLanEnabled is true.

VMId

Required

-

-

-

Edm.Guid

True

The identifier of the virtual machine to create the network adapter on.

VMNetworkId

Optional

Optional

Optional

-

Edm.Guid

True

The identifier of the network that is assigned to this adapter.

VMNetworkName

Optional

Optional

Optional

-

Edm.String

True

The name of the virtual machine network (VMNetwork) that the virtual network adapter is assigned to.

VMNetworkOptimizationEnabled

-

Optional

-

-

Edm.Boolean

True

Whether the adapter is capable of using Virtual Machine Queues available on the host.

VMSubnetId

-

Optional

Optional

-

Edm.Guid

True

The identifier of the virtual machine subnet.

VmwAdapterIndex

-

Optional

-

-

Edm.Int32

True

The index of the adapter in a VMware virtual machine.

VMwarePortGroup

-

Optional

-

-

Edm.String

True

The port group containing the adapter in a VMware virtual machine.

Relationships

None

OData Operations

None

Notes

The RunAsynchronously query parameter may be added to the URL (with a value of 1) of an Update operation. This will tell the service to return immediately after the request is sent instead of waiting for the update to finish, which may cause the request to timeout. For example:

https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/VirtualNeeetworkAdapters(ID=guid'38c9c3b9-9288-4d7a-82fa-501cd4eb9ecb',StampId=guid'd70c1a9b-c241-48f5-880a-b6c36071e653')?RunAsynchronously=1

Examples

See Also

Entities [SPFSDK][VMMREF]
VirtualNetworkAdapters Collection [SPFSDK][VMMREF]