Skip to content

Policies

ucmdb_rest.policies.Policies(server)

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

Source code in ucmdb_rest\policies.py 
24
25
26
27
28
def __init__(self, server):
    """
    Initialize the service with a reference to the main level UCMDB server
    """
    self.server = server

calculateComplianceView(myDict)

Calculates compliance based on provided data.

This method makes a POST request to the UCMDB server to calculate compliance based on the provided data.

Parameters:

Name Type Description Default
myDict dict

Data to be used for compliance calculation.

 required

Returns:

Type Description
Response

Response object from the UCMDB server.
Example

my_dict = {'data': 'example_data'} response = calculateComplianceView(my_dict) print(response.status_code) 200

Source code in ucmdb_rest\policies.py 
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
def calculateComplianceView(self, myDict):
    """
    Calculates compliance based on provided data.

    This method makes a POST request to the UCMDB server to calculate
    compliance based on the provided data.

    Parameters
    ----------
    myDict : dict
        Data to be used for compliance calculation.

    Returns
    -------
    requests.Response
        Response object from the UCMDB server.

    Example
    -------
    >>> my_dict = {'data': 'example_data'}
    >>> response = calculateComplianceView(my_dict)
    >>> print(response.status_code)
    200
    """
    url = '/policy/calculate?chunkSize=300'
    return self.server._request("POST",url,json=myDict)

calculateView(view)

Calculates a compliance view based on policies that exist in a UCMDB system.

This method makes a POST request to the UCMDB server to calculate a compliance view. The results are a list of dictionaries containing the COMPLIANT, NON-COMPLIANT, and NON-APPLICABLE values. The view must be from the list created by getComplainceViews.

Parameters:

Name Type Description Default
view str

The name of the view to request. The view name will be URL-encoded, so it can contain spaces or special characters.

 required

Returns:

Type Description
Response

A JSON object containing a list of dictionaries with the compliance status and their counts: - ciType: str ("COMPLIANT", "NON-COMPLIANT", "NON-APPLICABLE") - count: int
Example

view = 'Node Compliance View' compliance_results = calculateView(view) for result in compliance_results: print(result['ciType'], result['count'])

COMPLIANT 484 NON-COMPLIANT 310

Source code in ucmdb_rest\policies.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def calculateView(self, view):
    """
    Calculates a compliance view based on policies that exist in a
    UCMDB system.

    This method makes a POST request to the UCMDB server to calculate a
    compliance view. The results are a list of dictionaries containing
    the COMPLIANT, NON-COMPLIANT, and NON-APPLICABLE values. The view
    must be from the list created by getComplainceViews.

    Parameters
    ----------
    view : str
        The name of the view to request. The view name will be 
        URL-encoded, so it can contain spaces or special characters.

    Returns
    -------
    requests.Response
        A JSON object containing a list of dictionaries with the
        compliance status and their counts:
        - ciType: str ("COMPLIANT", "NON-COMPLIANT", "NON-APPLICABLE")
        - count: int

    Example
    -------
    >>> view = 'Node Compliance View'
    >>> compliance_results = calculateView(view)
    >>> for result in compliance_results:
    >>>     print(result['ciType'], result['count'])
    >>>
    >>> COMPLIANT 484
    >>> NON-COMPLIANT 310
    """
    encoded_view = quote(view)
    url = f'/uiserver/modeling/views/{encoded_view}'
    return self.server._request("POST",url)

getAllResultsForPath(execution_id, status_type=ComplianceStatus.NON_COMPLIANT)

Automatically iterates through all chunks for a specific status and returns one flat list of results.

This method handles the pagination logic of the UCMDB server by first determining the number of chunks and then sequentially retrieving and aggregating them into a single list.

Parameters:

Name Type Description Default
execution_id str

The ID of the view execution (viewResultId).

 required
status_type ComplianceStatus or str

The compliance status to retrieve ("COMPLIANT", "NON-COMPLIANT", "NON-APPLICABLE"). Default is ComplianceStatus.NON_COMPLIANT.

 NON_COMPLIANT

Returns:

Type Description
list

A flat list of dictionaries representing the compliance results, aggregated from all available chunks.
Example

from ucmdb_rest.policies import ComplianceStatus exec_id = 'eyJ0eXAiOiJKV1...' results = getAllResultsForPath(exec_id, ComplianceStatus.NON_COMPLIANT) print(len(results)) 450

