Distribution Servers and IP Ranges

Distribution servers are typically used organizations that have many different locations across the country or across the world. They are located at each remote site and can be used to store a number of items, including:

Patches that you wish to deploy
Engines and XML files
Custom patches

Distribution servers provide each of your remote sites a local repository for the files used during the patch management processes. By providing local copies of these files, you greatly reduce your network traffic as well as the time it takes to access the files.

You define which target machines will use a particular distribution server by assigning one or more IP ranges to the distribution server.

Base URLs

        https://<consoleFQDN:port>/st/console/api/v1.0/distributionservers
        https://<consoleFQDN:port>/st/console/api/v1.0/ipranges

Supported Requests

Method	URL	Return
GET	https://<consoleFQDN:port>/st/console/api/v1.0/distributionservers	DistributionServers[]
	https://<consoleFQDN:port>/st/console/api/v1.0/distributionservers/{id}	Configuration information for the specified distribution server.
	https://<consoleFQDN:port>/st/console/api/v1.0/ipranges	IP ranges[]
	https://<consoleFQDN:port>/st/console/api/v1.0/ipranges/{id of IP range}	Configuration information for the specified IP range.

Input Model

None

Examples with Sample Responses

Find all distribution servers

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/distributionservers

Sample Response

Copy

{
    "count": 1,
    "value": [
        {
            "autoSync": false,
            "clientHttpPort": 80,
            "clientPath": "file://device-name/C$/DS1",
            "clientSsl": false,
            "clientType": "FileShare",
            "id": 1,
            "links": {
                "self": {
                    "href": "https://device-name.example.com:3121/st/console/api/v1.0/distributionservers/1"
                }
            },
            "name": "Sample Distribution Server",
            "synchronizePath": "file://device-name/C$/DS1"
        }
    ]
}

Find all IP ranges

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/ipranges

Sample Response

Copy

[
    {
        "id": 1,
        "links": {
            "self": {
                "href": "https://device-name.example.com:3121/st/console/api/v1.0/ipranges/1"
            },
            "primarydistributionserver": {
                "href": "https://device-name.example.com:3121/st/console/api/v1.0/distributionservers/1"
            }
        },
        "lowerBound": "192.168.1.1",
        "primaryServerId": 1,
        "upperBound": "192.168.1.40"
    }
]

Other Request Examples

Output Models

DistributionServer

Name	Type	Description
autoSync	Boolean	Specifies whether the distribution server will automatically synchronize the console and the client paths.
clientHttpPort	Integer	The HTTP port used on the client side.
clientPath	Uri	The URI to the distribution server that is visible from the client.
clientSsl	Boolean	Specifies whether the client connection is secured using SSL.
clientType		Specifies how the target machines will access the file repository on the distribution server. Options include FileShare, AnonymousHttp and AuthenticatedHttp.
id	Integer	The ID of the distribution server.
links	Links	Shows the related URLs for each distribution server.
name	String	The user-provided name of the distribution server.
synchronizePath	Uri	The file path that the console uses to synchronize/write files to the distribution server.

IPRange

Name	Type	Description
id	Integer	The ID.
links	Links	Shows the related URLs for each IP range, the primary distribution server and the secondary distribution server.
lowerBound	IPAddress	The lower bound (inclusive) of the IP address range.
primaryServerId	Integer	The primary distribution server ID.
secondaryServerId	Integer	The secondary distribution server ID.
upperBound	IPAddress	The upper bound (inclusive) of the IP address range.