CIM_NetworkPipe, ROOT\CIMV2\storage\iscsitarget

Class | Childs (2) | Methods (1) | Properties (17) | Qualifiers (5) | Instances | Namespaces (3)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

NetworkPipe is a subclass of EnabledLogicalElement, representing the state and management of a connection or trail between endpoints. This object is different than the association between the endpoints (CIM_ActiveConnection) since the emphasis is NOT on the endpoints but on the management of the pipe itself - its state, configuration, etc. NetworkPipes are defined in the context of a CIM_Network and represent the 'transfer of information . . . between . . . endpoints'. These concepts are aligned with the definition of the Pipe object in ITU's M.3100 specification.

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

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_iSCSIConnection1291---
CIM_iSCSISession1321---

CIM_NetworkPipe methods

CIM_NetworkPipe has 1 methods (1 Derived)

NameOriginReturn
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}

CIM_NetworkPipe properties

CIM_NetworkPipe has 17 properties (3 Local, 14 Derived)

NameOriginCIMType
AggregationBehaviorCIM_NetworkPipe18 [uint16]
CaptionCIM_ManagedElement8 [string]
DescriptionCIM_ManagedElement8 [string]
DirectionalityCIM_NetworkPipe18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
key
InstanceID
CIM_NetworkPipe8 [string]
NameCIM_ManagedSystemElement8 [string]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]

Detailed description of CIM_NetworkPipe methods

Derived methods (1) of CIM_NetworkPipe class

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

Detailed description of CIM_NetworkPipe properties

Local properties (3) of CIM_NetworkPipe class

AggregationBehavior property
CIMTYPE'uint16'
Description'Indicates whether the pipe is composed of lower-level pipes, and if so, how these lower-level pipes are aggregated (in parallel or in sequence). The specific instances of NetworkPipe that are combined are described using the NetworkPipeComposition association.

In the context of M.3100, the ability to be composed of lower-level pipes is modeled as a Trail. A Trail is made up of one or more Connections. (Note that both Trails and Connections are subclasses of Pipe). Because of the flexibility of the NetworkPipeComposition association, there is no need to subclass NetworkPipe, as was done in M.3100, but merely to instantiate the NetworkPipeComposition association to describe the bundling of the lower-level pipes (i.e., the connections), or the sequencing of them.'
ValueMap['0', '2', '3', '4']
Values['Unknown', 'No Lower-Level Composition', 'Combined In Parallel', 'Combined In Sequence']
AggregationBehavior property is in 5 classes of ROOT\CIMV2\storage\iscsitarget and in 3 namespaces
Directionality property
CIMTYPE'uint16'
Description'Indicates whether the pipe is bi-directional (value = 2), unidirectional (value = 3), or this information is not known (value = 0). For unidirectional pipes, the source and sink are indicated by a property (SourceOrSink) of the association, EndpointOfNetworkPipe.'
MappingStrings['Recommendation.ITU|M3100.Pipe.directionality']
ValueMap['0', '2', '3']
Values['Unknown', 'Bi-Directional', 'Unidirectional']
Directionality property is in 5 classes of ROOT\CIMV2\storage\iscsitarget and in 3 namespaces
InstanceID property
CIMTYPE'string'
Description'Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
:
Where and are separated by a colon ':', and where MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority. (This is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between and . (For DMTF defined instances, the 'preferred' algorithm MUST be used with the set to 'CIM'.)
MUST include either a vendor specified unique identifier, or if mapping from an ITU M.3100 environment, the trailID, connectionID or subNetworkConnectionID of the instances of PipeR2.'
keyTrue
MappingStrings['Recommendation.ITU|M3100.TrailR1.trailId', 'Recommendation.ITU|M3100.ConnectionR1.connectionID', 'Recommendation.ITU|M3100.SubNetworkConnection.subNetworkConnectionID']
InstanceID property is in 40 classes of ROOT\CIMV2\storage\iscsitarget and in 21 namespaces

Derived properties (14) of CIM_NetworkPipe class

Caption property
CIMTYPE'string'
Caption property is in 90 classes of ROOT\CIMV2\storage\iscsitarget and in 37 namespaces
Description property
CIMTYPE'string'
Description property is in 91 classes of ROOT\CIMV2\storage\iscsitarget and in 142 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'
MappingStrings['Recommendation.ITU|M3100.Pipe.operationalState']
Override'EnabledState'
EnabledState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 59 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
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
RequestedState property
CIMTYPE'uint16'
MappingStrings['Recommendation.ITU|M3100.Pipe.administrativeState']
Override'RequestedState'
writeTrue
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
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 51 classes of ROOT\CIMV2\storage\iscsitarget and in 17 namespaces

CIM_NetworkPipe Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'NetworkPipe is a subclass of EnabledLogicalElement, representing the state and management of a connection or trail between endpoints. This object is different than the association between the endpoints (CIM_ActiveConnection) since the emphasis is NOT on the endpoints but on the management of the pipe itself - its state, configuration, etc. NetworkPipes are defined in the context of a CIM_Network and represent the 'transfer of information . . . between . . . endpoints'. These concepts are aligned with the definition of the Pipe object in ITU's M.3100 specification.'
MappingStrings['Recommendation.ITU|M3100.Pipe', 'Recommendation.ITU|M3100.TrailR1', 'Recommendation.ITU|M3100.ConnectionR1', 'Recommendation.ITU|M3100.SubNetworkConnection']
UMLPackagePath'CIM::Network::Pipes'
Version'2.7.0'

CIM_NetworkPipe System properties

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

Similar Classes to CIM_NetworkPipe

Number of classes:4
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_EndpointOfNetworkPipe130---
CIM_NetworkPipeComposition130---
MSISCSITARGET_EndpointOfNetworkPipe030----
MSISCSITARGET_NetworkPipeComposition030----
comments powered by Disqus
WUtils.com