Class CIM_SSHProtocolEndpoint
extends CIM_ProtocolEndpoint

A representation of a communications endpoint where an SSH server can be accessed using the SSH protocol.

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

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_ServiceAccessPoint
   |
   +--CIM_ProtocolEndpoint
   |
   +--CIM_SSHProtocolEndpoint

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA representation of a communications endpoint where an SSH server can be accessed using the SSH protocol.
UMLPackagePathstringCIM::Network::ConsoleProtocols
Versionstring2.22.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
Compressionbooleantrue
DescriptionstringIf this property is true, SSH compression is enabled.
Writebooleantrue
EncryptionAlgorithmuint16
DescriptionstringThe encryption algorithm currently in use for this connection.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.OtherEncryptionAlgorithm, CIM_SSHProtocolEndpoint.EnabledEncryptionAlgorithms
ValueMapstring0, 1, 2, 3, 4, 5, 6, ..
ValuesstringUnknown, Other, DES, DES3, RC4, IDEA, SKIPJACK, DMTF Reserved
Writebooleantrue
ForwardX11booleanfalse
DescriptionstringIf this property is true, the SSH X11 forwarding mode is enabled.
Writebooleantrue
IdleTimeoutuint320
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.
PUnitstringsecond
UnitsstringSeconds
Writebooleantrue
KeepAlivebooleanfalse
DescriptionstringIf this property is true, the SSH keep alive timer is enabled.
Writebooleantrue
OtherEnabledSSHVersionstring
DescriptionstringIf the EnabledSSHVersions property is set to 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.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.EnabledSSHVersions
OtherSSHVersionstring
DescriptionstringIf the SSHVersion 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.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.SSHVersion, CIM_SSHProtocolEndpoint.OtherEnabledSSHVersion
Writebooleantrue
SSHVersionuint16
DescriptionstringThe version of SSH in use for this connection.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.OtherSSHVersion, CIM_SSHProtocolEndpoint.EnabledSSHVersions
ValueMapstring0, 1, 2, 3, ..
ValuesstringUnknown, Other, SSHv1, SSHv2, DMTF Reserved
Writebooleantrue
EnabledEncryptionAlgorithmsuint16[]
ArrayTypestringIndexed
DescriptionstringAn array of integers indicating the encryption algorithms that are enabled for this SSH service. Its possible for an encryption algorithm to be supported by an SSH service and not be enabled to be used. One of the enabled algorithms will actually be in use.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.OtherEnabledEncryptionAlgorithm
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 32768..65535
ValuesstringUnknown, Other, DES, DES3, RC4, IDEA, SKIPJACK, DMTF Reserved, Vendor Reserved
Writebooleantrue
EnabledSSHVersionsuint16[]
ArrayTypestringIndexed
DescriptionstringAn array of integers indicating the version or versions of SSH protocol that are enabled for the SSH service. Its possible for versions to be supported for a service and not currently enabled for use.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.OtherEnabledSSHVersion
ValueMapstring0, 1, 2, 3, .., 32768..65535
ValuesstringUnknown, Other, SSHv1, SSHv2, DMTF Reserved, Vendor Reserved
Writebooleantrue
OtherEnabledEncryptionAlgorithmstring[]
ArrayTypestringIndexed
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.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.EnabledEncryptionAlgorithms
OtherEncryptionAlgorithmstring[]
ArrayTypestringIndexed
DescriptionstringIf the EncryptionAlgorithm property is set to 1, "Other" then this is a free form string providing more information about the current encryption algorithm. If not set to 1, this string has no meaning.
ModelCorrespondencestringCIM_SSHProtocolEndpoint.EncryptionAlgorithm, CIM_SSHProtocolEndpoint.OtherEnabledEncryptionAlgorithm
Writebooleantrue

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_ServiceAccessPoint
DescriptionstringCIM_ProtocolEndpoint
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_ProtocolEndpoint
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_ProtocolEndpoint
NameFormatstringCIM_ProtocolEndpoint
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherTypeDescriptionstringCIM_ProtocolEndpoint
PrimaryStatusuint16CIM_ManagedSystemElement
ProtocolIFTypeuint16CIM_ProtocolEndpoint
ProtocolTypeuint16CIM_ProtocolEndpoint
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_ServiceAccessPoint
SystemNamestringCIM_ServiceAccessPoint
TimeOfLastStateChangedatetimeCIM_ProtocolEndpoint
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ProtocolEndpoint
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement