CIM_EthernetPortAllocationSettingData class

Article
05/31/2018

Represents settings for the allocation of the ethernet port, in addition to the settings provided by the CIM_EthernetPort class. These settings are used to provide information specific to the resource itself.

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

Syntax

[Abstract, Version("2.26.0"), UMLPackagePath("CIM::Core::Resource")]
class CIM_EthernetPortAllocationSettingData : CIM_ResourceAllocationSettingData
{
  string  Caption;
  string  Description;
  string  InstanceID;
  string  ElementName;
  uint16  ResourceType;
  string  OtherResourceType;
  string  ResourceSubType;
  string  PoolID;
  uint16  ConsumerVisibility;
  string  HostResource[];
  string  AllocationUnits;
  uint64  VirtualQuantity;
  uint64  Reservation;
  uint64  Limit;
  uint32  Weight;
  boolean AutomaticAllocation;
  boolean AutomaticDeallocation;
  string  Parent;
  string  Connection[];
  string  Address;
  uint16  MappingBehavior;
  string  AddressOnParent;
  string  VirtualQuantityUnits = "count";
  uint16  DesiredVLANEndpointMode;
  string  OtherEndpointMode;
};

Members

The CIM_EthernetPortAllocationSettingData class has these types of members:

Properties

Properties

The CIM_EthernetPortAllocationSettingData class has these properties.

Address

Data type: string
Access type: Read-only

The address of the resource, for example, the MAC address of a Ethernet port.

This property is inherited from CIM_ResourceAllocationSettingData.

AddressOnParent

Data type: string
Access type: Read-only

The address of this resource from the context of the parent. This property is used to describe a controller relationship and the ordering of devices on a controller. For example, if the parent is a PCI Controller, this property would specify the PCI slot of this child device.

This property is inherited from CIM_ResourceAllocationSettingData.

AllocationUnits

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.Reservation", "CIM_ResourceAllocationSettingData.Limit"), IsPUnit

The allocation units used by the Reservation and Limit properties.

This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticAllocation

Data type: boolean
Access type: Read-only

true to automatically allocate the resource; otherwise, false.

This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticDeallocation

Data type: boolean
Access type: Read-only

true to automatically deallocate the resource; otherwise, false.

This property is inherited from CIM_ResourceAllocationSettingData.

Caption

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

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

Connection

Data type: string array
Access type: Read-only

An array that indicates the objects connected to the resource, such as a named network or switch port.

This property is inherited from CIM_ResourceAllocationSettingData.

ConsumerVisibility

Data type: uint16
Access type: Read-only

The consumers visibility to the allocated resource.

This property is inherited from CIM_ResourceAllocationSettingData.

Unknown (0)

Passed-Through (2)

Virtualized (3)

Not represented (4)

DMTF reserved

5 32766

Vendor Reserved

32767 65535

Description

Data type: string
Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

DesiredVLANEndpointMode

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_VLANEndpoint.OperationalEndpointMode", "CIM_VLANEndpoint.DesiredEndpointMode", "CIM_EthernetPortAllocationSettingData.OtherEndpointMode")

The requested VLAN mode. This property is used to set the initial OperationalEndpointMode property value in the instance of CIM_VLANEndpoint associated with the ethernet port.

DMTF Reserved (0)

Other (1)

Access (2)

Dynamic Auto (3)

Dynamic Desirable (4)

Trunk (5)

Dot1Q Tunnel (6)

DMTF Reserved

Reserved.

Vendor Reserved

ElementName

Data type: string
Access type: Read-only
Qualifiers: Required

The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.

This property is inherited from CIM_SettingData.

HostResource

Data type: string array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ConsumerVisibility", "CIM_ResourceAllocationSettingData.MappingBehavior")

An array that contains the assignment of the allocated resources. Each non-null value of this property must be formated as an RFC3986 based URI. If the resource is modeled, then the value should be a WBEM URI.

