# Class CIM_ProtocolService
extends CIM_Service

ProtocolService represents represents an application layer service available on a hosting system. Often times, the service name reflects the employed/supported communication protocol (e.g. file transfer - FTP), however in some other cases it does not. (e.g. mail notification service - biff). Access to the service is modeled with one or more instances of ProtocolEndpoint. This class represents the availability of the function on the system. Issuing a stop to this instance is equivalent to disabling the functionality and making it unavailable to users. Thus a stop of this service will result in the removing of all ProtocolEndpoints which are associated with the instance via ServicAccessBySAP. The functionality can be made available again by issuing a start to the service. This class contains service definitions which are currently needed. Future extensions are expected.

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

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_Service
|
+--CIM_ProtocolService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | ProtocolService represents represents an application layer service available on a hosting system. Often times, the service name reflects the employed/supported communication protocol (e.g. file transfer - FTP), however in some other cases it does not. (e.g. mail notification service - biff). Access to the service is modeled with one or more instances of ProtocolEndpoint. This class represents the availability of the function on the system. Issuing a stop to this instance is equivalent to disabling the functionality and making it unavailable to users. Thus a stop of this service will result in the removing of all ProtocolEndpoints which are associated with the instance via ServicAccessBySAP. The functionality can be made available again by issuing a start to the service. This class contains service definitions which are currently needed. Future extensions are expected.
UMLPackagePath | string | CIM::Core::Service
Version | string | 2.39.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CurrentActiveConnections | uint16 |
Description | string | CurrentActiveConnections indicates the number of sessions currently established with the protocol service. A value of null for this property shall indicate the number of active sessions is unknown. A value of zero shall indicate there are no active sessions. Any other value shall correspond to the number of active sessions.
MaxValue | sint64 | 65535
MinValue | sint64 | 0
MaxConnections | uint16 | 1
Description | string | MaxConnections specifies the maximum number of connections currently allowed by the service. The values 32768..65535 are DMTF Reserved.
MaxValue | sint64 | 65535
Write | boolean | true
OtherProtocol | string |
Description | string | If the Protocol property is set to 1 "Other" then free form string providing more information about the protocol. If not set to 1, this string has no meaning.
ModelCorrespondence | string | CIM_ProtocolService.Protocol
Protocol | uint16 |
Description | string | The protocol this service provides. Values defined for this property are limited to the known use cases where it is desirable to represent the ability to enable or disable the functionality on the system.
ModelCorrespondence | string | CIM_ProtocolService.OtherProtocol
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8..32767, 32768..65535
Values | string | Unknown, Other, SSH, Telnet, CLP, CIM-XML, WS-Management, CIM-RS, DMTF Reserved, Vendor Reserved

### Inherited Properties

Name | Data Type
--- | ---
Caption | string
CommunicationStatus | uint16
CreationClassName | string
Description | string
DetailedStatus | uint16
ElementName | string
EnabledDefault | uint16
EnabledState | uint16
Generation | uint64
HealthState | uint16
InstallDate | datetime
InstanceID | string
LoSID | string
LoSOrgID | string
Name | string
OperatingStatus | uint16
OtherEnabledState | string
PrimaryOwnerContact | string
PrimaryOwnerName | string
PrimaryStatus | uint16
RequestedState | uint16
Started | boolean
StartMode | string
Status | string
SystemCreationClassName | string
SystemName | string
TimeOfLastStateChange | datetime
TransitioningToState | uint16
AvailableRequestedStates | uint16[]
OperationalStatus | uint16[]
StatusDescriptions | string[]

## Class Methods

### Inherited Class Methods

Name | Return Type
--- | ---
ChangeAffectedElementsAssignedSequence | uint32
RequestStateChange | uint32
StartService | uint32
StopService | uint32