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

CIM_WBEMProtocolService

Class Qualifiers

NameData TypeValue
DescriptionstringProtocolService 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.
UMLPackagePathstringCIM::Core::Service
Versionstring2.39.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CurrentActiveConnectionsuint16
DescriptionstringCurrentActiveConnections 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.
MaxValuesint6465535
MinValuesint640
MaxConnectionsuint161
DescriptionstringMaxConnections specifies the maximum number of connections currently allowed by the service. The values 32768..65535 are DMTF Reserved.
MaxValuesint6465535
Writebooleantrue
OtherProtocolstring
DescriptionstringIf 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.
ModelCorrespondencestringCIM_ProtocolService.Protocol
Protocoluint16
DescriptionstringThe 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.
ModelCorrespondencestringCIM_ProtocolService.OtherProtocol
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8..32767, 32768..65535
ValuesstringUnknown, Other, SSH, Telnet, CLP, CIM-XML, WS-Management, CIM-RS, DMTF Reserved, Vendor Reserved

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

ListenOnPort (uint32)

Method Qualifiers (ListenOnPort)

NameData TypeValue
DescriptionstringCreate a CIM_TCPProtocoEndpoint instance and associate it with this CIM_ProtocolService instance via an instance of CIM_ServiceAccessBySAP. The newly created instance of CIM_TCPProtocolEndpoint will be for the port specified. When the CIM_IPProtocolEndpoint is not specified, the method will create an instance of CIM_HostedAccessPoint which associates the newly created CIM_TCPProtocolEndpoint instance with the instance of CIM_ComputerSystem with which this instance is associated via an instance of CIM_HostedService (the scoping system) It will also create instances of CIM_BindsTo which associate the created CIM_TCPProtocolEndpoint with each instance CIM_IPProtocolEndpoint which is associated with the scoping system. When an instance of CIM_IPProtocolEndpoint is specified, the CIM_HostedAccessPoint will associate the CIM_TCPProtocolEndpoint with the same instance which is associated with the CIM_IPProtocolEndpoint. In addition, the implementation will create a single instance of CIM_BindsTo that associates the CIM_TCPProtocolEndpoint with the specified instance of CIM_IPProtocolEndpoint. For each instance of CIM_BindsTo created by this method, the value of the Dependent property will be a reference to the newly created instance of CIM_TCPProtocolEndpoint. An extrinsic method is required in order to provide atomic creation of multiple, related instances. Prior to creating the instances, the implementation will verify that a CIM_TCPProtocolEndpoint instance can be created and associated with this instance.
ValueMapstring0, 1, 2, 4, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Error Occurred, Invalid Port, DMTF Reserved, Vendor Reserved

Method Parameters (ListenOnPort)

NameTypeQualifiers
NameData TypeValue
PortNumberuint32
DescriptionstringThe desired listening port.
Requiredbooleantrue
IPEndpoint REF CIM_IPProtocolEndpoint
DescriptionstringA specific CIM_IPProtocolEndpoint on which the service will listen to the specified port.
TCPEndpoint REF CIM_TCPProtocolEndpoint
DescriptionstringThe created TCPProtocolEndpoint.
INbooleanfalse
OUTbooleantrue

ListenOnPortIF (uint32)

Method Qualifiers (ListenOnPortIF)

NameData TypeValue
DescriptionstringCreate a CIM_TCPProtocoEndpoint instance and associate it with this CIM_ProtocolService instance via an instance of CIM_ServiceAccessBySAP. The newly created instance of CIM_TCPProtocolEndpoint shall be for the port and ProtocolIFType specified. When the CIM_IPProtocolEndpoint is not specified, the method shall create an instance of CIM_HostedAccessPoint which associates the newly created CIM_TCPProtocolEndpoint instance with the instance of CIM_ComputerSystem with which this instance is associated via an instance of CIM_HostedService (the scoping system). The implementation shall also create instances of CIM_BindsTo which associate the created CIM_TCPProtocolEndpoint with each instance CIM_IPProtocolEndpoint which is associated with the scoping system (in other words the listening port is bound to all IPs). When an instance of CIM_IPProtocolEndpoint is specified, the CIM_HostedAccessPoint shall associate the CIM_TCPProtocolEndpoint with the same instance which is associated with the CIM_IPProtocolEndpoint (andthe implementation shall only bind to the IP Address represented by the CIM_IPProtocolEndpoint). In addition, the implementation shall create a single instance of CIM_BindsTo that associates the CIM_TCPProtocolEndpoint with the specified instance of CIM_IPProtocolEndpoint. For each instance of CIM_BindsTo created by this method, the value of the Dependent property will be a reference to the newly created instance of CIM_TCPProtocolEndpoint. An extrinsic method is required in order to provide atomic creation of multiple, related instances. Prior to creating the instances, the implementation shall verify that a CIM_TCPProtocolEndpoint instance can be created and associated with this instance.
ValueMapstring0, 1, 2, 4, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Error Occurred, Invalid Port, DMTF Reserved, Vendor Reserved

Method Parameters (ListenOnPortIF)

NameTypeQualifiers
NameData TypeValue
PortNumberuint32
DescriptionstringThe desired listening port.
Requiredbooleantrue
ProtocolIFTypeuint32
DescriptionstringThe ProtocolIFType
Requiredbooleantrue
ValueMapstring1, 225..4095, 4111, 4200, 4201, 4202, 4203, 4204, 4205, 4300, 4400, 4401, 4402, 4403, 4404, 4405, 4406, 4301..32767
ValuesstringOther, IANA Reserved, TCP, NFS, CIFS, DAFS, WebDAV, HTTP, FTP, NDMP, Telnet, SSH, SM CLP, SMTP, LDAP, RDP, HTTPS, DMTF Reserved
IPEndpoint REF CIM_IPProtocolEndpoint
DescriptionstringA specific CIM_IPProtocolEndpoint on which the service will listen to the specified port.
TCPEndpoint REF CIM_TCPProtocolEndpoint
DescriptionstringThe created TCPProtocolEndpoint.
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service