CIM211 Class Declaration
CIM_LogicalPortCapabilities

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_LogicalPortCapabilities --> CIM_EnabledLogicalElementCapabilities --> CIM_Capabilities --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_EnabledLogicalElementCapabilities
NAMECIM_LogicalPortCapabilities

Class Qualifiers

Class CIM_LogicalPortCapabilities Qualifiers
NameTypeValueFrom Class
Versionstring2.11.0 CIM_LogicalPortCapabilities
DescriptionstringLogicalPortCapabilities describes the configuration capabilities for properties in LogicalPortSettings. CIM_LogicalPortCapabilities
DescriptionstringEnabledStateCapabilities describes the capabilities supported for changing the state OF THE ASSOCIATED EnabledLogicalElement. CIM_EnabledLogicalElementCapabilities
DescriptionstringCapabilities is an abstract class whose subclasses describe abilities and/or potential for use. For example, one may describe the maximum number of VLANs that can be supported on a system using a subclass of Capabilities. Capabilities are tied to the elements which they describe using the ElementCapabilities association. Note that the cardinality of the ManagedElement reference is Min(1), Max(1). This cardinality mandates the instantiation of the ElementCapabilities association for the referenced instance of Capabilities. ElementCapabilities describes the existence requirements and context for the referenced instance of ManagedElement. Specifically, the ManagedElement MUST exist and provides the context for the Capabilities. Note that Capabilities do not indicate what IS configured or operational, but what CAN or CANNOT exist, be defined or be used. Note that it is possible to describe both supported and excluded abilities and functions (both capabilities and limitations) using this class. CIM_Capabilities
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
RequestedSpeedsSupporteduint64[] Description
ModelCorrespondence
CIM_LogicalPortCapabilities
AutoSenseSpeedConfigurableboolean Description
ModelCorrespondence
CIM_LogicalPortCapabilities
ElementNameEditSupportedboolean Description
MappingStrings
ModelCorrespondence
CIM_EnabledLogicalElementCapabilities
MaxElementNameLenuint16 Description
MaxValue
MappingStrings
ModelCorrespondence
CIM_EnabledLogicalElementCapabilities
RequestedStatesSupporteduint16[] Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElementCapabilities
InstanceIDstring Key
Description
CIM_Capabilities
ElementNamestring Required
Override
Description
CIM_Capabilities
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property RequestedSpeedsSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringList of supported port speeds that can be configured on LogicalPortSettings.RequestedSpeed. CIM_LogicalPortCapabilities
ModelCorrespondencestringCIM_NetworkPort.Speed CIM_LogicalPortCapabilities

Property AutoSenseSpeedConfigurable Qualifiers
NameTypeValueFrom Class
DescriptionstringA boolean indicating whether the value in LogicalPortSettings.AutoSenseSpeed may be changed (TRUE), or may only be viewed (FALSE). CIM_LogicalPortCapabilities
ModelCorrespondencestringCIM_NetworkPort.Speed CIM_LogicalPortCapabilities

Property ElementNameEditSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean indicating whether the ElementName can be modified. CIM_EnabledLogicalElementCapabilities
MappingStringsstringFC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|EditName CIM_EnabledLogicalElementCapabilities
ModelCorrespondencestringCIM_ManagedElement.ElementName CIM_EnabledLogicalElementCapabilities

Property MaxElementNameLen Qualifiers
NameTypeValueFrom Class
DescriptionstringMaximum supported ElementName length. CIM_EnabledLogicalElementCapabilities
MaxValuesint64256 CIM_EnabledLogicalElementCapabilities
MappingStringsstringFC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|MaxNameChars CIM_EnabledLogicalElementCapabilities
ModelCorrespondencestringCIM_FCSwitchCapabilities.ElementNameEditSupported CIM_EnabledLogicalElementCapabilities

Property RequestedStatesSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedStatesSupported indicates the possible states that can be requested when using the method RequestStateChange on the EnabledLogicalElement. CIM_EnabledLogicalElementCapabilities
ValueMapstring
[See below.]
CIM_EnabledLogicalElementCapabilities
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
CIM_EnabledLogicalElementCapabilities
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestStateChange CIM_EnabledLogicalElementCapabilities

NameValue
2Enabled
3Disabled
4Shut Down
6Offline
7Test
8Defer
9Quiesce
10Reboot
11Reset
Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Capabilities
DescriptionstringWithin 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: < OrgID > : < LocalID > Where < OrgID > and < LocalID > are separated by a colon ’ : ’ , and where < OrgID > 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 < Schema Name > _ < Class Name > structure of Schema class names.) In addition, to ensure uniqueness < OrgID > MUST NOT contain a colon ( ’ : ’ ). When using this algorithm, the first colon to appear in InstanceID MUST appear between < OrgID > and < LocalID > . < LocalID > is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance ’ s NameSpace. For DMTF defined instances, the ’ preferred ’ algorithm MUST be used with the < OrgID > set to ’ CIM ’ . CIM_Capabilities