This property is inherited from CIM_ResourceAllocationSettingData.

InstanceID

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

Uniquely identifies an instance of this class within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.

OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.

For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".

This property is inherited from CIM_SettingData.

Limit

Data type: uint64
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.AllocationUnits")

The maximum amount of resource to grant to the allocation. The unit type of this property is specified by the AllocationUnits property.

This property is inherited from CIM_ResourceAllocationSettingData.

MappingBehavior

Data type: uint16
Access type: Read-only

Indicates how the resource maps to underlying resources.

This property is inherited from CIM_ResourceAllocationSettingData.

Unknown (0)

Not Supported (2)

Dedicated (3)

Soft Affinity (4)

Hard Affinity (5)

DMTF Reserved

6 32766

Vendor Reserved

32767 65535

OtherEndpointMode

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EthernetPortAllocationSettingData.DesiredVLANEndpointMode")

The type of VLAN endpoint model that is supported by this VLAN endpoint, when the value of the mode property is set to "1" (Other). This property should be set to NULL when the mode property is any value other than "1".

OtherResourceType

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")

A description of the resource type when the ResourceType property is set to 1 (other).

This property is inherited from CIM_ResourceAllocationSettingData.

Parent

Data type: string
Access type: Read-only

The parent of the resource, for example, a controller for the current allocation.

This property is inherited from CIM_ResourceAllocationSettingData.

PoolID

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")

The ID of the resource pool that generated the resource.

This property is inherited from CIM_ResourceAllocationSettingData.

Reservation

Data type: uint64
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.AllocationUnits")

The number of resource that are guaranteed to be available for this allocation. On systems that support over-commitment of resources, this value is typically used for admission control.

The unit type of this property is specified by the AllocationUnits property.

This property is inherited from CIM_ResourceAllocationSettingData.

ResourceSubType

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")

An implementation specific sub-type for this resource. For example, this may be used to distinguish different models of the same resource type.

This property is inherited from CIM_ResourceAllocationSettingData.

ResourceType

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType", "CIM_ResourceAllocationSettingData.ResourceSubType")

The type of resource that is represented by the allocation settings.

This property is inherited from CIM_ResourceAllocationSettingData.

Other (1)

Computer System (2)

Processor (3)

Memory (4)

IDE Controller (5)

Parallel SCSI HBA (6)

FC HBA (7)

iSCSI HBA (8)

IB HCA (9)

Ethernet Adapter (10)

Other Network Adapter (11)

I/O Slot (12)

I/O Device (13)

Floppy Drive (14)

CD Drive (15)

DVD drive (16)

Disk Drive (17)

Tape Drive (18)

Storage Extent (19)

Other storage device (20)

Serial port (21)

Parallel port (22)

USB Controller (23)

Graphics controller (24)

IEEE 1394 Controller (25)

Partitionable Unit (26)

Base Partitionable Unit (27)

Power (28)

Cooling Capacity (29)

Ethernet Switch Port (30)

Logical Disk (31)

Storage Volume (32)

Ethernet Connection (33)

DMTF reserved

34 32767

Vendor Reserved

32768 35535

VirtualQuantity

Data type: uint64
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.VirtualQuantityUnits")

The number of resources presented to the consumer of the resource.

This property is inherited from CIM_ResourceAllocationSettingData.

VirtualQuantityUnits

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.VirtualQuantity"), IsPUnit

The units used by the VirtualQuantity property.

This property is inherited from CIM_ResourceAllocationSettingData.

Weight

Data type: uint32
Access type: Read-only

The relative priority for this allocation in relation to other allocations from the same resource pool.

This property is inherited from CIM_ResourceAllocationSettingData.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
MOF	WindowsHyperVCluster.V2.mof
DLL	VMMS.exe

CIM_EthernetPortAllocationSettingData class

Syntax

Members

Properties

Requirements

See also

Additional resources