Kaspersky Industrial CyberSecurity for Networks API Developer's Guide

ConfigurationProvider

Kaspersky Industrial CyberSecurity for Networks configuration provider service.

Defined in

This service is defined in the configuration_provider_service.proto file.

Syntax

service ConfigurationProvider

{

rpc GetKscConfiguration(google.protobuf.Empty) returns(KscConfiguration);

rpc GetConfigurationMetadata(google.protobuf.Empty) returns(ConfigurationMetadata);

rpc GetPlcConfiguration(google.protobuf.Empty) returns(stream PlcConfiguration);

rpc GetProtocolConfiguration(HashIdValue) returns(stream ProtocolConfiguration);

rpc GetTagsForPlc(HashIdValue) returns(stream TagDescriptor);

rpc GetTagsForProtocol(HashIdValue) returns(stream TagDescriptor);

rpc GetEventDescriptors(google.protobuf.Empty) returns(stream EventDescriptor);

}

Service methods

The ConfigurationProvider service has the following service methods.

ConfigurationProvider service methods

Name

Request message

Response message

Description

GetKscConfiguration

google.protobuf.Empty

KscConfiguration

Returns configuration for Kaspersky Security Center agent.

GetConfigurationMetadata

google.protobuf.Empty

ConfigurationMetadata

Returns current Kaspersky Industrial CyberSecurity for Networks configuration metadata.

GetPlcConfiguration

google.protobuf.Empty

stream PlcConfiguration

Returns a list of PLCs and information about them.

GetProtocolConfiguration

HashIdValue

stream ProtocolConfiguration

Returns configuration for protocols of the specified PLC.

GetTagsForPlc

HashIdValue

stream TagDescriptor

Returns tag descriptors for the specified PLC.

GetTagsForProtocol

HashIdValue

stream TagDescriptor

Returns tag descriptors for the specified protocol.

GetEventDescriptors

google.protobuf.Empty

stream EventDescriptor

Returns descriptors for event types.

Remarks

If no configuration is loaded into Kaspersky Industrial CyberSecurity for Networks, calling ConfigurationProvider service methods results in an error.