Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MSFT_NetAdapterSriovVfSettingData class

SRIOV Vport settings for a network adapter

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("NetAdapterCim")]class MSFT_NetAdapterSriovVfSettingData : MSFT_NetAdapterSettingData
{
  string Caption;
  string Description;
  string ElementName;
  string InstanceID;
  string Name;
  string InterfaceDescription;
  uint32 Source;
  string SystemName;
  uint16 FunctionID;
  uint32 SwitchID;
  string VmFriendlyName;
  string VmID;
  string VmNicID;
  string CurrentMacAddress;
  string PermanentMacAddress;
  uint32 VPortID[];
};

Members

The MSFT_NetAdapterSriovVfSettingData class has these types of members:

Properties

The MSFT_NetAdapterSriovVfSettingData class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )

A short textual description of the object. This property inherits from CIM_ManagedElement.

CurrentMacAddress
Data type: string
Access type: Read-only

The current MAC address of the virtual function.

Description
Data type: string
Access type: Read-only

A textual description of the object. This property inherits from CIM_ManagedElement.

ElementName
Data type: string
Access type: Read-only

A user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. The same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. This property inherits from CIM_ManagedElement.

FunctionID
Data type: uint16
Access type: Read-only

The Virtual function ID.

InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above preferred algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.

This property inherits from CIM_SettingData.

InterfaceDescription
Data type: string
Access type: Read-only

Interface Description, also known as "ifDesc" or display name is a unique name assigned to the network adapter during installation. This name cannot be changed and is persisted as long as the network adapter is not uninstalled. This property inherits from MSFT_NetAdapterSettingData.

Name
Data type: string
Access type: Read-only

Name, also known as Connection Name, "ifAlias", or InterfaceAlias, is a unique name assigned to the adapter during installation. The Name of the adapter can be changed by the administrator and is persisted across the boot or network adapter restart. This property inherits from MSFT_NetAdapterSettingData.

PermanentMacAddress
Data type: string
Access type: Read-only

The permanent MAC address of the virtual function.

Source
Data type: uint32
Access type: Read-only

The source of the setting data. This property inherits from MSFT_NetAdapterSettingData.

Unknown (0)
Other (1)
Device (2)
Persistent storage (3)
SwitchID
Data type: uint32
Access type: Read-only

The identifier of the switch.

SystemName
Data type: string
Access type: Read-only

The scoping System\'s Name. This property inherits from MSFT_NetAdapterSettingData.

VmFriendlyName
Data type: string
Access type: Read-only

The friendly name of the Virtual Machine to which the virtual function is assigned.

VmID
Data type: string
Access type: Read-only

The ID of the Virtual Machine to which the virtual function is assigned.

VmNicID
Data type: string
Access type: Read-only

The VM NIC Id to which the virtual function is associated.

VPortID
Data type: uint32 array
Access type: Read-only

The list of Virtual Port IDs attached to this virtual function.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Namespace

\root\StandardCimv2

MOF

NetAdapterCim.mof

DLL

NetAdapterCim.dll

 

 

Community Additions

Show:
© 2015 Microsoft