Msvm_SyntheticFcPortSettingData class
Represents the configured state of a synthetic Fibre Channel port.
The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_SyntheticFcPortSettingData : CIM_ResourceAllocationSettingData
{
string InstanceID;
string Caption = "Virtual Fibre Channel Port Default Settings";
string Description = "Describes the default settings for the virtual Fibre Channel port resources.";
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";
string VirtualPortWWPN;
string VirtualPortWWNN;
string SecondaryWWPN;
string SecondaryWWNN;
string VirtualSystemIdentifiers[];
boolean ChapEnabled;
};
Members
The Msvm_SyntheticFcPortSettingData class has these types of members:
Properties
The Msvm_SyntheticFcPortSettingData class has these properties.
-
Address
-
-
Data type: string
-
Access type: Read-only
The address of the resource. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
AddressOnParent
-
-
Data type: string
-
Access type: Read-only
Describes the address of this resource in the context of the parent. The Parent and AddressOnParent properties are used to describe the controller relationship as well as the ordering of devices on a controller. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
AllocationUnits
-
-
Data type: string
-
Access type: Read-only
The unit of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
AutomaticAllocation
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the resource will be automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
AutomaticDeallocation
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the resource will be automatically deallocated. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short description of the object. This property is inherited from CIM_ManagedElement.
-
-
ChapEnabled
-
-
Data type: boolean
-
Access type: Read-only
Indicates that this port has been configured with a shared secret using DH-CHAP, which allows the Fibre Channel fabric to authenticate that this virtual machine can legitimately use the world wide names that are assigned to this port.
-
-
Connection
-
-
Data type: string array
-
Access type: Read-only
The device to which this resource is connected. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
ConsumerVisibility
-
-
Data type: uint16
-
Access type: Read-only
The consumer's visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A display name for the object. This property is inherited from CIM_SettingData. Changing this property will change the element name of the associated logical device derivative.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
-
-
HostResource
-
-
Data type: string array
-
Access type: Read-only
Only one host resource can be assigned to each device in the virtual machine, so only the first element of this array can be set. For devices that support this feature, set the first element of the HostResource array to contain a reference to the underlying host resource to be assigned. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class. This property is inherited from CIM_SettingData.
-
-
Limit
-
-
Data type: uint64
-
Access type: Read-only
The maximum amount of corresponding host resources that can be consumed by the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
MappingBehavior
-
-
Data type: uint16
-
Access type: Read-only
Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
OtherResourceType
-
-
Data type: string
-
Access type: Read-only
A string that describes the resource type when a well-defined value is not available and ResourceType has the value 1(Other). This property is inherited from CIM_ResourceAllocationSettingData, but is not used.
-
-
Parent
-
-
Data type: string
-
Access type: Read-only
The parent of the resource. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
PoolID
-
-
Data type: string
-
Access type: Read-only
The identifier of the resource pool from which this resource was allocated. For instances associated with a virtual machine, this will be "Microsoft:GUID\device-specific data". For instances that define potential settings for a virtual machine, this will be "Microsoft:Definition\GUID\Type", where Type can be one of "Maximum", "Minimum", "Default", or "Increment". This property is inherited from CIM_ResourceAllocationSettingData.
-
-
Reservation
-
-
Data type: uint64
-
Access type: Read-only
The amount of resources that are reserved for use by the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData, but is not used.
-
-
ResourceSubType
-
-
Data type: string
-
Access type: Read-only
A string that describes an implementation specific subtype 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
The type of resource this allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData.
Value Meaning - FC HBA
- 7
Fibre Channel -
-
SecondaryWWNN
-
-
Data type: string
-
Access type: Read-only
Indicates the world wide node name of the virtual HBA port to be used during live migration of the virtual machine.
-
-
SecondaryWWPN
-
-
Data type: string
-
Access type: Read-only
Indicates the world wide port name of the virtual HBA port to be used during live migration of the virtual machine.
-
-
VirtualPortWWNN
-
-
Data type: string
-
Access type: Read-only
Indicates the world wide node name of the virtual HBA port.
-
-
VirtualPortWWPN
-
-
Data type: string
-
Access type: Read-only
Indicates the world wide port name of the virtual HBA port.
-
-
VirtualQuantity
-
-
Data type: uint64
-
Access type: Read-only
Specifies the quantity of resources presented to the consumer. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
VirtualQuantityUnits
-
-
Data type: string
-
Access type: Read-only
Specifies the unit of measurement for the VirtualQuantity property. The value of this property must be a legal value of the Programmatic Units qualifier as defined in Annex C.1 of DSP0004 V2.5 or later. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
VirtualSystemIdentifiers
-
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed")
A string array of identifiers of this resource presented to the virtual machine's operating system. The indexes and values per index are defined on a per resource basis (that is, for each enumerated ResourceType value). This property is not used
-
-
Weight
-
-
Data type: uint32
-
Access type: Read-only
An integer that defines the relative weight for each virtual machine processor. This property is inherited from CIM_ResourceAllocationSettingData, but is not used.
-
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8 [desktop apps only] |
| Minimum supported server |
Windows Server 2012 [desktop apps only] |
| Namespace |
Root\Virtualization\V2 |
| MOF |
|
| DLL |
|
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for