Skip to content

Packages

ucmdb_rest.packages.Packages(server)

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

Source code in ucmdb_rest\packages.py 
20
21
22
23
24
def __init__(self, server):
    """
    Initialize the service with a reference to the main level UCMDB server
    """
    self.server = server

deletePackage(package)

Delete a package from the UCMDB server.

This function makes a DELETE request to the UCMDB server to undeploy a specified package.

Parameters:

Name Type Description Default
package str

Package to undeploy.

 required

Returns:

Type Description
Response

A dictionary of the result of the deletePackage call: { "failedResources": [], "successResources": [ { "errorCode": { "description": "", "code": 0, "errorParametersValues": null, "parametrizedError": false }, "resourceInfo": { "subSystem": "discoveryPatterns", "subSystemDisplayName": "", "name": "KWPDisk", "extension": "xml", "path": "", "packageName": "", "packageDisplayName": "KWP", "cmdbVersion": "", "updateTime": 0, "isFactory": false, "data": null, "recalculateName": true, "absoluteName": "discoveryPatterns/KWPDisk.xml", "qualifiedName": "", "currentVersion": false, "subSystemName": "discoveryPatterns", "noVersionSet": true }, "deploySuccessful": true } ] }
Source code in ucmdb_rest\packages.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
76
77
78
def deletePackage(self, package):
    """
    Delete a package from the UCMDB server.

    This function makes a DELETE request to the UCMDB server to undeploy
    a specified package.

    Parameters
    ----------
    package : str
        Package to undeploy.

    Returns
    -------
    requests.Response
        A dictionary of the result of the deletePackage call:
        {
        "failedResources": [],
        "successResources": [
            {
            "errorCode": {
                "description": "",
                "code": 0,
                "errorParametersValues": null,
                "parametrizedError": false
            },
            "resourceInfo": {
                "subSystem": "discoveryPatterns",
                "subSystemDisplayName": "",
                "name": "KWPDisk",
                "extension": "xml",
                "path": "",
                "packageName": "",
                "packageDisplayName": "KWP",
                "cmdbVersion": "",
                "updateTime": 0,
                "isFactory": false,
                "data": null,
                "recalculateName": true,
                "absoluteName": "discoveryPatterns/KWPDisk.xml",
                "qualifiedName": "",
                "currentVersion": false,
                "subSystemName": "discoveryPatterns",
                "noVersionSet": true
            },
            "deploySuccessful": true
            }
        ]
        }
    """
    safe_package = quote(package)
    url = f'/packagemanager/packages/{safe_package}'
    return self.server._request("DELETE",url)

deployPackage(filestoupload, package_name)

Deploy a package to the UCMDB server.

This function makes a POST request to the UCMDB server to upload and deploy a specified package.

Parameters:

Name Type Description Default
filestoupload bytes

Binary read of the file to upload.

 required
package_name str

Name of the package to associate with these files.

 required

Returns:

Type Description
Response

A dictionary of the result of the deployPackage call: { "failedResources": [], "successResources": [ { "errorCode": { "description": "", "code": 0, "errorParametersValues": null, "parametrizedError": false }, "resourceInfo": { "subSystem": "discoveryPatterns", "subSystemDisplayName": "", "name": "KWPDisk", "extension": "xml", "path": "", "packageName": "", "packageDisplayName": "KWP", "cmdbVersion": "", "updateTime": 0, "isFactory": false, "data": null, "recalculateName": true, "absoluteName": "discoveryPatterns/KWPDisk.xml", "qualifiedName": "", "currentVersion": false, "subSystemName": "discoveryPatterns", "noVersionSet": true }, "deploySuccessful": true }, ... ] }
Source code in ucmdb_rest\packages.py 
 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
def deployPackage(self, filestoupload, package_name):
    """
    Deploy a package to the UCMDB server.

    This function makes a POST request to the UCMDB server to upload and
    deploy a specified package.

    Parameters
    ----------
    filestoupload : bytes
        Binary read of the file to upload.
    package_name : str
        Name of the package to associate with these files.

    Returns
    -------
    requests.Response
        A dictionary of the result of the deployPackage call:
        {
        "failedResources": [],
        "successResources": [
            {
            "errorCode": {
                "description": "",
                "code": 0,
                "errorParametersValues": null,
                "parametrizedError": false
            },
            "resourceInfo": {
                "subSystem": "discoveryPatterns",
                "subSystemDisplayName": "",
                "name": "KWPDisk",
                "extension": "xml",
                "path": "",
                "packageName": "",
                "packageDisplayName": "KWP",
                "cmdbVersion": "",
                "updateTime": 0,
                "isFactory": false,
                "data": null,
                "recalculateName": true,
                "absoluteName": "discoveryPatterns/KWPDisk.xml",
                "qualifiedName": "",
                "currentVersion": false,
                "subSystemName": "discoveryPatterns",
                "noVersionSet": true
            },
            "deploySuccessful": true
            },
            ...
        ]
        }
    """
    files_uploaded = {
        'file': (package_name, filestoupload),
        'type': 'application/x-zip-compressed'
    }
    url = '/packagemanager/packages'
    return self.server._request("POST",url,files=files_uploaded)

