# 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

Name | Data Type | Value
--- | --- | ---
Description | string | A representation of a communications endpoint where an SSH server can be accessed using the SSH protocol.
Experimental | boolean | true
UMLPackagePath | string | CIM::Network::ConsoleProtocols
Version | string | 2.22.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
Compression | boolean | true
Description | string | If this property is true, SSH compression is enabled.
Write | boolean | true
EncryptionAlgorithm | uint16 |
Description | string | The encryption algorithm currently in use for this connection.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.OtherEncryptionAlgorithm, CIM_SSHProtocolEndpoint.EnabledEncryptionAlgorithms
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, ..
Values | string | Unknown, Other, DES, DES3, RC4, IDEA, SKIPJACK, DMTF Reserved
Write | boolean | true
ForwardX11 | boolean | false
Description | string | If this property is true, the SSH X11 forwarding mode is enabled.
Write | boolean | true
IdleTimeout | uint32 | 0
Description | string | IdleTimeout 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.
PUnit | string | second
Units | string | Seconds
Write | boolean | true
KeepAlive | boolean | false
Description | string | If this property is true, the SSH keep alive timer is enabled.
Write | boolean | true
OtherEnabledEncryptionAlgorithm | string |
Description | string | If 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.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.EnabledEncryptionAlgorithms
OtherEnabledSSHVersion | string |
Description | string | If 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.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.EnabledSSHVersions
OtherEncryptionAlgorithm | string |
Description | string | If 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.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.EncryptionAlgorithm, CIM_SSHProtocolEndpoint.OtherEnabledEncryptionAlgorithm
Write | boolean | true
OtherSSHVersion | string |
Description | string | If 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.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.SSHVersion, CIM_SSHProtocolEndpoint.OtherEnabledSSHVersion
Write | boolean | true
SSHVersion | uint16 |
Description | string | The version of SSH in use for this connection.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.OtherSSHVersion, CIM_SSHProtocolEndpoint.EnabledSSHVersions
ValueMap | string | 0, 1, 2, 3, ..
Values | string | Unknown, Other, SSHv1, SSHv2, DMTF Reserved
Write | boolean | true
EnabledEncryptionAlgorithms | uint16[] |
ArrayType | string | Indexed
Description | string | An 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.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.OtherEnabledEncryptionAlgorithm
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 32768..65535
Values | string | Unknown, Other, DES, DES3, RC4, IDEA, SKIPJACK, DMTF Reserved, Vendor Reserved
Write | boolean | true
EnabledSSHVersions | uint16[] |
ArrayType | string | Indexed
Description | string | An 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.
ModelCorrespondence | string | CIM_SSHProtocolEndpoint.OtherEnabledSSHVersion
ValueMap | string | 0, 1, 2, 3, .., 32768..65535
Values | string | Unknown, Other, SSHv1, SSHv2, DMTF Reserved, Vendor Reserved
Write | boolean | true

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
BroadcastResetSupported | boolean | CIM_ProtocolEndpoint
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_ServiceAccessPoint
Description | string | CIM_ProtocolEndpoint
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_ProtocolEndpoint
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_ProtocolEndpoint
NameFormat | string | CIM_ProtocolEndpoint
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
OtherTypeDescription | string | CIM_ProtocolEndpoint
PrimaryStatus | uint16 | CIM_ManagedSystemElement
ProtocolIFType | uint16 | CIM_ProtocolEndpoint
ProtocolType | uint16 | CIM_ProtocolEndpoint
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_ServiceAccessPoint
SystemName | string | CIM_ServiceAccessPoint
TimeOfLastStateChange | datetime | CIM_ProtocolEndpoint
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ProtocolEndpoint
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
BroadcastReset | uint32 | CIM_ProtocolEndpoint
RequestStateChange | uint32 | CIM_EnabledLogicalElement