KSC Open API
Kaspersky Security Center API description
Gcm Class Reference

Interface to manage settings of using the GCM service. More...

List of all members.

Public Member Functions

boolean GetGcmServerSettings ([out] wstring wstrSenderId,[out] wstring wstrApiKey)
 Retrieves GCM (Google Cloud Messaging) server settings.
boolean UpdateGcmServerSettings (wstring wstrSenderId, wstring wstrApiKey)
 Updates GCM (Google Cloud Messaging) server settings.
 DeleteGcmServerSettings ()
 Deletes GCM (Google Cloud Messaging) server settings.
 GetGcmPropagation2VS ([out] boolean bPropagate2VS)
 Retrieves GCM settings propagation option. GCM settings can be propagated to virtual server in one case only - if it is absent on virtual server.
 SetGcmPropagation2VS (boolean bPropagate2VS)
 Sets possibility for GCM settings propagation from main server to virtual servers. GCM settings can be propagated to virtual server in one case only - if it is absent on virtual server.
boolean CheckIfGcmServerSettingsPresent ()
 It checks if GCM server settings are present.
boolean CheckIfGcmServerSettingsShouldBeSet ()
 It checks if GCM server settings should be set.

Detailed Description

Interface to manage settings of using the GCM service.

See also Python code with use of KlAkOAPI Python package below:

        # create server object
        server = KlAkOAPI.AdmServer.KlAkAdmServer.Create("https://ksc.example.com:13299", "username", "password", verify = False)
        # create object correspondent to OpenAPI interface
        oGcm = KlAkOAPI.Gcm.KlAkGcm(server)
        # use Gcm OpenAPI interface...
        # check if GCM server settings are present
        bSettingsPresent = oGcm.CheckIfGcmServerSettingsPresent().RetVal()