CIM2.17.1 Class Declaration
CIM_SSHSettingData

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

Class Hierarchy

CIM_SSHSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SettingData
NAMECIM_SSHSettingData

Class Qualifiers

Class CIM_SSHSettingData Qualifiers
NameTypeValueFrom Class
ExperimentalbooleantrueCIM_SSHSettingData
Versionstring2.10.0CIM_SSHSettingData
UMLPackagePathstringCIM::Network::ConsoleProtocolsCIM_SSHSettingData
DescriptionstringA representation of the SettingData of an SSH endpoint.CIM_SSHSettingData
UMLPackagePathstringCIM::Core::SettingsCIM_SettingData
DescriptionstringCIM_SettingData is used to represent configuration and and operational parameters for CIM_ManagedElement instances. There are a number of different uses of CIM_SettingData supported in the model today. Additional uses may be defined in the future.Instances of CIM_SettingData may represent Aspects of a CIM_ManagedElement instance. This is modeled using the CIM_SettingsDefineState association. CIM_SettingData may be used to define capabilities when associated to an instance of CIM_Capabilities through the CIM_SettingsDefineCapabilities association. Instances of CIM_SettingData may represent different types of configurations for a CIM_ManagedElement, including persistent configurations, in progress configuration changes, or requested configurations. The CIM_ElementSettingData association is used to model the relationship between a CIM_SettingData instance and the CIM_ManagedElement for which it is a configuration. When an instance of CIM_SettingData represents a configuration, the current operational values for the parameters of the element are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values that are present in the SettingData object. For example, a modem might have a SettingData baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note: The CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model because many implementations have successfully used CIM_Setting. However, issues have arisen that could not be resolved without defining a new class. Therefore, until a new major release occurs, both classes will exist in the model. Refer to the Core White Paper for additional information. SettingData instances can be aggregated together into higher- level SettingData objects using ConcreteComponent associations.CIM_SettingData
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
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
EnabledSSHVersionsuint16[] Write
Description
ValueMap
Values
ModelCorrespondence
CIM_SSHSettingData
OtherEnabledSSHVersionstring Write
Description
ModelCorrespondence
CIM_SSHSettingData
SSHVersionuint16 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_SSHSettingData
OtherSSHVersionstring Write
Description
ModelCorrespondence
CIM_SSHSettingData
EnabledEncryptionAlgorithmsuint16[] Write
Description
ValueMap
Values
ModelCorrespondence
CIM_SSHSettingData
OtherEnabledEncryptionAlgorithmstring Write
Description
ModelCorrespondence
CIM_SSHSettingData
EncryptionAlgorithmuint16 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_SSHSettingData
OtherEncryptionAlgorithmstring Write
Description
ModelCorrespondence
CIM_SSHSettingData
IdleTimeoutuint320Write
Description
Units
PUnit
CIM_SSHSettingData
KeepAlivebooleanfalseWrite
Description
CIM_SSHSettingData
ForwardX11booleanfalseWrite
Description
CIM_SSHSettingData
CompressionbooleantrueWrite
Description
CIM_SSHSettingData
InstanceIDstring Key
Description
CIM_SettingData
ElementNamestring Required
Override
Description
CIM_SettingData
ConfigurationNamestring Experimental
Description
CIM_SettingData
ChangeableTypeuint16 Experimental
Description
ValueMap
Values
CIM_SettingData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property EnabledSSHVersions Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringAn array of integers indicating the version or versions of SSH protocol that will be enabled for the SSH endpoint.CIM_SSHSettingData
ValueMapstring
[See below.]
CIM_SSHSettingData
ValuesstringUnknown
Other
SSHv1
SSHv2
DMTF Reserved
Vendor Reserved
CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHSettingData.OtherEnabledSSHVersionCIM_SSHSettingData

NameValue
0Unknown
1Other
2SSHv1
3SSHv2
4..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledSSHVersion Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringWhen the EnabledSSHVersions property contains a value of 1, "Other" then this is a free form string providing more information about the SSH protocol. If not set to 1, this string has no meaning.CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHSettingData.EnabledSSHVersionsCIM_SSHSettingData

Property SSHVersion Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringThe version of SSH that will be in use if this SettingData is applied.CIM_SSHSettingData
ValueMapstring
[See below.]
CIM_SSHSettingData
ValuesstringUnknown
Other
SSHv1
SSHv2
DMTF Reserved
Vendor Reserved
CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHSettingData.OtherSSHVersion
CIM_SSHSettingData.EnabledSSHVersions
CIM_SSHSettingData

NameValue
0Unknown
1Other
2SSHv1
3SSHv2
4..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherSSHVersion Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringIf the CurrentSSHVersion property is set to 1, "Other" then this is a free form string providing more information about the current SSH protocol. If not set to 1, this string has no meaning.CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHSettingData.SSHVersion
CIM_SSHSettingData.OtherEnabledSSHVersion
CIM_SSHSettingData

Property EnabledEncryptionAlgorithms Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringAn array of integers indicating the encryption algorithms that are enabled for this SSH service. Its possible for an encryption algorithm to be supported and not currently enabled to be used.CIM_SSHSettingData
ValueMapstring
[See below.]
CIM_SSHSettingData
ValuesstringUnknown
Other
DES
DES3
RC4
IDEA
SKIPJACK
DMTF Reserved
Vendor Reserved
CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHSettingData.OtherEnabledEncryptionAlgorithmCIM_SSHSettingData

NameValue
0Unknown
1Other
2DES
3DES3
4RC4
5IDEA
6SKIPJACK
7..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledEncryptionAlgorithm Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringIf the EnabledEncryptionAlgorithms property is set 1, "Other" this property contains a free form string providing more information about supported algorithms. If not set to 1, this string has no meaning.CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHProtocolEndpoint.EnabledEncryptionAlgorithmsCIM_SSHSettingData

Property EncryptionAlgorithm Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringThe encryption algorithm that will be in use if this SettingData is applied.CIM_SSHSettingData
ValueMapstring
[See below.]
CIM_SSHSettingData
ValuesstringUnknown
Other
DES
DES3
RC4
IDEA
SKIPJACK
CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHSettingData.OtherEncryptionAlgorithm
CIM_SSHProtocolEndpoint.EnabledEncryptionAlgorithms
CIM_SSHSettingData

NameValue
0Unknown
1Other
2DES
3DES3
4RC4
5IDEA
6SKIPJACK
Property OtherEncryptionAlgorithm Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringIf the EncryptionAlgorithm property is set 1, "Other" then this is a free form string providing more information about the encryption algorithm in use. If not set to 1, this string has no meaning.CIM_SSHSettingData
ModelCorrespondencestringCIM_SSHSettingData.EncryptionAlgorithm
CIM_SSHSettingData.OtherEnabledEncryptionAlgorithm
CIM_SSHSettingData

Property IdleTimeout Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringIdleTimeout specifies how long the connection can be idle before the connection is terminated. The default value, 0, indicates that there is no idle timeout period.CIM_SSHSettingData
UnitsstringSecondsCIM_SSHSettingData
PUnitstringsecondCIM_SSHSettingData

Property KeepAlive Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringIf this property is true, the SSH keep alive timer is enabled.CIM_SSHSettingData

Property ForwardX11 Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringIf this property is true, the SSH X11 forwarding mode is enabled.CIM_SSHSettingData

Property Compression Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_SSHSettingData
DescriptionstringIf this property is true, SSH compression is enabled.CIM_SSHSettingData

Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_SettingData
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. 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 that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.CIM_SettingData

Property ElementName Qualifiers
NameTypeValueFrom Class
RequiredbooleantrueCIM_SettingData
DescriptionstringThe user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)CIM_SettingData

Property ConfigurationName Qualifiers
NameTypeValueFrom Class
DescriptionstringAn instance of CIM_SettingData may correspond to a well-known configuration that exists for an associated CIM_ManagedElement. If the ConfigurationName property is non-NULL, the instance of CIM_SettingData shall correspond to a well-known configuration for a Managed Element, the value of the ConfigurationName property shall be the name of the configuration, and the ChangeableType property shall have the value 0 or 2. A value of NULL for the ConfigurationName property shall mean that the instance of CIM_SettingData does not correspond to a well-known configuration for a Managed Element or that this information is unknown.CIM_SettingData

Property ChangeableType Qualifiers
NameTypeValueFrom Class
DescriptionstringEnumeration indicating the type of setting. 0 "Not Changeable - Persistent" indicates the instance of SettingData represents primordial settings and shall not be modifiable. 1 "Changeable - Transient" indicates the SettingData represents modifiable settings that are not persisted. Establishing persistent settings from transient settings may be supported. 2 "Changeable - Persistent" indicates the SettingData represents a persistent configuration that may be modified. 3 "Not Changeable - Transient" indicates the SettingData represents a snapshot of the settings of the associated ManagedElement and is not persistent.CIM_SettingData
ValueMapstring
[See below.]
CIM_SettingData
ValuesstringNot Changeable - Persistent
Changeable - Transient
Changeable - Persistent
Not Changeable - Transient
CIM_SettingData

NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_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

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_SettingsDefineStateCIM_SettingDataSettingData
CIM_SettingsDefineCapabilitiesCIM_SettingDataPartComponent
CIM_SettingAssociatedToCapabilitiesCIM_SettingDataDependent
CIM_SettingsAffectSettingsCIM_SettingDataAntecedent
CIM_SettingsAffectSettingsCIM_SettingDataDependent
CIM_ElementSettingDataCIM_SettingDataSettingData
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_SettingsDefineStateCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_OrderedComponentCIM_ManagedElementGroupComponent
CIM_OrderedComponentCIM_ManagedElementPartComponent
CIM_ProductElementComponentCIM_ManagedElementPartComponent
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_OrderedMemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_MemberOfStatusCollectionCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_AbstractIndicationSubscriptionCIM_ManagedElementFilter
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_AvailableDiagnosticServiceCIM_ManagedElementUserOfService
CIM_AssociatedPowerManagementServiceCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement