proxy

Description

Provides methods to activate/deactivate a proxy server.

Namespace:

proxy

Method: activateProxy

Description:

Activates the proxy identified by the given client certificate i.e. systemid file.

Parameters:

  • string systemid - systemid file

  • string version - Version of proxy to be registered.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: createMonitoringScout

Description:

Create Monitoring Scout for proxy.

Parameters:

  • string systemid - systemid file

Returns:

  • string

Available since API version: 10.7

Method: deactivateProxy

Description:

Deactivates the proxy identified by the given client certificate i.e. systemid file.

Parameters:

  • string systemid - systemid file

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: isProxy

Description:

Test, if the system identified by the given client certificate i.e. systemid file, is proxy.

Parameters:

  • string systemid - systemid file

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listAvailableProxyChannels

Description:

List available version of proxy channel for system identified by the given client certificate i.e. systemid file.

Parameters:

  • string systemid - systemid file

Returns:

  • array :

    • string - version

Available since API version: 10.5

Method: listProxies

Description:

List the proxies within the user’s organization.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct - system

    • int "id"

    • string "name"

    • dateTime.iso8601 "last_checkin" - Last time server successfully checked in

    • dateTime.iso8601 "created" - Server registration time

    • dateTime.iso8601 "last_boot" - Last server boot time

    • int "extra_pkg_count" - Number of packages not belonging to any assigned channel

    • int "outdated_pkg_count" - Number of out-of-date packages

Method: listProxyClients

Description:

List the clients directly connected to a given Proxy.

Parameters:

  • string sessionKey

  • int proxyId

Returns:

  • array :

    • int - clientId