CIM_LogicalPort, ROOT\CIMV2\storage\iscsitarget

Class | Childs (1) | Methods (8) | Properties (37) | Qualifiers (4) | Instances (1) | Namespaces (5)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

The abstraction of a port or connection point of a Device. This object should be instantiated when the Port has independent management characteristics from the Device that includes it. Examples are a Fibre Channel Port and a USB Port.

CIM_LogicalPort - child subclasses in ROOT\CIMV2\storage\iscsitarget

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_NetworkPort1478-1-

CIM_LogicalPort methods

CIM_LogicalPort has 8 methods (8 Derived)

NameOriginReturn
EnableDeviceCIM_LogicalDeviceuint32 {'out':True}
OnlineDeviceCIM_LogicalDeviceuint32 {'out':True}
QuiesceDeviceCIM_LogicalDeviceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
ResetCIM_LogicalDeviceuint32 {'out':True}
RestorePropertiesCIM_LogicalDeviceuint32 {'out':True}
SavePropertiesCIM_LogicalDeviceuint32 {'out':True}
SetPowerStateCIM_LogicalDeviceuint32 {'out':True}

CIM_LogicalPort properties

CIM_LogicalPort has 37 properties (6 Local, 31 Derived)

NameOriginCIMType
AdditionalAvailabilityCIM_LogicalDevice18 [uint16]
AvailabilityCIM_LogicalDevice18 [uint16]
CaptionCIM_ManagedElement8 [string]
key
CreationClassName
CIM_LogicalDevice8 [string]
DescriptionCIM_ManagedElement8 [string]
key
DeviceID
CIM_LogicalDevice8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
ErrorClearedCIM_LogicalDevice11 [boolean]
ErrorDescriptionCIM_LogicalDevice8 [string]
HealthStateCIM_ManagedSystemElement18 [uint16]
IdentifyingDescriptionsCIM_LogicalDevice8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
LastErrorCodeCIM_LogicalDevice19 [uint32]
MaxQuiesceTimeCIM_LogicalDevice21 [uint64]
MaxSpeedCIM_LogicalPort21 [uint64]
NameCIM_ManagedSystemElement8 [string]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
OtherIdentifyingInfoCIM_LogicalDevice8 [string]
OtherPortTypeCIM_LogicalPort8 [string]
PortTypeCIM_LogicalPort18 [uint16]
PowerManagementCapabilitiesCIM_LogicalDevice18 [uint16]
PowerManagementSupportedCIM_LogicalDevice11 [boolean]
PowerOnHoursCIM_LogicalDevice21 [uint64]
RequestedSpeedCIM_LogicalPort21 [uint64]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
SpeedCIM_LogicalPort21 [uint64]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
StatusInfoCIM_LogicalDevice18 [uint16]
key
SystemCreationClassName
CIM_LogicalDevice8 [string]
key
SystemName
CIM_LogicalDevice8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TotalPowerOnHoursCIM_LogicalDevice21 [uint64]
UsageRestrictionCIM_LogicalPort18 [uint16]

Detailed description of CIM_LogicalPort methods

Derived methods (8) of CIM_LogicalPort class

EnableDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Enabledboolean0-{'Description':'If TRUE enable the device, if FALSE disable the device.'}
EnableDevice method is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 10 namespaces
OnlineDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Onlineboolean0-{'Description':'If TRUE, take the device online, if FALSE, take the device OFFLINE.'}
OnlineDevice method is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 8 namespaces
QuiesceDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Quiesceboolean0-{'Description':'If set to TRUE then cleanly cease all activity, if FALSE resume activity.'}
QuiesceDevice method is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 8 namespaces
RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (can be null if the task is completed).'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.'}
RequestStateChange method is in 51 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
Reset method
Returnuint32 {'out':True}
Reset method is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 19 namespaces
RestoreProperties method
Returnuint32 {'out':True}
RestoreProperties method is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 8 namespaces
SaveProperties method
Returnuint32 {'out':True}
SaveProperties method is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 8 namespaces
SetPowerState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PowerStateuint160-{'Description':'The power state to set.','ValueMap':['1', '2', '3', '4', '5', '6'],'Values':['Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Other', 'Power Cycle', 'Power Off']}
Timedatetime1-{'Description':'Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received.'}
SetPowerState method is in 13 classes of ROOT\CIMV2\storage\iscsitarget and in 14 namespaces

Detailed description of CIM_LogicalPort properties

Local properties (6) of CIM_LogicalPort class

