Class CIM_PassThroughModule
extends CIM_LogicalModule

A device that is a replacement for physical cables and allows internal network physical ports in a chassis or rack to be made accessible from the external network. This may a fixed internal port to external port relationship, or a configurable mapping of internal ports to output ports via a cross-point switching function. The mapping between an internal and external port is modeled using the InternalPorts and ExternalPorts array properties. Corresponding array indices of the InternalPorts and ExternalPorts properties shall contain the port number of the internal port and external port, respectively in a mapping pair. Usage of this class is appropriate when modeling a simple n x n pass through module where the protocols supported by the module are not the target of management. Implementations wishing to enable management of the network function should instrument the appropriate device and network models. The tie into the device and network models is accomplished by correlating the port numbers in this class' internal and external port arrays with CIM_NetworkPort's PortNumber property. The following is an example of how this class could be used: For a given instance, the value of NumberOfPorts is 3. This indicates that there are 3 internal ports and 3 external ports. Internal port 2 is mapped to external port 3. Internal ports 1 and 3 are not mapped to an external port. External ports 1 and 2 are not mapped to internal ports. For this instance the length of the InternalPorts and ExternalPorts arrays shall both be one. The first array position in InternalPortshall contain the value 2. The first array position in ExternalPorts shall contain the value 3.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_LogicalModule
   |
   +--CIM_PassThroughModule

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA device that is a replacement for physical cables and allows internal network physical ports in a chassis or rack to be made accessible from the external network. This may a fixed internal port to external port relationship, or a configurable mapping of internal ports to output ports via a cross-point switching function. The mapping between an internal and external port is modeled using the InternalPorts and ExternalPorts array properties. Corresponding array indices of the InternalPorts and ExternalPorts properties shall contain the port number of the internal port and external port, respectively in a mapping pair. Usage of this class is appropriate when modeling a simple n x n pass through module where the protocols supported by the module are not the target of management. Implementations wishing to enable management of the network function should instrument the appropriate device and network models. The tie into the device and network models is accomplished by correlating the port numbers in this class' internal and external port arrays with CIM_NetworkPort's PortNumber property. The following is an example of how this class could be used: For a given instance, the value of NumberOfPorts is 3. This indicates that there are 3 internal ports and 3 external ports. Internal port 2 is mapped to external port 3. Internal ports 1 and 3 are not mapped to an external port. External ports 1 and 2 are not mapped to internal ports. For this instance the length of the InternalPorts and ExternalPorts arrays shall both be one. The first array position in InternalPortshall contain the value 2. The first array position in ExternalPorts shall contain the value 3.
UMLPackagePathstringCIM::Device::Controller
Versionstring2.22.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
IsProgrammablebooleanfalse
DescriptionstringBoolean indicating if the port assignments on this switch are software programmable or not.
NumberOfPortsuint16
DescriptionstringA PassThroughModule is a simple module with 1-1 correspondence between internal and external ports. This number represents the number of external ports. By virtue of there being a 1-1 correspondence of ports, it also represents the number of internal ports. The ports are numbered 1 through N.
ExternalPortsuint16[]
ArrayTypestringIndexed
DescriptionstringAn indexed array containing the external ports. Corresponding internal ports are in the InternalPorts array. Only external ports which are mapped to an internal port shall appear in the array.
ModelCorrespondencestringCIM_PassThroughModule.InternalPorts, CIM_NetworkPort.PortNumber
InternalPortsuint16[]
ArrayTypestringIndexed
DescriptionstringAn indexed array containing the internal port numbers. Corresponding external ports are in the ExternalPorts array. Only internal ports which are mapped to an external port shall appear in the array.
ModelCorrespondencestringCIM_PassThroughModule.ExternalPorts, CIM_NetworkPort.PortNumber
LinkTechnologiesuint16[]
ArrayTypestringIndexed
DescriptionstringAn enumeration of the link technologies that can be passed- through by this device. When set to 1 ("Other"), the property OtherLinkTechnologies contains string descriptions of the alternative link types.
ModelCorrespondencestringCIM_PassThroughModule.OtherLinkTechnologies
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12..32767, 32768..65535
ValuesstringUnknown, Other, Ethernet, IB, FC, FDDI, ATM, Token Ring, Frame Relay, Infrared, BlueTooth, Wireless LAN, DMTF Reserved, Vendor Specified
OtherLinkTechnologiesstring[]
ArrayTypestringIndexed
DescriptionstringAn array of string values describing the supported technologies when an entry in the LinkTechnologies array is set to 1, "Other".
ModelCorrespondencestringCIM_PassThroughModule.LinkTechnologies

Inherited Properties

NameData TypeClass Origin
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
LogicalModuleTypeuint16CIM_LogicalModule
MaxQuiesceTimeuint64CIM_LogicalDevice
ModuleNumberuint16CIM_LogicalModule
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherLogicalModuleTypeDescriptionstringCIM_LogicalModule
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

AssignPorts (uint32)

Method Qualifiers (AssignPorts)

NameData TypeValue
DescriptionstringIf the switch is software programmable, then this method is called to assign an internal port to an external port. If 0 is returned, the requested status of the mapping of InternalPort and ExternalPort is in effect. That is, an attempt to unmap two ports that are not mapped to any other ports or an attempt to map two ports which are already mapped to each other shall return 0, because the resultant state of the mapping is equivalent to the client request. For a mapping operation, if either target port is already mapped to a different port, the implementation shall first unmap it. An attempt to unmap two ports that are not mapped to each other shall fail with an error of "Not Mapped".
ValueMapstring0, 1, 2, 3, 4, 5..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Busy, Not Mapped, DMTF Reserved, Vendor Reserved

Method Parameters (AssignPorts)

NameTypeQualifiers
NameData TypeValue
ExternalPortuint16
DescriptionstringThe mapping for this external port shall be updated.
INbooleantrue
InternalPortuint16
DescriptionstringThe mapping for this internal port shall be updated.
INbooleantrue
Mappedboolean
DescriptionstringBoolean indicating if the ports are to be unmapped or mapped. If "True", InternalPorts and ExternalPorts shall be updated to contain a mapping of InternalPort to ExternalPort. If "False", InternalPorts and ExternalPorts shall be updated to remove the mapping if one exists.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice