KSC Open API  13.0
Kaspersky Security Center API description
Section KLNAG_KLNLA_DATA attributes

ProductName: 1103
ProductVersion: 1.0.0.0
Section: KLNAG_KLNLA_DATA


Settings related to Network location awareness (NLA)

NameTypeDescriptionDefault value
KLNAG_NLA_ROAMING_IF_UNAVAILparamBoolSwitch Network Agent into roaming mode if ak server is unavailabletrue
KLNLA_LOCATIONSparamArray|paramParams

Locations array. Order of location in array is important. Network Agent is switched to the profile that corresponds to the first suitable location in the array. KLNLA_COP values : 0 - one of; 1 - none of; Network location description: Different attributes are connected with 'AND'. For example, location with following attributes

    c_szwDnsDomain = {KLNLA_COP : 0, KLNLA_value : ['mycompany1.com', 'mycompany2.com']};
    c_szwDhcpServer ={KLNLA_COP : 1, KLNLA_value : ['172.16.2.1', '172.16.2.2']};

means c_szwDnsDomain is ONE OF 'mycompany1.com', 'mycompany2.com', AND c_szwDhcpServer is NONE OF '172.16.2.1', '172.16.2.2'

Each array item contains following elements:

KLNLA_DHCP_SERVERparamParams

DHCP server

KLNLA_COPparamInt
KLNLA_valueparamArray|paramInt

KLNLA_DNSDOMAINparamParams

DNS domain

KLNLA_COPparamInt
KLNLA_valueparamArray|paramString

KLNLA_DEF_GATEWAYparamParams

Default gateway

KLNLA_COPparamInt
KLNLA_valueparamArray|paramInt

KLNLA_DNS_SERVERparamParams

Dns server

KLNLA_COPparamInt
KLNLA_valueparamArray|paramInt

KLNLA_WINS_SERVERparamParams

WINS Server

KLNLA_COPparamInt
KLNLA_valueparamArray|paramInt

KLNLA_IN_DOMAINparamParams

Logged in domain

KLNLA_COPparamInt
KLNLA_valueparamBool

KLNLA_DNS_RESOLVEparamParams

DNS address can be resolved; if KLNLA_COP = 0 then the condition is true if at least one of addresses can be resolved; if KLNLA_COP = 1 then the condition is true if none of addresses can be resolved

KLNLA_COPparamInt
KLNLA_valueparamArray|paramString

KLNLA_SSL_AVAILABLEparamParams

SSL location is available if KLNLA_COP = 0 then the condition is true if at least one of SSL locations specified is accessible if KLNLA_COP = 1 then the condition is true if none of addresses can be resolved

KLNLA_COPparamInt
KLNLA_valueparamArray|paramParams
KLNLA_SSL_LOCATIONparamStringSSL location: <address>:<port> Examples: 91.103.68.243:13000 intranet.kaspersky.com:443
KLNLA_SSL_CERTparamBinarySSL certificate, optional

KLNLA_SUBNETparamParams

Subnet

KLNLA_COPparamInt
KLNLA_valueparamArray|paramParams
KLNLA_SUBNET_ADDRESSparamIntSubnet address in network format
KLNLA_SUBNET_MASKparamIntSubnet mask in network format

KLNLA_LOCATION_ENABLEDparamBoolLocation is enabled
KLNLA_LOCATION_IDparamStringNetwork location ID - location's unique ID
KLNLA_LOCATION_NAMEparamStringNetwork location name - string of any unicode printable symbols, length up to 255, cannot start with dot
KLNLA_PROFILE_TO_USEparamStringName of profile to switch to. May be ".KLNLA_INACTIVE_PROFILE". Location is ignored if specified profile does not exists.

KLNLA_PROFILESparamArray|paramParamsLocations array. Order of location in array is important.
GatewayAddressparamStringGateway address""
ServerAddressparamStringServer addresslocalhost
ServerSslPortsparamArray|paramIntServer SSL ports{13000}
ServerportsparamArray|paramIntServer ports{14000}
UseProfileGatewayparamIntdeprecated, do not use0
UseSslparamBoolUse Ssltrue
KLNLA_ADDRESS_FOR_UPDATES_ONLYparamBoolUse profile only for downloading updates. This variable set true in profile means that administration server address specified in will be used for downloading updates only.
KLNLA_GUEST_MODEparamBoolNetwork Agent must switch into the 'guest mode' Typically when Network Agent is switched to a profile, and KLNLA_ADDRESS_FOR_UPDATES_ONLY is false the Network Agent connects to the Administration Server in a 'guest mode'. When in guest mode Network Agent ignores any changes of NLA settings until it returns to the home server (until all locations become inactive). If 'KLNLA_ADDRESS_FOR_UPDATES_ONLY' is true then KLNLA_GUEST_MODE attribute is not used.true
KLNLA_PROFILE_DISPLAY_NAMEparamStringstring of any unicode printable symbols, length up to 255
KLNLA_PROFILE_IDparamStringUnique string of symbols with codes 32-127, length up to 255, cannot start with dot
KLNLA_ROAMING_MODEparamBoolif Network Agent must be switched into roaming mode while using the profile