KSC Open API  13.0
Kaspersky Security Center API description
Distribution point scope

Distribution point scope determines which hosts will use this distribution point as a file source.
Distribution points may be assigned to:

  • Administration groups
  • NLA-defined networks
  • Automatically detected and maintained broadcast domains

Distribution point scope is defined as a container of scope ID arrays.

Distribution point may be assigned to more than one group and NLA network at the same time.

Attribute nameData typeDescription
ScopeGroupsparamArrayparamArray of scope ID containers with administration group IDs.
ScopeNlaNetworksparamArrayparamArray of scope ID containers with NLA-defined network IDs
ScopeBcDomainsparamArrayparamArray of scope ID containers with broadcast domain IDs. Currently, it's not allowed to assign distribution points to broadcast domains manually, so this scope is used only as output from the server and it is ignored when passed to the server.


Distribution point scope ID

Scope ID is a paramParams container with the following attributes:

ScopeIdparamLongScope ID. Type is paramLong, which is wide enough to contain the scope ID for all scope types.
ScopeNameparamStringHuman-readable scope ID (e.g. administration group name). Scope name is used for output only and is ignored when passed to Administration Server.


Examples


Scope that defines the administration group with ID 53. May be used as the UaScope attribute in Distribution point settings

        +---ScopeGroups (ARRAY_T)
            +---0 (PARAMS_T)
                +---ScopeId = (LONG_T)53


Scope as returned by UaControl.GetUpdateAgentInfo()

        +---ScopeBcDomains (ARRAY_T)
        +---ScopeGroups (ARRAY_T)
        |   +---0 (PARAMS_T)
        |       +---ScopeId = (LONG_T)55
        |       +---ScopeName = (STRING_T)"Test adm group 1"
        +---ScopeNlaNetworks (ARRAY_T)