MaxSpeed property
CIMTYPE'uint64'
Description'The maximum bandwidth of the Port in Bits per Second.'
Punit'bit / second'
Units'Bits per Second'
MaxSpeed property is in 4 classes of ROOT\CIMV2\storage\iscsitarget and in 10 namespaces
OtherPortType property
CIMTYPE'string'
Description'Describes the type of module, when PortType is set to 1 ("Other").'
ModelCorrespondence['CIM_LogicalPort.PortType']
OtherPortType property is in 4 classes of ROOT\CIMV2\storage\iscsitarget and in 4 namespaces
PortType property
CIMTYPE'uint16'
Description'PortType is defined to force consistent naming of the 'type' property in subclasses and to guarantee unique enum values for all instances of NetworkPort. When set to 1 ("Other"), related property OtherPortType contains a string description of the type of port. A range of values, DMTF_Reserved, has been defined that allows subclasses to override and define their specific types of ports.'
ModelCorrespondence['CIM_NetworkPort.OtherNetworkPortType']
ValueMap['0', '1', '2', '3..15999', '16000..65535']
Values['Unknown', 'Other', 'Not Applicable', 'DMTF Reserved', 'Vendor Reserved']
PortType property is in 4 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
RequestedSpeed property
CIMTYPE'uint64'
Description'The requested bandwidth of the Port in Bits per Second. The actual bandwidth is reported in LogicalPort.Speed.'
ModelCorrespondence['CIM_LogicalPort.Speed']
Punit'bit / second'
Units'Bits per Second'
writeTrue
RequestedSpeed property is in 4 classes of ROOT\CIMV2\storage\iscsitarget and in 4 namespaces
Speed property
CIMTYPE'uint64'
Description'The bandwidth of the Port in Bits per Second.'
Punit'bit / second'
Units'Bits per Second'
Speed property is in 4 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
UsageRestriction property
CIMTYPE'uint16'
Description'In some circumstances, a LogicalPort might be identifiable as a front end or back end port. An example of this situation would be a storage array that might have back end ports to communicate with disk drives and front end ports to communicate with hosts. If there is no restriction on the use of the port, then the value should be set to 'not restricted'.'
ValueMap['0', '2', '3', '4']
Values['Unknown', 'Front-end only', 'Back-end only', 'Not restricted']
UsageRestriction property is in 4 classes of ROOT\CIMV2\storage\iscsitarget and in 8 namespaces

Derived properties (31) of CIM_LogicalPort class

AdditionalAvailability property
CIMTYPE'uint16'
AdditionalAvailability property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 8 namespaces
Availability property
CIMTYPE'uint16'
Availability property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
Caption property
CIMTYPE'string'
Caption property is in 90 classes of ROOT\CIMV2\storage\iscsitarget and in 37 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 45 classes of ROOT\CIMV2\storage\iscsitarget and in 20 namespaces
Description property
CIMTYPE'string'
Description property is in 91 classes of ROOT\CIMV2\storage\iscsitarget and in 142 namespaces
DeviceID property
CIMTYPE'string'
keyTrue
DeviceID property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 21 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 90 classes of ROOT\CIMV2\storage\iscsitarget and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 13 namespaces
ErrorCleared property
CIMTYPE'boolean'
ErrorCleared property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
ErrorDescription property
CIMTYPE'string'
ErrorDescription property is in 16 classes of ROOT\CIMV2\storage\iscsitarget and in 142 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
IdentifyingDescriptions property
CIMTYPE'string'
IdentifyingDescriptions property is in 15 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 23 namespaces
LastErrorCode property
CIMTYPE'uint32'
LastErrorCode property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 16 namespaces
MaxQuiesceTime property
CIMTYPE'uint64'
MaxQuiesceTime property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 8 namespaces
Name property
CIMTYPE'string'
Name property is in 67 classes of ROOT\CIMV2\storage\iscsitarget and in 142 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces
OtherIdentifyingInfo property
CIMTYPE'string'
OtherIdentifyingInfo property is in 15 classes of ROOT\CIMV2\storage\iscsitarget and in 20 namespaces
PowerManagementCapabilities property
CIMTYPE'uint16'
PowerManagementCapabilities property is in 13 classes of ROOT\CIMV2\storage\iscsitarget and in 14 namespaces
PowerManagementSupported property
CIMTYPE'boolean'
PowerManagementSupported property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 14 namespaces
PowerOnHours property
CIMTYPE'uint64'
PowerOnHours property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 13 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
Status property
CIMTYPE'string'
Status property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 18 namespaces
StatusInfo property
CIMTYPE'uint16'
StatusInfo property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 41 classes of ROOT\CIMV2\storage\iscsitarget and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 45 classes of ROOT\CIMV2\storage\iscsitarget and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 51 classes of ROOT\CIMV2\storage\iscsitarget and in 17 namespaces
TotalPowerOnHours property
CIMTYPE'uint64'
TotalPowerOnHours property is in 11 classes of ROOT\CIMV2\storage\iscsitarget and in 10 namespaces

CIM_LogicalPort Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'The abstraction of a port or connection point of a Device. This object should be instantiated when the Port has independent management characteristics from the Device that includes it. Examples are a Fibre Channel Port and a USB Port.'
UMLPackagePath'CIM::Device::Ports'
Version'2.10.0'

CIM_LogicalPort System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\CIMV2\storage\iscsitarget:CIM_LogicalPort'___SYSTEM8
__NAMESPACE'ROOT\CIMV2\storage\iscsitarget'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_LogicalDevice', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT37___SYSTEM3
__RELPATH'CIM_LogicalPort'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_LogicalDevice'___SYSTEM8
__CLASS'CIM_LogicalPort'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_LogicalPort

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_EthernetPort1528-1-
CIM_NetworkPort1478-1-
MSFTSMNET_EthernetPort05381---
comments powered by Disqus
WUtils.com