Export (0) Print
Expand All

MSFT_NetAdapterSriovSettingData class

SRIOV 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_NetAdapterSriovSettingData : MSFT_NetAdapterSettingData
{
  string  Caption;
  string  Description;
  string  ElementName;
  string  InstanceID;
  string  Name;
  string  InterfaceDescription;
  uint32  Source;
  string  SystemName;
  boolean Enabled;
  uint8   SriovSupport;
  string  HardwareCapabilities;
  string  CurrentCapabilities;
  uint16  SwitchType;
  string  SwitchName;
  uint32  NumVFs;
  uint32  NumAllocatedVFs;
  uint32  NumVPorts;
  uint32  NumActiveVPorts;
  uint32  NumQueuePairsForDefaultVPort;
  uint32  NumQueuePairsForNonDefaultVPorts;
  uint32  NumActiveDefaultVPortMacAddresses;
  uint32  NumActiveNonDefaultVPortMacAddresses;
  uint32  NumActiveDefaultVPortVlanIds;
  uint32  NumActiveNonDefaultVPortVlanIds;
};

Members

The MSFT_NetAdapterSriovSettingData class has these types of members:

Methods

The MSFT_NetAdapterSriovSettingData class has these methods.

MethodDescription
Disable

Disables the SRIOV properties on the network adapter.

Enable

Enables the SRIOV properties on the network adapter.

 

Properties

The MSFT_NetAdapterSriovSettingData 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.

CurrentCapabilities
Data type: string
Access type: Read-only

The SRIOV capabilities currently enabled on the network adapter.

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.

Enabled
Data type: boolean
Access type: Read/write

Indicates if SRIOV is currently enabled on the Adapter.

HardwareCapabilities
Data type: string
Access type: Read-only

The SRIOV capabilities reported by the network adapter.

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.

NumActiveDefaultVPortMacAddresses
Data type: uint32
Access type: Read-only

The number of active Mac addresses on the default VPort.

NumActiveDefaultVPortVlanIds
Data type: uint32
Access type: Read-only

The number of active Vlan Ids on the default VPort

NumActiveNonDefaultVPortMacAddresses
Data type: uint32
Access type: Read-only

The number of active Mac addresses on the non default VPorts

NumActiveNonDefaultVPortVlanIds
Data type: uint32
Access type: Read-only

The number of active Vlan Ids on the non default VPorts

NumActiveVPorts
Data type: uint32
Access type: Read-only

The number of VPorts currently allocated on the switch

NumAllocatedVFs
Data type: uint32
Access type: Read-only

The number of Virtual functions currently allocated.

NumQueuePairsForDefaultVPort
Data type: uint32
Access type: Read-only

The number of Queue pairs for the default VPort

NumQueuePairsForNonDefaultVPorts
Data type: uint32
Access type: Read-only

The number of Queue pairs for the non default VPort

NumVFs
Data type: uint32
Access type: Read-only

The number of Virtual functions that can be allocated on the switch

NumVPorts
Data type: uint32
Access type: Read-only

The number of VPorts that can be allocated on the switch

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)
SriovSupport
Data type: uint8
Access type: Read-only

Indicates the SRIOV support for the device.

Unknown (0)
Supported (1)
Missing ACS (2)
Missing PF Driver (3)
No bus resources (4)
No IOMMU support (5)
Did not Get Vf BarSpace (6)
No OCS Support (7)
SwitchName
Data type: string
Access type: Read-only

The name of the switch

SwitchType
Data type: uint16
Access type: Read-only

Indicates the type of the embedded switch

Unknown (0)
External (1)
SystemName
Data type: string
Access type: Read-only

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

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Namespace

Root\StandardCimv2

MOF

NetAdapterCim.mof

DLL

NetAdapterCim.dll

 

 

Community Additions

ADD
Show:
© 2015 Microsoft