Source code in ucmdb_rest\policies.py 
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
216
217
218
219
220
221
222
223
224
def getAllResultsForPath(self, execution_id, status_type=ComplianceStatus.NON_COMPLIANT):
    """
    Automatically iterates through all chunks for a specific status 
    and returns one flat list of results.

    This method handles the pagination logic of the UCMDB server by 
    first determining the number of chunks and then sequentially 
    retrieving and aggregating them into a single list.

    Parameters
    ----------
    execution_id : str
        The ID of the view execution (viewResultId).
    status_type : ComplianceStatus or str, optional
        The compliance status to retrieve ("COMPLIANT", 
        "NON-COMPLIANT", "NON-APPLICABLE"). 
        Default is ComplianceStatus.NON_COMPLIANT.

    Returns
    -------
    list
        A flat list of dictionaries representing the compliance results,
        aggregated from all available chunks.

    Example
    -------
    >>> from ucmdb_rest.policies import ComplianceStatus
    >>> exec_id = 'eyJ0eXAiOiJKV1...'
    >>> results = getAllResultsForPath(exec_id, ComplianceStatus.NON_COMPLIANT)
    >>> print(len(results))
    450
    """
    all_results = []
    status_value = status_type.value if hasattr(status_type, 'value') else status_type

    payload = {
        "viewExecutionId": execution_id,
        "path": [{
            "pathElementId": status_value,
            "pathElementType": status_value
        }]
    }
    count_res = self.getNumberOfElements(payload)

    if count_res.status_code != 200:
        return []

    data = count_res.json()
    num_chunks = data.get('numberOfChunks', 0)

    for i in range(1, num_chunks + 1):
        chunk_res = self.getChunkForPath(execution_id, i, status_type)
        if chunk_res.status_code == 200:
            chunk_data = chunk_res.json()
            items = chunk_data if isinstance(chunk_data, list) else chunk_data.get('cis', [])
            all_results.extend(items)

    return all_results

getChunkForPath(execution_id, chunk, status_type=ComplianceStatus.NON_COMPLIANT)

Retrieves a specific data chunk for a given path (status) from the UCMDB server.

This method makes a POST request to the UCMDB server to retrieve a specific chunk of compliance data.

Parameters:

Name Type Description Default
execution_id str

The ID of the view execution.

 required
chunk int

The number of the chunk to retrieve.

 required
status_type ComplianceStatus or str

The compliance status ("COMPLIANT", "NON-COMPLIANT", "NON-APPLICABLE"). Default is ComplianceStatus.NON_COMPLIANT.

 NON_COMPLIANT

Returns:

Type Description
Response

Response object containing the requested compliance data chunk.
Example

from ucmdb_rest.policies import ComplianceStatus execution_id = 'example_execution_id' chunk = 1 response = getChunkForPath(execution_id, chunk, ComplianceStatus.NON_COMPLIANT) print(response.status_code) 200

Source code in ucmdb_rest\policies.py 
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
164
165
def getChunkForPath(self, execution_id, chunk, status_type=ComplianceStatus.NON_COMPLIANT):
    """
    Retrieves a specific data chunk for a given path (status) from the UCMDB server.

    This method makes a POST request to the UCMDB server to retrieve
    a specific chunk of compliance data.

    Parameters
    ----------
    execution_id : str
        The ID of the view execution.
    chunk : int
        The number of the chunk to retrieve.
    status_type : ComplianceStatus or str, optional
        The compliance status ("COMPLIANT", "NON-COMPLIANT", "NON-APPLICABLE").
        Default is ComplianceStatus.NON_COMPLIANT.

    Returns
    -------
    requests.Response
        Response object containing the requested compliance data chunk.

    Example
    -------
    >>> from ucmdb_rest.policies import ComplianceStatus
    >>> execution_id = 'example_execution_id'
    >>> chunk = 1
    >>> response = getChunkForPath(execution_id, chunk, ComplianceStatus.NON_COMPLIANT)
    >>> print(response.status_code)
    >>> 200
    """
    status_value = status_type.value if hasattr(status_type, 'value') else status_type
    body = {
        "viewExecutionId": execution_id,
        "path": [{
            "pathElementId": status_value,
            "pathElementType": status_value
        }],
        "chunkNumber": chunk
    }
    url = '/policy/chunkForPath?chunkSize=300'
    return self.server._request("POST",url,json=body)

getComplainceViews()

Retrieves the valid compliance views based on policies that exist in a UCMDB system.

This method makes a GET request to the UCMDB server to fetch a list of compliance views.

Returns:

Type Description
Response

A JSON object containing a list of dictionaries, each representing a compliance view with the following keys: - name: str - baseViewName: str - policyQueries: list of str
Example

compliance_views = getComplainceViews() for view in compliance_views: print(view['name'], view['baseViewName'], view['policyQueries'])

Certificates must use https Node with WebServer ['Certificates must use https'] Kubernetes statefulset must have pod Kubernetes StatefulSet ['Kubernetes statefulset']

Source code in ucmdb_rest\policies.py 
 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