exportPackage(package_name)

Export a package from the UCMDB server.

This function makes a GET request to the UCMDB server to export a specified package.

Parameters:

Name Type Description Default
package_name str

Package name to sync (zip file name).

 required

Returns:

Type Description
bytes

Binary file to be written.
Source code in ucmdb_rest\packages.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def exportPackage(self, package_name):
    """
    Export a package from the UCMDB server.

    This function makes a GET request to the UCMDB server to export a
    specified package.

    Parameters
    ----------
    package_name : str
        Package name to sync (zip file name).

    Returns
    -------
    bytes
        Binary file to be written.
    """
    safe_package = quote(package_name)
    url = f'/uiserver/packagemanager/resources/export?packageName={safe_package}'
    return self.server._request("GET",url)

filterPackage(package)

Filter a package from the UCMDB server.

This function makes a GET request to the UCMDB server to list the specified package.

Parameters:

Name Type Description Default
package str

Package name to list (should be the displayName of the package).

 required

Returns:

Type Description
Response

A dictionary containing all information about the package name: { "collection": [ { "name": "KWP.zip", "displayName": "KWP", "lastModifiedTime": 1718134976552, "dependencies": [], "version": "2019.05", "category": "UCMDB", "description": "This package contains the information needed to discover disks and their size.", "updatedBy": "admin", "updatedVersion": 3, "buildNumber": "", "minVersion": "", "maxVersion": "", "operationErrorCode": 0, "readme": "", "undeployResources": null, "subSystems": [ "discoveryJobs", "discoveryScripts", "discoveryPatterns" ], "errorCode": 0, "hidden": false, "allResources": [ { "subSystem":"discoveryJobs", ... } ] } ] }
Source code in ucmdb_rest\packages.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
def filterPackage(self, package):
    """
    Filter a package from the UCMDB server.

    This function makes a GET request to the UCMDB server to list the
    specified package.

    Parameters
    ----------
    package : str
        Package name to list (should be the displayName of the package).

    Returns
    -------
    requests.Response
        A dictionary containing all information about the package name:
        {
            "collection": [
                {
                    "name": "KWP.zip",
                    "displayName": "KWP",
                    "lastModifiedTime": 1718134976552,
                    "dependencies": [],
                    "version": "2019.05",
                    "category": "UCMDB",
                    "description": "This package contains the information
                                    needed to discover disks and their size.",
                    "updatedBy": "admin",
                    "updatedVersion": 3,
                    "buildNumber": "",
                    "minVersion": "",
                    "maxVersion": "",
                    "operationErrorCode": 0,
                    "readme": "",
                    "undeployResources": null,
                    "subSystems": [
                        "discoveryJobs",
                        "discoveryScripts",
                        "discoveryPatterns"
                    ],
                    "errorCode": 0,
                    "hidden": false,
                    "allResources": [
                        {
                            "subSystem":"discoveryJobs",
                            ...
                        }
                    ]
                }
            ]
        }
    """
    safe_package = quote(package)
    url = f'/uiserver/packagemanager/packages?isPaginationEnabled=true&start=0&limit=20&sortDir=ASC&sortField=name&search={safe_package}'  # noqa: E501
    return self.server._request("GET",url)

getContentPacks()

Get the content packs from the UCMDB server.

This function makes a GET request to the UCMDB server to retrieve information about the deployed content packs.

Returns:

Type Description
Response

