Skip to content

System

ucmdb_rest.system.System(server)

Initialize the service with a reference to the main level UCMDB server

Source code in ucmdb_rest\system.py 
14
15
16
17
18
def __init__(self, server):
    """
    Initialize the service with a reference to the main level UCMDB server
    """
    self.server = server

getLicenseReport()

Retrieves detailed licensing and capacity information.

This report includes license types (TERM/PERPETUAL), capacity limits, remaining days until expiration, and active features for both UCMDB and Universal Discovery.

Returns:

Type Description
Response

Can be converted to a dictionary with license information. For example: { "fullServerCount": 693, "fullWorkstationCount": 3, "fullNetworkCount": 0, "fullStorageCount": 0, "fullDockerCount": 0, "basicServerCount": 12, "basicWorkstationCount": 1, "basicNetworkCount": 0, "basicStorageCount": 0, "basicDockerCount": 0, "operationalServerCount": 0, "operationalWorkstationCount": 0, "operationalNetworkCount": 0, "operationalStorageCount": 0, "operationalDockerCount": 0, "usedUnit": "694.6", "totalLicenseUnit": 1000, "totalMDR": 20, "usedMDR": 0, "totalCM": 0, "usedCM": 0, "totalPremium": 0, "totalAsset": 0, "consumedAsset": 0, "consumedPremium": 0, "usedManagement": 0, "usedPremium": 0, "usedAsset": 0, "customerID": 0, "consumedCIs": 0, "maxCIs": 0, "usedProbes": 0, "maxProbes": 0, "allowBuffer": 0.0, "remainingDays": 394, "licenseDetailsCollection": [ { "description": "UCMDB Third Party Integration per MDR", "licenseType": "TERM", "expirationDate": 1752191999000, "startDate": 1712665737000, "capacity": 20, "remainingDaysUntilExpireTime": "394", "customerLicenseFeatures": { "10398": 20 }, "active": true, "formatExpirationDate": "7/10/25 4:59 PM", "formatStartDate": "4/9/24 5:28 AM" }, { "description": "Universal Discovery per Unit V2", "licenseType": "TERM", "expirationDate": 1752191999000, "startDate": 1712665693000, "capacity": 1000, "remainingDaysUntilExpireTime": "394", "customerLicenseFeatures": { "100787": 1000, "10831": 1 }, "active": true, "formatExpirationDate": "7/10/25 4:59 PM", "formatStartDate": "4/9/24 5:28 AM" } ], "operational": false, "saminventory": false, "ucmdbfoundation": true, "rationOfManagementToAsset": 20 }
Source code in ucmdb_rest\system.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def getLicenseReport(self):
    """
    Retrieves detailed licensing and capacity information.

    This report includes license types (TERM/PERPETUAL), capacity limits, 
    remaining days until expiration, and active features for both 
    UCMDB and Universal Discovery.

    Returns
    -------
    requests.Response
        Can be converted to a dictionary with license information. For example:
        {
            "fullServerCount": 693,
            "fullWorkstationCount": 3,
            "fullNetworkCount": 0,
            "fullStorageCount": 0,
            "fullDockerCount": 0,
            "basicServerCount": 12,
            "basicWorkstationCount": 1,
            "basicNetworkCount": 0,
            "basicStorageCount": 0,
            "basicDockerCount": 0,
            "operationalServerCount": 0,
            "operationalWorkstationCount": 0,
            "operationalNetworkCount": 0,
            "operationalStorageCount": 0,
            "operationalDockerCount": 0,
            "usedUnit": "694.6",
            "totalLicenseUnit": 1000,
            "totalMDR": 20,
            "usedMDR": 0,
            "totalCM": 0,
            "usedCM": 0,
            "totalPremium": 0,
            "totalAsset": 0,
            "consumedAsset": 0,
            "consumedPremium": 0,
            "usedManagement": 0,
            "usedPremium": 0,
            "usedAsset": 0,
            "customerID": 0,
            "consumedCIs": 0,
            "maxCIs": 0,
            "usedProbes": 0,
            "maxProbes": 0,
            "allowBuffer": 0.0,
            "remainingDays": 394,
            "licenseDetailsCollection": [
                {
                    "description": "UCMDB Third Party Integration per MDR",
                    "licenseType": "TERM",
                    "expirationDate": 1752191999000,
                    "startDate": 1712665737000,
                    "capacity": 20,
                    "remainingDaysUntilExpireTime": "394",
                    "customerLicenseFeatures": {
                        "10398": 20
                    },
                    "active": true,
                    "formatExpirationDate": "7/10/25 4:59 PM",
                    "formatStartDate": "4/9/24 5:28 AM"
                },
                {
                    "description": "Universal Discovery per Unit V2",
                    "licenseType": "TERM",
                    "expirationDate": 1752191999000,
                    "startDate": 1712665693000,
                    "capacity": 1000,
                    "remainingDaysUntilExpireTime": "394",
                    "customerLicenseFeatures": {
                        "100787": 1000,
                        "10831": 1
                    },
                    "active": true,
                    "formatExpirationDate": "7/10/25 4:59 PM",
                    "formatStartDate": "4/9/24 5:28 AM"
                }
            ],
            "operational": false,
            "saminventory": false,
            "ucmdbfoundation": true,
            "rationOfManagementToAsset": 20
        }
    """
    url = '/uiserver/license/report'
    return self.server._request("GET",url)