def getComplainceViews(self):
    """
    Retrieves the valid compliance views based on policies that exist
    in a UCMDB system.

    This method makes a GET request to the UCMDB server to fetch a list
    of compliance views.

    Returns
    -------
    requests.Response
        A JSON object containing a list of dictionaries, each
        representing a compliance view with the following keys:
        - name: str
        - baseViewName: str
        - policyQueries: list of str

    Example
    -------
    >>> compliance_views = getComplainceViews()
    >>> for view in compliance_views:
    >>>     print(view['name'], view['baseViewName'], view['policyQueries'])
    >>>
    >>> Certificates must use https Node with WebServer ['Certificates must use https']
    >>> Kubernetes statefulset must have pod Kubernetes StatefulSet ['Kubernetes statefulset']
    """
    url = '/policy/complianceViews'
    return self.server._request("GET",url)

getNumberOfElements(payload)

Retrieves the number of elements for a specified path from the UCMDB server.

This method makes a POST request to the UCMDB server to retrieve the number of elements for a specified path.

Parameters:

Name Type Description Default
payload dict

The payload containing the necessary data for the request.

 required

Returns:

Type Description
Response

Response object containing the number of elements for the specified path.
Example

payload = {'data': 'example_data'} response = getNumberOfElements(payload) print(response.status_code) 200

Source code in ucmdb_rest\policies.py 
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 getNumberOfElements(self, payload):
    """
    Retrieves the number of elements for a specified path from the UCMDB
    server.

    This method makes a POST request to the UCMDB server to retrieve the
    number of elements for a specified path.

    Parameters
    ----------
    payload : dict
        The payload containing the necessary data for the request.

    Returns
    -------
    requests.Response
        Response object containing the number of elements for the specified
        path.

    Example
    -------
    >>> payload = {'data': 'example_data'}
    >>> response = getNumberOfElements(payload)
    >>> print(response.status_code)
    >>> 200
    """
    url = '/uiserver/modeling/views/result/numberOfElementsForPath'
    return self.server._request("POST",url,json=payload)

getPolicies()

Retrieves the valid policies that exist in a UCMDB system.

This method makes a GET request to the UCMDB server to fetch a list of valid policies.

Returns:

Type Description
Response

A JSON object containing a list of dictionaries, each representing a policy with the following keys: - name: str - path: str - simplePolicy: bool
Example

policies = getPolicies() for policy in policies: ... print(policy['name'], policy['path'], policy['simplePolicy']) ... Certificates must use https Query/Policy/Security True Kubernetes must have pod Query/Policy/Cloud Compliance/Kubernetes False

Source code in ucmdb_rest\policies.py 
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
def getPolicies(self):
    """
    Retrieves the valid policies that exist in a UCMDB system.

    This method makes a GET request to the UCMDB server to fetch a list
    of valid policies.

    Returns
    -------
    requests.Response
        A JSON object containing a list of dictionaries, each
        representing a policy with the following keys:
        - name: str
        - path: str
        - simplePolicy: bool

    Example
    -------
    >>> policies = getPolicies()
    >>> for policy in policies:
    ...     print(policy['name'], policy['path'], policy['simplePolicy'])
    ...
    Certificates must use https Query/Policy/Security True
    Kubernetes must have pod Query/Policy/Cloud Compliance/Kubernetes False
    """
    url = '/policy/policies'
    return self.server._request("GET",url)

getSpecificComplianceView(cv)

Retrieves the result of a specific compliance report.

This method makes a GET request to the UCMDB server to fetch the details of a specific compliance view.

Parameters:

Name Type Description Default
cv str

The name of the compliance view.

 required

Returns:

Type Description
Response

A JSON object containing details of the specified compliance view, including: - name: str - baseViewName: str - policyQueries: list of str
Example

cv = 'Nodes with Discovery Probe' compliance_view = getSpecificComplianceView(cv) print(compliance_view['name']) 'Nodes with Discovery Probe'

Notes

The quote function is used to properly encode the compliance view name, ensuring that it can be safely used as part of a URL.

Source code in ucmdb_rest\policies.py 
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
def getSpecificComplianceView(self, cv):
    """
    Retrieves the result of a specific compliance report.

    This method makes a GET request to the UCMDB server to fetch the details
    of a specific compliance view.

    Parameters
    ----------
    cv : str
        The name of the compliance view.

    Returns
    -------
    requests.Response
        A JSON object containing details of the specified compliance view,
        including:
        - name: str
        - baseViewName: str
        - policyQueries: list of str

    Example
    -------
    >>> cv = 'Nodes with Discovery Probe'
    >>> compliance_view = getSpecificComplianceView(cv)
    >>> print(compliance_view['name'])
    >>> 'Nodes with Discovery Probe'

    Notes
    -----
    The quote function is used to properly encode the compliance view
    name, ensuring that it can be safely used as part of a URL.
    """
    the_name = quote(cv)
    url = f'/policy/complianceView/{the_name}'
    return self.server._request("GET",url)