List of content pack information: [ { "version": "23.4.198", "cpStatus": "DEPLOYED", "incompliantClasses": null, "cpDeploymentProgress": "", "cpDeploymentPercentage": "" }, { "version": "24.1.109", "cpStatus": "UPLOADED", "incompliantClasses": null, "cpDeploymentProgress": "", "cpDeploymentPercentage": "" }, { "version": "24.2.67", "cpStatus": "UPLOADED", "incompliantClasses": null, "cpDeploymentProgress": "", "cpDeploymentPercentage": "" } ]
Source code in ucmdb_rest\packages.py 
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def getContentPacks(self):
    """
    Get the content packs from the UCMDB server.

    This function makes a GET request to the UCMDB server to retrieve
    information about the deployed content packs.

    Returns
    -------
    requests.Response
        List of content pack information:
        [
            {
                "version": "23.4.198",
                "cpStatus": "DEPLOYED",
                "incompliantClasses": null,
                "cpDeploymentProgress": "",
                "cpDeploymentPercentage": ""
            },
            {
                "version": "24.1.109",
                "cpStatus": "UPLOADED",
                "incompliantClasses": null,
                "cpDeploymentProgress": "",
                "cpDeploymentPercentage": ""
            },
            {
                "version": "24.2.67",
                "cpStatus": "UPLOADED",
                "incompliantClasses": null,
                "cpDeploymentProgress": "",
                "cpDeploymentPercentage": ""
            }
        ]
    """
    url = '/packagemanager/contentpacks'
    return self.server._request("GET",url)

getDiffReport(cpversion)

Retrieve the difference report for a content pack version.

This function makes a GET request to the UCMDB server to retrieve the difference report for a specified content pack version.

Parameters:

Name Type Description Default
cpversion str

Content Pack Version.

 required

Returns:

Type Description
Response

JSON output with Difference Report if error, otherwise binary file with report.
Source code in ucmdb_rest\packages.py 
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def getDiffReport(self, cpversion):
    """
    Retrieve the difference report for a content pack version.

    This function makes a GET request to the UCMDB server to 
    retrieve the difference report for a specified content pack 
    version.

    Parameters
    ----------
    cpversion : str
        Content Pack Version.

    Returns
    -------
    requests.Response
        JSON output with Difference Report if error, otherwise 
        binary file with report.
    """
    url = f'/packagemanager/contentpacks/{cpversion}/diffreport'
    return self.server._request("GET",url)

getPackage(pkg_name='A10_vthunder.zip')

Retrieves details of a specific package from the UCMDB server.

This method makes a GET request to the UCMDB server to retrieve details of the specified package.

Parameters:

Name Type Description Default
pkg_name str

Name of the package to retrieve. Defaults to 'A10_vthunder.zip'.

 'A10_vthunder.zip'

Returns:

Type Description
Response

Response object containing a JSON listing of the package details, including name, display name, version, and a list of resources it contains.
Source code in ucmdb_rest\packages.py 
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
def getPackage(self, pkg_name='A10_vthunder.zip'):
    """
    Retrieves details of a specific package from the UCMDB server.

    This method makes a GET request to the UCMDB server to retrieve details of
    the specified package.

    Parameters
    ----------
    pkg_name : str, optional
        Name of the package to retrieve. Defaults to 'A10_vthunder.zip'.

    Returns
    -------
    requests.Response
        Response object containing a JSON listing of the package details,
        including name, display name, version, and a list of resources it
        contains.

    """
    safe_package = quote(pkg_name)
    url = f'/packagemanager/packages/{safe_package}'
    return self.server._request("GET",url)

getPackages()

Retrieves a list of packages from the UCMDB server.

This method makes a GET request to the UCMDB server to retrieve a list of packages.

Returns:

Type Description
Response

A list containing dictionaries with details of each package: - name: str - displayName: str - lastModifiedTime: int - dependencies: list of str - version: str - category: str - description: str - updatedBy: str - updatedVersion: int - buildNumber: str - minVersion: str - maxVersion: str - operationErrorCode: int - readme: str - undeployResources: None - factory: bool - hidden: bool - errorCode: int - allResources: list of dict, each containing details of a resource: - subSystem: str - subSystemDisplayName: str - name: str - extension: str - path: str - packageName: str - packageDisplayName: str - cmdbVersion: str - updateTime: int - isFactory: bool - data: str - recalculateName: bool - absoluteName: str - qualifiedName: str - currentVersion: bool - noVersionSet: bool - subSystemName: str
Source code in ucmdb_rest\packages.py 
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
def getPackages(self):
    """
    Retrieves a list of packages from the UCMDB server.

    This method makes a GET request to the UCMDB server to retrieve a list
    of packages.

    Returns
    -------
    requests.Response
        A list containing dictionaries with details of each package:
        - name: str
        - displayName: str
        - lastModifiedTime: int
        - dependencies: list of str
        - version: str
        - category: str
        - description: str
        - updatedBy: str
        - updatedVersion: int
        - buildNumber: str
        - minVersion: str
        - maxVersion: str
        - operationErrorCode: int
        - readme: str
        - undeployResources: None
        - factory: bool
        - hidden: bool
        - errorCode: int
        - allResources: list of dict, each containing details of a resource:
            - subSystem: str
            - subSystemDisplayName: str
            - name: str
            - extension: str
            - path: str
            - packageName: str
            - packageDisplayName: str
            - cmdbVersion: str
            - updateTime: int
            - isFactory: bool
            - data: str
            - recalculateName: bool
            - absoluteName: str
            - qualifiedName: str
            - currentVersion: bool
            - noVersionSet: bool
            - subSystemName: str

    """
    url = '/packagemanager/packages'
    return self.server._request("GET",url)