getUCMDBVersion()

Retrieves the UCMDB version from the REST API endpoint for the UCMDB server dashboard.

This method makes a GET request to the UCMDB server to fetch version information.

This method is called automatically during UCMDBServer initialization to populate the 'self.version' attribute for API compatibility checks.

Returns:

Type Description
Response

Can be converted to a dictionary with version information. For example: { "productName": "Universal CMDB", "serverBuildNumber": "232", "contentPackBuildNumber": "67", "contentPackVersion": "24.2", "fullServerVersion": "11.8.0" }
Source code in ucmdb_rest\system.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def getUCMDBVersion(self):
    """
    Retrieves the UCMDB version from the REST API endpoint for the UCMDB
    server dashboard.

    This method makes a GET request to the UCMDB server to fetch version
    information.

    This method is called automatically during UCMDBServer initialization 
    to populate the 'self.version' attribute for API compatibility checks.

    Returns
    -------
    requests.Response
        Can be converted to a dictionary with version information. For example:
        {
            "productName": "Universal CMDB",
            "serverBuildNumber": "232",
            "contentPackBuildNumber": "67",
            "contentPackVersion": "24.2",
            "fullServerVersion": "11.8.0"
        }
    """
    url = '/v1/uiserver/dashboard/versions/getVersion'
    return self.server._request("GET",url)

ping(restrictToWriter=False, restrictToReader=False)

Tests connectivity to UCMDB.

This method makes a GET request to the UCMDB server to show connection information.

Parameters:

Name Type Description Default
restrictToWriter bool

If True, the ping only succeeds if the node is the primary 'Writer' node in a cluster. Default is False.

 False
restrictToReader bool

If True, the ping only succeeds if the node is a 'Reader' node. Default is False.

 False

Returns:

Type Description
Response

Can be converted to a dictionary with status information. For example: { "status": { "statusCode": 200, "reasonPhrase": "OK", "message": "FullyUp, is writer: true" } }
Source code in ucmdb_rest\system.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def ping(self, restrictToWriter=False, restrictToReader=False):
    """
    Tests connectivity to UCMDB.

    This method makes a GET request to the UCMDB server to show connection
    information.

    Parameters
    ----------
    restrictToWriter : bool, optional
        If True, the ping only succeeds if the node is the primary 
        'Writer' node in a cluster. Default is False.
    restrictToReader : bool, optional
        If True, the ping only succeeds if the node is a 'Reader' node. 
        Default is False.

    Returns
    -------
    requests.Response
        Can be converted to a dictionary with status information. For example:
        {
            "status": {
                "statusCode": 200,
                "reasonPhrase": "OK",
                "message": "FullyUp, is writer: true"
            }
        }
    """
    url = f'{self.server.root_url}/ping?restrictToWriter={restrictToWriter}&restrictToReader={restrictToReader}'  # noqa: E501
    return self.server._request("GET",url)