Property ElementName Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Capabilities
OverridestringElementName CIM_Capabilities
DescriptionstringThe user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) CIM_Capabilities

Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
CreateGoalSettingsuint16 Experimental
Description
ValueMap
Values
TemplateGoalSettings
SupportedGoalSettings
CIM_Capabilities

Method Qualifiers

Method CreateGoalSettings Qualifiers
NameTypeValueFrom Class
DescriptionstringMethod to create a set of supported SettingData elements, from two sets of SettingData elements, provided by the caller. CreateGoal should be used when the SettingData instances that represents the goal will not persist beyond the execution of the client and where those instances are not intended to be shared with other, non-cooperating clients. Both TemplateGoalSettings and SupportedGoalSettings are represented as strings containing EmbeddedInstances of a CIM_SettingData subclass. These embedded instances do not exist in the infrastructure supporting this method but are maintained by the caller/client. This method should return CIM_Error(s) representing that a single named property of a setting (or other) parameter (either reference or embedded object) has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested. If the input TemplateGoalSettings is NULL or the empty string, this method returns a default SettingData element that is supported by this Capabilities element. If the TemplateGoalSettings specifies values that cannot be supported, this method shall return an appropriate CIM_Error and should return a best match for a SupportedGoalSettings. The client proposes a goal using the TemplateGoalSettings parameter and gets back Success if the TemplateGoalSettings is exactly supportable. It gets back " Alternative Proposed " if the output SupportedGoalSettings represents a supported alternative. This alternative should be a best match, as defined by the implementation. If the implementation is conformant to a RegisteredProfile, then that profile may specify the algorithms used to determine best match. A client may compare the returned value of each property against the requested value to determine if it is left unchanged, degraded or upgraded. Otherwise, if the TemplateGoalSettings is not applicable an " Invalid Parameter " error is returned. When a mutually acceptable SupportedGoalSettings has been achieved, the client may use the contained SettingData instances as input to methods for creating a new object ormodifying an existing object. Also the embedded SettingData instances returned in the SupportedGoalSettings may be instantiated via CreateInstance, either by a client or as a side-effect of the execution of an extrinsic method for which the returned SupportedGoalSettings is passed as an embedded instance. CIM_Capabilities
ValueMapstring
[See below.]
CIM_Capabilities
ValuesstringSuccess
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
Alternative Proposed
DMTF Reserved
Vendor Specific
CIM_Capabilities

Parameters

Method CreateGoalSettings Parameters
NameTypeQualifiers
TemplateGoalSettingsstringIN
Description
EmbeddedInstance
SupportedGoalSettingsstringIN
OUT
Description
EmbeddedInstance

Parameter Qualifiers

Parameter TemplateGoalSettings Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Capabilities
DescriptionstringIf provided, TemplateGoalSettings are elements of class CIM_SettingData, or a derived class, that is used as the template to be matched. . At most, one instance of each SettingData subclass may be supplied. All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance. SettingData instances that are not relevant to this instance are ignored. If not provided, it shall be set to NULL. In that case, a SettingData instance representing the default settings of the associated ManagedElement is used. CIM_Capabilities
EmbeddedInstancestringCIM_SettingData CIM_Capabilities

Parameter SupportedGoalSettings Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Capabilities
OUTbooleantrue CIM_Capabilities
DescriptionstringSupportedGoalSettings are elements of class CIM_SettingData, or a derived class. At most, one instance of each SettingData subclass may be supplied. All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance. To enable a client to provide additional information towards achieving the TemplateGoalSettings, an input set of SettingData instances may be provided. If not provided, this property shall be set to NULL on input.. Note that when provided, what property values are changed, and how, is implementation dependent and may be the subject of other standards. If provided, the input SettingData instances must be ones that the implementation is able to support relative to the ManagedElement associated via ElementCapabilities. Typically, the input SettingData instances are created by a previous instantiation of CreateGoalSettings. If the input SupportedGoalSettings is not supported by the implementation, then an " Invalid Parameter " (5) error is returned by this call. In this case, a corresponding CIM_ERROR should also be returned. On output, this property is used to return the best supported match to the TemplateGoalSettings. If the output SupportedGoalSettings matches the input SupportedGoalSettings, then the implementation is unable to improve further towards meeting the TemplateGoalSettings. CIM_Capabilities
EmbeddedInstancestringCIM_SettingData CIM_Capabilities

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_DefaultElementCapabilitiesCIM_CapabilitiesCapabilities
CIM_SettingAssociatedToCapabilitiesCIM_CapabilitiesAntecedent
CIM_ElementCapabilitiesCIM_CapabilitiesCapabilities
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement