proxy

Available methods

Description

Provides methods to activate/deactivate a proxy server.

Namespace:

proxy

Method: activateProxy

HTTP POST

Description:

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

Parameters:

  • string clientcert - client certificate file

  • string version - Version of proxy to be registered.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrapProxy

HTTP POST

Description:

Deploy a proxy container on given salt minion. It expects that the images are installed as RPMs.

Parameters:

  • string sessionKey

  • int hostId - The ID of the target minion

  • string parentFqdn - The FQDN of the server the proxy uses

  • int proxyPort - The SSH port the proxy listens on

  • int maxCache - The maximum memory cache size

  • string email - The email of proxy admin

  • string rootCA - CA certificate in PEM format

  • string array intermediateCAs - A list of intermediate CAs in PEM format

  • string proxyCert - Proxy certificate in PEM format

  • string proxyKey - Proxy private key in PEM format

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrapProxy

HTTP POST

Description:

Deploy a proxy container on given salt minion. Use the given registry for the images.

Parameters:

  • string sessionKey

  • int hostId - The ID of the target minion

  • string parentFqdn - The FQDN of the server the proxy uses

  • int proxyPort - The SSH port the proxy listens on

  • int maxCache - The maximum memory cache size

  • string email - The email of proxy admin

  • string rootCA - CA certificate in PEM format

  • string array intermediateCAs - A list of intermediate CAs in PEM format

  • string proxyCert - Proxy certificate in PEM format

  • string proxyKey - Proxy private key in PEM format

  • string registryBaseURL - Image registry (e.g. https://registry.opensuse.org/uyuni/)

  • string registryBaseTag - Image tag (e.g. latest)

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: bootstrapProxy

HTTP POST

Description:

Deploy a proxy container on given salt minion. Allows individual registry for each image.

Parameters:

  • string sessionKey

  • int hostId - The ID of the target minion

  • string parentFqdn - The FQDN of the server the proxy uses

  • int proxyPort - The SSH port the proxy listens on

  • int maxCache - The maximum memory cache size

  • string email - The email of proxy admin

  • string rootCA - CA certificate in PEM format

  • string array intermediateCAs - A list of intermediate CAs in PEM format

  • string proxyCert - Proxy certificate in PEM format

  • string proxyKey - Proxy private key in PEM format

  • string registryHttpdURL - Httpd image registry

  • string registryHttpdTag - Httpd image tag

  • string registrySaltbrokerURL - Salt broker image registry

  • string registrySaltbrokerTag - Salt broker image tag

  • string registrySquidURL - Squid image registry

  • string registrySquidTag - Squid image tag

  • string registrySshURL - Ssh image registry

  • string registrySshTag - Ssh image tag

  • string registryTftpdURL - Tftpd image registry

  • string registryTftpdTag - Tftpd image tag

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: containerConfig

HTTP POST

Description:

Compute and download the configuration for proxy containers

Parameters:

  • string sessionKey

  • string proxyName - The FQDN of the proxy

  • int proxyPort - The SSH port the proxy listens on

  • string server - The server FQDN the proxy will connect to

  • int maxCache - Max cache size in MB

  • string email - The proxy admin email

  • string rootCA - The root CA used to sign the SSL certificate in PEM format

  • string array intermediateCAs - intermediate CAs used to sign the SSL certificate in PEM format

  • string proxyCrt - proxy CRT content in PEM format

  • string proxyKey - proxy SSL private key in PEM format

Returns:

  • byte array binary object - package file

Method: containerConfig

HTTP POST

Description:

Compute and download the configuration for proxy containers

Parameters:

  • string sessionKey

  • string proxyName - The FQDN of the proxy

  • int proxyPort - The SSH port the proxy listens on

  • string server - The server FQDN the proxy will connect to

  • int maxCache - Max cache size in MB

  • string email - The proxy admin email

  • string caCrt - CA certificate to use to sign the SSL certificate in PEM format

  • string caKey - CA private key to use to sign the SSL certificate in PEM format

  • string caPassword - The CA private key password

  • string array cnames - Proxy alternate cnames to set in the SSL certificate

  • string country - The 2-letter country code to set in the SSL certificate

  • string state - The state to set in the SSL certificate

  • string city - The city to set in the SSL certificate

  • string org - The organization to set in the SSL certificate

  • string orgUnit - The organization unit to set in the SSL certificate

  • string sslEmail - The email to set in the SSL certificate

Returns:

  • byte array binary object - package file

Method: createMonitoringScout

HTTP POST

Description:

Create Monitoring Scout for proxy.

Parameters:

  • string clientcert - client certificate file

Returns:

  • string

Available since API version: 10.7

Method: deactivateProxy

HTTP POST

Description:

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

Parameters:

  • string clientcert - client certificate file

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: isProxy

HTTP GET

Description:

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

Parameters:

  • string clientcert - client certificate file

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listAvailableProxyChannels

HTTP GET

Description:

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

Parameters:

  • string clientcert - client certificate file

Returns:

  • string array version

Available since API version: 10.5

Method: listProxies

HTTP GET

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

Method: listProxyClients

HTTP GET

Description:

List the clients directly connected to a given Proxy.

Parameters:

  • string sessionKey

  • int proxyId - the Proxy ID

Returns:

  • int array clientId