getProgress(package)

Retrieves the deployment or undeployment progress for a specific package.

Parameters:

Name Type Description Default
package str

Name of the package to check.

 required

Returns:

Type Description
Response

A JSON response indicating status (e.g., 'FINISHED', 'IN_PROGRESS') and any failed resource names.
Source code in ucmdb_rest\packages.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
def getProgress(self, package):
    """
    Retrieves the deployment or undeployment progress for a specific package.

    Parameters
    ----------
    package : str
        Name of the package to check.

    Returns
    -------
    requests.Response
        A JSON response indicating status (e.g., 'FINISHED', 'IN_PROGRESS') 
        and any failed resource names.
    """
    safe_package = quote(package)
    url = f'/packagemanager/packages/{safe_package}/progress'
    return self.server._request("GET",url)

getSpecificContentPack(cpversion)

Retrieves the status and deployment percentage of a specific Content Pack.

Parameters:

Name Type Description Default
cpversion str

The version string of the Content Pack (e.g., '24.1.109').

 required

Returns:

Type Description
Response

JSON containing deployment status and completion percentage.

{ "version": "24.1.109", "cpStatus": "SIMULATED_INSTALLATION_FINISHED", "incompliantClasses": null, "cpDeploymentProgress": "FINISHED", "cpDeploymentPercentage": "100%" }
Source code in ucmdb_rest\packages.py 
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
def getSpecificContentPack(self, cpversion):
    """
    Retrieves the status and deployment percentage of a specific Content Pack.

    Parameters
    ----------
    cpversion : str
        The version string of the Content Pack (e.g., '24.1.109').

    Returns
    -------
    requests.Response
        JSON containing deployment status and completion percentage.

        {
        "version": "24.1.109",
        "cpStatus": "SIMULATED_INSTALLATION_FINISHED",
        "incompliantClasses": null,
        "cpDeploymentProgress": "FINISHED",
        "cpDeploymentPercentage": "100%"
        }
    """
    url = f'/packagemanager/contentpacks/{cpversion}'
    return self.server._request("GET",url)

uploadContentPack(filestoupload, cp_name)

Uploads a new Content Pack version to the UCMDB server.

Parameters:

Name Type Description Default
filestoupload bytes

Binary content of the Content Pack file.

 required
cp_name str

The name/version to associate with the upload.

 required

Returns:

Type Description
Response

Status of the upload process. { "name" : null, "errorCode" : { "description" : "CP was uploaded successfully", "code" : 0, "parametrizedError" : false, "errorParametersValues" : null }, "successResources" : [ ], "failedResources" : [ ], "deploySuccessful" : true, "resourcesStatus" : [ ] }
Source code in ucmdb_rest\packages.py 
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
def uploadContentPack(self, filestoupload, cp_name):
    """
    Uploads a new Content Pack version to the UCMDB server.

    Parameters
    ----------
    filestoupload : bytes
        Binary content of the Content Pack file.
    cp_name : str
        The name/version to associate with the upload.

    Returns
    -------
    requests.Response
        Status of the upload process.
            {
            "name" : null,
            "errorCode" : {
                "description" : "CP was uploaded successfully",
                "code" : 0,
                "parametrizedError" : false,
                "errorParametersValues" : null
            },
            "successResources" : [ ],
            "failedResources" : [ ],
            "deploySuccessful" : true,
            "resourcesStatus" : [ ]
            }
    """
    files_uploaded = {'file': (cp_name, filestoupload)}
    url = '/packagemanager/contentpacks'
    return self.server._request("POST",url, files=files_uploaded)