Skip to content

Data Flow Management

ucmdb_rest.data_flow_management.DataFlowManagement(server)

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

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

addRange(range_to_add, probe_name)

Creates a range in UCMDB for discovery.

This function makes a POST request to the UCMDB server to create the range of IP Addresses.

Parameters:

Name Type Description Default
range_to_add list of dict

A list of dictionaries containing the range.

 required
probe_name str

The name of the probe to which the range is to be added.

 required

Returns:

Type Description
Response
list of dicts

A string representation of the created range.

Example

[ { "range": "10.1.1.1-10.1.1.2", "definitionType": "IP_RANGE", "ipVersion": "IPV4", "isIncluded": true, "rangeType": "DATA_CENTER", "description": "My Range" } ]
Source code in ucmdb_rest\data_flow_management.py 
25
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
def addRange(self, range_to_add, probe_name):
    """
    Creates a range in UCMDB for discovery.

    This function makes a POST request to the UCMDB server to create
    the range of IP Addresses.

    Parameters
    ----------
    range_to_add : list of dict
        A list of dictionaries containing the range.
    probe_name : str
        The name of the probe to which the range is to be added.

    Returns
    -------
    requests.Response
    list of dicts
        A string representation of the created range.

        Example
        -------
        [
        {
            "range": "10.1.1.1-10.1.1.2",
            "definitionType": "IP_RANGE",
            "ipVersion": "IPV4",
            "isIncluded": true,
            "rangeType": "DATA_CENTER",
            "description": "My Range"
        }
        ]
    """
    url_part = f'/dataflowmanagement/probes/{probe_name}/ranges'
    return self.server._request("POST",url_part,json=range_to_add)

checkCredential(credential_id, probe, ip_addr, timeout=60000)

This function will check the credential from UCMDB server/Probe to a target

Parameters:

Name Type Description Default
credential_id str

The credential ID, like 3_1_CMS.

 required
probe

Name of the probe

 required
ip_addr

IP Address to run check agains

 required
timeout int

This is the max amount of time to wait for a response. It may need to be increased on slow networks. Default is 60000 (60 seconds)

 60000

Returns:

Type Description
Response

The output of the agent communication.
Source code in ucmdb_rest\data_flow_management.py 
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
def checkCredential (self, credential_id, probe, ip_addr, timeout=60000):
    """
    This function will check the credential from UCMDB server/Probe to a target

    Parameters
    ----------
    credential_id : str
        The credential ID, like 3_1_CMS.
    probe: str
        Name of the probe
    ip_addr: str
        IP Address to run check agains
    timeout : int
        This is the max amount of time to wait for a response.  It may need to be
        increased on slow networks.  Default is 60000 (60 seconds)

    Returns
    -------
    requests.Response
        The output of the agent communication.

    """
    body_json = {
        'probeName':probe,
        'ipAddress':ip_addr,
        'timeout':timeout
    }

    url_part = '/dataflowmanagement/credentials/'+credential_id+'/availability'
    return self.server._request("POST",url_part,json=body_json)

createNTCMDCredential(my_protocol)

Creates an NTCMD credential in UCMDB.

This function makes a POST request to the UCMDB server to create the credential.

Parameters:

Name Type Description Default
my_protocol dict

A dictionary containing the protocol.

 required

Returns:

Type Description
Response

A string with the credential ID. For example: "10_1_CMS"
Source code in ucmdb_rest\data_flow_management.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def createNTCMDCredential(self, my_protocol):
    """
    Creates an NTCMD credential in UCMDB.

    This function makes a POST request to the UCMDB server to create
    the credential.

    Parameters
    ----------
    my_protocol : dict
        A dictionary containing the protocol.

    Returns
    -------
    requests.Response
        A string with the credential ID. For example:
        "10_1_CMS"
    """
    url_part = '/dataflowmanagement/credentials'
    return self.server._request("POST",url_part,json=my_protocol)

deleteProbe(probe_names)

Parameters:

Name Type Description Default
probe_names list of strings

A list of probes to delete. For example: ['probe1','probe2']

 required

Returns:

Type Description
Response

Should be like an empty dictionary: For example: {}
Source code in ucmdb_rest\data_flow_management.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def deleteProbe (self, probe_names):
    """
    Parameters
    ----------
    probe_names : list of strings
        A list of probes to delete.  For example:  ['probe1','probe2']

    Returns
    -------
    requests.Response
        Should be like an empty dictionary:
        For example:  {}

    """
    url_part = '/dataflowmanagement/probes'
    params = {'probenames': probe_names}
    return self.server._request("DELETE",url_part,params=params)

deleteRange(delete_range, probe_name)

Deletes a range of IP Addresses in UCMDB for discovery.

This function makes a DELETE request to the UCMDB server to create the range of IP Addresses.

Parameters:

Name Type Description Default
delete_range list of dict

A list of dictionaries containing the range. For example: [ { "probe": "FTC06UCM43", "range": "10.1.1.1-10.1.1.2", "definitionType": "IP_RANGE", "ipVersion": "IPV4", "isIncluded": true } ]

 required
probe_name str

The name of the probe to which the range is to be added.

 required

Returns:

Type Description
Response

Should be like an empty dictionary: For example: {}
Source code in ucmdb_rest\data_flow_management.py 
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
def deleteRange(self, delete_range, probe_name):
    """
    Deletes a range of IP Addresses in UCMDB for discovery.

    This function makes a DELETE request to the UCMDB server to
    create the range of IP Addresses.

    Parameters
    ----------
    delete_range : list of dict
        A list of dictionaries containing the range. For example:
            [
            {
                "probe": "FTC06UCM43",
                "range": "10.1.1.1-10.1.1.2",
                "definitionType": "IP_RANGE",
                "ipVersion": "IPV4",
                "isIncluded": true
            }
            ]
    probe_name : str
        The name of the probe to which the range is to be added.

    Returns
    -------
    requests.Response
        Should be like an empty dictionary:
        For example:  {}
    """
    url_part = f'/dataflowmanagement/probes/{probe_name}/ranges'
    return self.server._request("DELETE",url_part,json=delete_range)

do_availability_check(ci_to_check, probe, timeout=60000)

Checks the availability of a given credential.

This function makes a POST request to the UCMDB server to check the availability of the credential.

Parameters:

Name Type Description Default
ci_to_check dict

A dictionary of the UD Agent CI to check.

 required
probe str

The probe the CI is part of.

 required
timeout int

This is the max amount of time to wait for a response. It may need to be increased on slow networks. Default is 60000 (60 seconds)

 60000

Returns:

Type Description
Response

Can be converted to a dictionary containing the results of the check.
Source code in ucmdb_rest\data_flow_management.py 
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
def do_availability_check(self, ci_to_check, probe, timeout=60000):
    """
    Checks the availability of a given credential.

    This function makes a POST request to the UCMDB server to check the
    availability of the credential.

    Parameters
    ----------
    ci_to_check : dict
        A dictionary of the UD Agent CI to check.
    probe : str
        The probe the CI is part of.
    timeout : int
        This is the max amount of time to wait for a response.  It may need to be
        increased on slow networks.  Default is 60000 (60 seconds)

    Returns
    -------
    requests.Response
        Can be converted to a dictionary containing the results of the check.
    """
    json_body = {
        'probeName': probe,
        'ipAddress': ci_to_check['application_ip'],
        'timeout': timeout
    }
    url_part = '/dataflowmanagement/credentials/' + str(ci_to_check['credentials_id']) + '/availability'  # noqa: E501
    return self.server._request("POST",url_part,json=json_body)

getAllCredentials()

Retrieves all credentials via a GET call to the UCMDB REST API.

Returns:

Type Description
Response

This can be converted to a list of dictionaries, each representing one domain. For example: [ { "domainName": "DefaultDomain", "description": "", "type": "customer", "encrypt": false, "hashProtocols": { "sshprotocol": [ { "hashParameters": { "sshprotocol_sudo_su_policy": "privileged_execution", "protocol_pe_su_username": null, "protocol_username": "root", "sshprotocol_su_username": null, "sshprotocol_prompts": null, "protocol_timeout": "25000", "sshprotocol_sudo_paths": null, "protocol_netaddress": null, "protocol_pe_mode": "su", "protocol_pce_command_list": null, "sshprotocol_shell_env_sep_char": ";", "protocol_in_use": "true", "protocol_pce_policy": "privileged_execution", "external_vault_type": null, "protocol_index": "1", "sshprotocol_hello_timeout": "10000", "external_password_static_key": null, "protocol_port": "22", "user_label": "UCMDB root", "password_vault_type": null, "sshprotocol_authmode": "password", "sshprotocol_sudo_commands": null, "sshprotocol_version": "SSH2/SSH1", "cm_credential_id": "4_1_CMS", "password_vault_reference_id": null, "sshprotocol_keypath": null, "protocol_type": "sshprotocol" }, "protocolIndex": 1, "netAddress": null } ] } } ]
Source code in ucmdb_rest\data_flow_management.py 
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
def getAllCredentials(self):
    """
    Retrieves all credentials via a GET call to the UCMDB REST API.

    Returns
    -------
    requests.Response
        This can be converted to a list of dictionaries, each representing one
        domain. For example:
        [
            {
                "domainName": "DefaultDomain",
                "description": "",
                "type": "customer",
                "encrypt": false,
                "hashProtocols": {
                    "sshprotocol": [
                        {
                            "hashParameters": {
                                "sshprotocol_sudo_su_policy": "privileged_execution",
                                "protocol_pe_su_username": null,
                                "protocol_username": "root",
                                "sshprotocol_su_username": null,
                                "sshprotocol_prompts": null,
                                "protocol_timeout": "25000",
                                "sshprotocol_sudo_paths": null,
                                "protocol_netaddress": null,
                                "protocol_pe_mode": "su",
                                "protocol_pce_command_list": null,
                                "sshprotocol_shell_env_sep_char": ";",
                                "protocol_in_use": "true",
                                "protocol_pce_policy": "privileged_execution",
                                "external_vault_type": null,
                                "protocol_index": "1",
                                "sshprotocol_hello_timeout": "10000",
                                "external_password_static_key": null,
                                "protocol_port": "22",
                                "user_label": "UCMDB root",
                                "password_vault_type": null,
                                "sshprotocol_authmode": "password",
                                "sshprotocol_sudo_commands": null,
                                "sshprotocol_version": "SSH2/SSH1",
                                "cm_credential_id": "4_1_CMS",
                                "password_vault_reference_id": null,
                                "sshprotocol_keypath": null,
                                "protocol_type": "sshprotocol"
                            },
                            "protocolIndex": 1,
                            "netAddress": null
                        }
                    ]
                }
            }
        ]

    """
    url_part = '/dataflowmanagement/credentials'
    return self.server._request("GET",url_part)

getAllDomains()

Retrieves the list of configured domains from UCMDB.

This function makes a GET request to the UCMDB server to retrieve the information.

Returns:

Type Description
Response

Can be converted to a list of dictionaries containing 1 domain entry per list entry.

Example

[ { "domainName": "DefaultDomain", "description": "", "credentialNum": "5", "probeNum": "1" } ]
Source code in ucmdb_rest\data_flow_management.py 
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
def getAllDomains(self):
    """
    Retrieves the list of configured domains from UCMDB.

    This function makes a GET request to the UCMDB server to retrieve
    the information.

    Returns
    -------
    requests.Response
        Can be converted to a list of dictionaries containing 1 domain entry per list
        entry.

        Example
        -------
        [
        {
            "domainName": "DefaultDomain",
            "description": "",
            "credentialNum": "5",
            "probeNum": "1"
        }
        ]
    """
    url_part = '/dataflowmanagement/domains'
    return self.server._request("GET",url_part)

getAllProtocols()

This method will get a dictionary which lists all possible protocols via a GET method to the UCMDB server.

Returns:

Type Description
Response

Can be converted to a dictionary of all possible protocols. For example: { "AMQP Protocol": "amqpprotocol", "AS400 Protocol": "as400protocol", "Asset Manager Protocol": "amadapterprotocol", "AWS Protocol": "awsprotocol", "Azure Protocol": "azureprotocol", "CA CMDB Protocol": "cacmdbprotocol", "CIM Protocol": "cimprotocol", "Generic DB Protocol (NoSQL)": "nosqlprotocol", "Generic DB Protocol (SQL)": "sqlprotocol", "Generic Protocol": "genericprotocol", "Google Cloud Protocol": "google_cloudprotocol", "HTTP Protocol": "httpprotocol", "JBOSS Protocol": "jbossprotocol", "LDAP Protocol": "ldapprotocol", "NetApp Protocol": "netappprotocol", "Network Automation Java Protocol": "networkautomationprotocol", "NTCMD Protocol": "ntadminprotocol", "Oracle Cloud Protocol": "oracle_cloudprotocol", "PowerApps Protocol": "powerappsprotocol", "PowerCmd Protocol": "powercmdprotocol", "Powershell Protocol (deprecated)": "powershellprotocol", "Remedy Protocol": "remedyprotocol", "Salesforce Rest Protocol": "salesforceprotocol", "SAP JMX Protocol": "sapjmxprotocol", "SAP Protocol": "sapprotocol", "ServiceNow Protocol": "snowprotocol", "Siebel Gateway Protocol": "siebelgtwyprotocol", "SNMP Protocol": "snmpprotocol", "SSH Protocol": "sshprotocol", "Telnet Protocol": "telnetprotocol", "TIBCO Protocol": "tibcoprotocol", "TLS Protocol": "tlsprotocol", "UCMDB Protocol": "ucmdbadapterprotocol", "UCS Protocol": "ucsprotocol", "Universal Discovery Protocol": "udaprotocol", "vCloud Protocol": "vcloudprotocol", "VMware VIM Protocol": "vmwareprotocol", "WebLogic Protocol": "weblogicprotocol", "WebSphere Protocol": "websphereprotocol", "WMI Protocol": "wmiprotocol" }
Source code in ucmdb_rest\data_flow_management.py 
279
280
281
282
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
def getAllProtocols(self):
    """
    This method will get a dictionary which lists all possible
    protocols via a GET method to the UCMDB server.

    Returns
    -------
    requests.Response
        Can be converted to a dictionary of all possible protocols. For example:
        {
            "AMQP Protocol": "amqpprotocol",
            "AS400 Protocol": "as400protocol",
            "Asset Manager Protocol": "amadapterprotocol",
            "AWS Protocol": "awsprotocol",
            "Azure Protocol": "azureprotocol",
            "CA CMDB Protocol": "cacmdbprotocol",
            "CIM Protocol": "cimprotocol",
            "Generic DB Protocol (NoSQL)": "nosqlprotocol",
            "Generic DB Protocol (SQL)": "sqlprotocol",
            "Generic Protocol": "genericprotocol",
            "Google Cloud Protocol": "google_cloudprotocol",
            "HTTP Protocol": "httpprotocol",
            "JBOSS Protocol": "jbossprotocol",
            "LDAP Protocol": "ldapprotocol",
            "NetApp Protocol": "netappprotocol",
            "Network Automation Java Protocol":
                "networkautomationprotocol",
            "NTCMD Protocol": "ntadminprotocol",
            "Oracle Cloud Protocol": "oracle_cloudprotocol",
            "PowerApps Protocol": "powerappsprotocol",
            "PowerCmd Protocol": "powercmdprotocol",
            "Powershell Protocol (deprecated)":
                "powershellprotocol",
            "Remedy Protocol": "remedyprotocol",
            "Salesforce Rest Protocol": "salesforceprotocol",
            "SAP JMX Protocol": "sapjmxprotocol",
            "SAP Protocol": "sapprotocol",
            "ServiceNow Protocol": "snowprotocol",
            "Siebel Gateway Protocol": "siebelgtwyprotocol",
            "SNMP Protocol": "snmpprotocol",
            "SSH Protocol": "sshprotocol",
            "Telnet Protocol": "telnetprotocol",
            "TIBCO Protocol": "tibcoprotocol",
            "TLS Protocol": "tlsprotocol",
            "UCMDB Protocol": "ucmdbadapterprotocol",
            "UCS Protocol": "ucsprotocol",
            "Universal Discovery Protocol": "udaprotocol",
            "vCloud Protocol": "vcloudprotocol",
            "VMware VIM Protocol": "vmwareprotocol",
            "WebLogic Protocol": "weblogicprotocol",
            "WebSphere Protocol": "websphereprotocol",
            "WMI Protocol": "wmiprotocol"
        }

    """
    url = '/dataflowmanagement/protocols'
    return self.server._request("GET",url)

getCredentialProfiles()

This method will get a dictionary which lists all current protocols instantiated via a GET method to the UCMDB server.

Returns:

Type Description
Response

Can be converted to a dictionary of all possible protocols. For example: { "items": [ { "name": "All Credentials", "id": "All Credentials", "type": "CMS", "oob": true, "credentials": [ { "domain": "DefaultDomain", "protocols": { "sshprotocol": [ "4_1_CMS", "5_1_CMS" ], "ntadminprotocol": [ "2_1_CMS", "3_1_CMS", "7_1_CMS", "8_1_CMS", "9_1_CMS", "10_1_CMS" ], "httpprotocol": [ "6_1_CMS" ] } } ] } ] }
Source code in ucmdb_rest\data_flow_management.py 
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
def getCredentialProfiles(self):
    """
    This method will get a dictionary which lists all current
    protocols instantiated via a GET method to the UCMDB server.

    Returns
    -------
    requests.Response
        Can be converted to a dictionary of all possible protocols. For example:
        {
            "items": [
                {
                    "name": "All Credentials",
                    "id": "All Credentials",
                    "type": "CMS",
                    "oob": true,
                    "credentials": [
                        {
                            "domain": "DefaultDomain",
                            "protocols": {
                                "sshprotocol": [
                                    "4_1_CMS",
                                    "5_1_CMS"
                                ],
                                "ntadminprotocol": [
                                    "2_1_CMS",
                                    "3_1_CMS",
                                    "7_1_CMS",
                                    "8_1_CMS",
                                    "9_1_CMS",
                                    "10_1_CMS"
                                ],
                                "httpprotocol": [
                                    "6_1_CMS"
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    """
    url = '/discovery/credentialprofiles'
    return self.server._request("GET",url)

getProbeInfo()

This method calls a UCMDB REST API via GET and returns the status of data flow probes.

Returns:

Type Description
Response

Returns a dictionary with a single attribute, 'items' which contains a list of the data flow probe information. For example: { "items": [ { "probeName": "FTC06UCM43", "description": "", "probeVersion": "24.2.0.232", "probeInternalVersion": "11.8.0.232", "probeStatus": "CONNECTED", "probeIp": "16.71.201.63", "probeOS": "WINDOWS", "domainName": "DefaultDomain", "clusterName": "", "rangeCount": 1, "ipCount": 241, "versionCompatibility": "MATCHED", "upgradeStatus": "NO_ACTION", "lastAccessTime": 1718367907838, "tokenCompatible": true } ] }
Source code in ucmdb_rest\data_flow_management.py 
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
def getProbeInfo(self):
    """
    This method calls a UCMDB REST API via GET and returns the status
    of data flow probes.

    Returns
    -------
    requests.Response
        Returns a dictionary with a single attribute, 'items' which
        contains a list of the data flow probe information. For example:
        {
            "items": [
                {
                    "probeName": "FTC06UCM43",
                    "description": "",
                    "probeVersion": "24.2.0.232",
                    "probeInternalVersion": "11.8.0.232",
                    "probeStatus": "CONNECTED",
                    "probeIp": "16.71.201.63",
                    "probeOS": "WINDOWS",
                    "domainName": "DefaultDomain",
                    "clusterName": "",
                    "rangeCount": 1,
                    "ipCount": 241,
                    "versionCompatibility": "MATCHED",
                    "upgradeStatus": "NO_ACTION",
                    "lastAccessTime": 1718367907838,
                    "tokenCompatible": true
                }
            ]
        }

    """
    url = '/dataflowmanagement/probes'
    return self.server._request("GET",url)

getProbeRanges(probeName)

This method retrieves the range information of a specified probe via a GET request to the UCMDB REST API.

Parameters:

Name Type Description Default
probeName str

Name of the probe in UCMDB.

 required

Returns:

Type Description
Response

Dictionary of the probe and a list of all ranges in the probe. For example: { "probeName": "FTC06UCM43", "description": "", "probeVersion": "24.2.0.232", "probeInternalVersion": "11.8.0.232", "probeStatus": "CONNECTED", "probeIp": "16.71.201.63", "probeOS": "WINDOWS", "domainName": "DefaultDomain", "clusterName": "", "rangeCount": 1, "ipCount": 241, "ranges": [ [ { "probe": null, "range": "16.71.201.15-16.71.201.255", "description": "", "definitionType": 0, "rangeType": 0, "ipVersion": 0, "excluded": false } ] ], "versionCompatibility": "MATCHED", "upgradeStatus": "NO_ACTION", "lastAccessTime": 1718368208205, "tokenCompatible": false }
Source code in ucmdb_rest\data_flow_management.py 
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
def getProbeRanges(self, probeName):
    """
    This method retrieves the range information of a specified probe
    via a GET request to the UCMDB REST API.

    Parameters
    ----------
    probeName : str
        Name of the probe in UCMDB.

    Returns
    -------
    requests.Response
        Dictionary of the probe and a list of all ranges in the probe.
        For example:
        {
            "probeName": "FTC06UCM43",
            "description": "",
            "probeVersion": "24.2.0.232",
            "probeInternalVersion": "11.8.0.232",
            "probeStatus": "CONNECTED",
            "probeIp": "16.71.201.63",
            "probeOS": "WINDOWS",
            "domainName": "DefaultDomain",
            "clusterName": "",
            "rangeCount": 1,
            "ipCount": 241,
            "ranges": [
                [
                    {
                        "probe": null,
                        "range": "16.71.201.15-16.71.201.255",
                        "description": "",
                        "definitionType": 0,
                        "rangeType": 0,
                        "ipVersion": 0,
                        "excluded": false
                    }
                ]
            ],
            "versionCompatibility": "MATCHED",
            "upgradeStatus": "NO_ACTION",
            "lastAccessTime": 1718368208205,
            "tokenCompatible": false
        }
    """
    url = f'/dataflowmanagement/probes/{probeName}'
    return self.server._request("GET",url)

getProtocol(protocol_id)

Retrieves the attributes and types of a specified protocol via a GET request to the UCMDB REST API.

Parameters:

Name Type Description Default
protocol_id str

The type of protocol. Must be in this list: amqpprotocol, as400protocol, amadapterprotocol, awsprotocol, azureprotocol, cacmdbprotocol, cimprotocol, nosqlprotocol, sqlprotocol, genericprotocol, google_cloudprotocol, httpprotocol, jbossprotocol, ldapprotocol, netappprotocol, networkautomationprotocol, ntadminprotocol, oracle_cloudprotocol, powerappsprotocol, powercmdprotocol, powershellprotocol, remedyprotocol, salesforceprotocol, sapjmxprotocol, sapprotocol, snowprotocol, siebelgtwyprotocol, snmpprotocol, sshprotocol, telnetprotocol, tibcoprotocol, tlsprotocol, ucmdbadapterprotocol, ucsprotocol, udaprotocol, vcloudprotocol, vmwareprotocol, weblogicprotocol, websphereprotocol, wmiprotocol.

 required

Returns:

Type Description
Response

Returns a dictionary with all the attributes and types of a given protocol. For example: { "protocolAttributeList": { "generalProperties": [ { "attributeName": "user_label", "displayName": "User Label", "type": "string", "order": 0 }, { "attributeName": "protocol_timeout", "displayName": "Connection Timeout [msec]", "type": "integer", "defaultValue": "20000", "order": 0 }, { "attributeName": "external_vault_type", "displayName": "External Vault Type", "type": "string", "order": 0 }, { "attributeName": "protocol_username", "displayName": "User Name", "defaultValue": "", "type": "string", "order": 0 }, { "attributeName": "protocol_password", "displayName": "User Password", "type": "bytes", "order": 0, "Qualifiers": [ "ENCRYPTED_ATTRIBUTE" ] }, { "attributeName": "external_password_static_key", "displayName": "Reference", "type": "string", "order": 0 }, { "attributeName": "ntadminprotocol_ntdomain", "displayName": "Windows Domain", "type": "string", "order": 0 }, { "attributeName": "ntadminprotocol_service_startup", "displayName": "Run remote commands impersonated", "type": "string", "defaultValue": "LocalService", "valueList": [ "LocalService", "User" ], "order": 0 }, { "attributeName": "ntadminprotocol_remote_share_alias", "displayName": "Remote Share Path", "type": "string", "order": 0 }, { "attributeName": "ntadminprotocol_remote_share_path", "displayName": "Share Local Path", "type": "string", "order": 0 } ] }, "protocolAttributeDisplayList": { "protocol_username": [ { "attributeName": "external_vault_type", "value": "Internal" } ], "protocol_password": [ { "attributeName": "external_vault_type", "value": "Internal" } ], "external_password_static_key": [ { "attributeName": "external_vault_type", "value": "CyberArk" }, { "attributeName": "external_vault_type", "value": "SAP" } ] }, "dynamicAttributeList": { "external_vault_type": { "attributeName": "external_vault_type", "valueList": [ "Internal" ], "order": 0 } }, "protocolAttributeValidteList": { "external_password_static_key": [ "externalVaultReferenceFormat", "presence" ] }, "isNewProtocolParameter": true, "protocolName": "ntadminprotocol" }
Source code in ucmdb_rest\data_flow_management.py 
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
def getProtocol(self, protocol_id):
    """
    Retrieves the attributes and types of a specified protocol via a
    GET request to the UCMDB REST API.

    Parameters
    ----------
    protocol_id : str
        The type of protocol. Must be in this list:
            amqpprotocol, as400protocol, amadapterprotocol, awsprotocol,
            azureprotocol, cacmdbprotocol, cimprotocol, nosqlprotocol,
            sqlprotocol, genericprotocol, google_cloudprotocol,
            httpprotocol, jbossprotocol, ldapprotocol, netappprotocol,
            networkautomationprotocol, ntadminprotocol,
            oracle_cloudprotocol, powerappsprotocol, powercmdprotocol,
            powershellprotocol, remedyprotocol, salesforceprotocol,
            sapjmxprotocol, sapprotocol, snowprotocol, siebelgtwyprotocol,
            snmpprotocol, sshprotocol, telnetprotocol, tibcoprotocol,
            tlsprotocol, ucmdbadapterprotocol, ucsprotocol, udaprotocol,
            vcloudprotocol, vmwareprotocol, weblogicprotocol,
            websphereprotocol, wmiprotocol.

    Returns
    -------
    requests.Response
        Returns a dictionary with all the attributes and types of a given
        protocol. For example:
        {
            "protocolAttributeList": {
                "generalProperties": [
                    {
                        "attributeName": "user_label",
                        "displayName": "User Label",
                        "type": "string",
                        "order": 0
                    },
                    {
                        "attributeName": "protocol_timeout",
                        "displayName": "Connection Timeout [msec]",
                        "type": "integer",
                        "defaultValue": "20000",
                        "order": 0
                    },
                    {
                        "attributeName": "external_vault_type",
                        "displayName": "External Vault Type",
                        "type": "string",
                        "order": 0
                    },
                    {
                        "attributeName": "protocol_username",
                        "displayName": "User Name",
                        "defaultValue": "",
                        "type": "string",
                        "order": 0
                    },
                    {
                        "attributeName": "protocol_password",
                        "displayName": "User Password",
                        "type": "bytes",
                        "order": 0,
                        "Qualifiers": [
                            "ENCRYPTED_ATTRIBUTE"
                        ]
                    },
                    {
                        "attributeName": "external_password_static_key",
                        "displayName": "Reference",
                        "type": "string",
                        "order": 0
                    },
                    {
                        "attributeName": "ntadminprotocol_ntdomain",
                        "displayName": "Windows Domain",
                        "type": "string",
                        "order": 0
                    },
                    {
                        "attributeName": "ntadminprotocol_service_startup",
                        "displayName": "Run remote commands impersonated",
                        "type": "string",
                        "defaultValue": "LocalService",
                        "valueList": [
                            "LocalService",
                            "User"
                        ],
                        "order": 0
                    },
                    {
                        "attributeName": "ntadminprotocol_remote_share_alias",
                        "displayName": "Remote Share Path",
                        "type": "string",
                        "order": 0
                    },
                    {
                        "attributeName": "ntadminprotocol_remote_share_path",
                        "displayName": "Share Local Path",
                        "type": "string",
                        "order": 0
                    }
                ]
            },
            "protocolAttributeDisplayList": {
                "protocol_username": [
                    {
                        "attributeName": "external_vault_type",
                        "value": "Internal"
                    }
                ],
                "protocol_password": [
                    {
                        "attributeName": "external_vault_type",
                        "value": "Internal"
                    }
                ],
                "external_password_static_key": [
                    {
                        "attributeName": "external_vault_type",
                        "value": "CyberArk"
                    },
                    {
                        "attributeName": "external_vault_type",
                        "value": "SAP"
                    }
                ]
            },
            "dynamicAttributeList": {
                "external_vault_type": {
                    "attributeName": "external_vault_type",
                    "valueList": [
                        "Internal"
                    ],
                    "order": 0
                }
            },
            "protocolAttributeValidteList": {
                "external_password_static_key": [
                    "externalVaultReferenceFormat",
                    "presence"
                ]
            },
            "isNewProtocolParameter": true,
            "protocolName": "ntadminprotocol"
        }
    """
    url = f'/dataflowmanagement/protocols/{protocol_id}'
    return self.server._request("GET",url)

probeStatus()

This method queries the UCMDB server and gets information about the status of the probe including CPU, RAM, Disk, etc.

Returns:

Type Description
Response

Returns a dictionary containing the probe and information about the probe. For example: { "FTC06UCM43": { "fips": false, "zoneBased": true, "domainName": "DefaultDomain", "probeName": "FTC06UCM43", "probeStatus": "Well", "ip": "16.71.201.63", "cpuUsage": 58.46154, "ramUsage": 96.64884, "totalRam": 12884, "usedRam": 12452, "harddiskUsage": 47.97787, "totalHarddisk": 128321, "usedHarddisk": 61565, "discoveredCI": 956555, "unSentCI": 0, "runningJob": 0, "totalJob": 14, "finishedJobNumber": 14, "scheduledJobNumber": 14, "blockedJobNumber": 0, "removedJobNumber": 0, "unsendJobNumber": 0, "activeWorker": 0, "totalWorker": 80, "jobSimpleRuntimeInfoWrapperMap": {}, "probeDiscoveryStatsMap": null, "externalVersion": "24.2.0.232", "tenantName": "", "totalHeapSize": 2147, "currentHeapUsage": 579, "heapUsage": 26.992249, "isFIPS": false, "certValidationLevel": 2, "customerID": "1", "serverName": "FTC06UCM43", "lastUpdateTime": 1718372135000, "isZoneBased": true } }
Source code in ucmdb_rest\data_flow_management.py 
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
def probeStatus(self):
    """
    This method queries the UCMDB server and gets information about the
    status of the probe including CPU, RAM, Disk, etc.

    Returns
    -------
    requests.Response
        Returns a dictionary containing the probe and information about the
        probe. For example:
        {
            "FTC06UCM43": {
                "fips": false,
                "zoneBased": true,
                "domainName": "DefaultDomain",
                "probeName": "FTC06UCM43",
                "probeStatus": "Well",
                "ip": "16.71.201.63",
                "cpuUsage": 58.46154,
                "ramUsage": 96.64884,
                "totalRam": 12884,
                "usedRam": 12452,
                "harddiskUsage": 47.97787,
                "totalHarddisk": 128321,
                "usedHarddisk": 61565,
                "discoveredCI": 956555,
                "unSentCI": 0,
                "runningJob": 0,
                "totalJob": 14,
                "finishedJobNumber": 14,
                "scheduledJobNumber": 14,
                "blockedJobNumber": 0,
                "removedJobNumber": 0,
                "unsendJobNumber": 0,
                "activeWorker": 0,
                "totalWorker": 80,
                "jobSimpleRuntimeInfoWrapperMap": {},
                "probeDiscoveryStatsMap": null,
                "externalVersion": "24.2.0.232",
                "tenantName": "",
                "totalHeapSize": 2147,
                "currentHeapUsage": 579,
                "heapUsage": 26.992249,
                "isFIPS": false,
                "certValidationLevel": 2,
                "customerID": "1",
                "serverName": "FTC06UCM43",
                "lastUpdateTime": 1718372135000,
                "isZoneBased": true
            }
        }

    """
    url = '/uiserver/probeService/dashboard/summary'
    return self.server._request("GET",url)

probeStatusDetails(domain, probe)

This method uses a GET call to the REST API of UCMDB to get the detailed status of a probe.

Parameters:

Name Type Description Default
domain str

Domain of the probe to get. The default value is 'DefaultDomain'.

 required
probe str

The name of the probe.

 required

Returns:

Type Description
Response

Contains detailed information about the probe and jobs running on it. For example: { "fips": false, "zoneBased": true, "domainName": "DefaultDomain", "probeName": "FTC06UCM43", "probeStatus": "Well", "ip": "16.71.201.63", "cpuUsage": 60.76923, "ramUsage": 96.74656, "totalRam": 12884, "usedRam": 12465, "harddiskUsage": 47.97838, "totalHarddisk": 128321, "usedHarddisk": 61566, "discoveredCI": 956555, "unSentCI": 0, "runningJob": 0, "totalJob": 14, "finishedJobNumber": 14, "scheduledJobNumber": 14, "blockedJobNumber": 0, "removedJobNumber": 0, "unsendJobNumber": 0, "activeWorker": 0, "totalWorker": 80, "jobSimpleRuntimeInfoWrapperMap": { "ZONE_zone 1_JOB_Range IPs by ICMP": { "jobName": "ZONE_zone 1_JOB_Range IPs by ICMP", "zoneId": "zone 1", "jobId": "Range IPs by ICMP", "progress": 0, "threadNumber": 0, "totalTrigger": 1, "succeededTriggerCI": 1, "previousInvocationTime": 1718301527000, "nextInvocationTime": 1718387927000, "objectsWaitingInQueue": 0, "lastDuration": 14, "averageDuration": 14.032, "recurence": 34, "status": "Scheduled" } }, "probeDiscoveryStatsMap": { "file_system": { "createdcount": 0, "updatedcount": 0, "removedcount": 122, "ignoredcount": 0, "invalidcount": 0, "totalcount": 122, "failed": 0, "unidentified": 0 }, "installed_software": { "createdcount": 0, "updatedcount": 0, "removedcount": 3, "ignoredcount": 0, "invalidcount": 0, "totalcount": 3, "failed": 0, "unidentified": 0 }, "usage": { "createdcount": 0, "updatedcount": 0, "removedcount": 4, "ignoredcount": 0, "invalidcount": 0, "totalcount": 4, "failed": 0, "unidentified": 0 } }, "externalVersion": "24.2.0.232", "tenantName": "", "totalHeapSize": 2147, "currentHeapUsage": 579, "heapUsage": 26.992249, "isFIPS": false, "certValidationLevel": 2, "customerID": "1", "serverName": "FTC06UCM43", "lastUpdateTime": 1718372666000, "isZoneBased": true }
Source code in ucmdb_rest\data_flow_management.py 
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
def probeStatusDetails(self, domain, probe):
    """
    This method uses a GET call to the REST API of UCMDB to get the
    detailed status of a probe.

    Parameters
    ----------
    domain : str
        Domain of the probe to get. The default value is 'DefaultDomain'.
    probe : str
        The name of the probe.

    Returns
    -------
    requests.Response
        Contains detailed information about the probe and jobs running
        on it. For example:
        {
            "fips": false,
            "zoneBased": true,
            "domainName": "DefaultDomain",
            "probeName": "FTC06UCM43",
            "probeStatus": "Well",
            "ip": "16.71.201.63",
            "cpuUsage": 60.76923,
            "ramUsage": 96.74656,
            "totalRam": 12884,
            "usedRam": 12465,
            "harddiskUsage": 47.97838,
            "totalHarddisk": 128321,
            "usedHarddisk": 61566,
            "discoveredCI": 956555,
            "unSentCI": 0,
            "runningJob": 0,
            "totalJob": 14,
            "finishedJobNumber": 14,
            "scheduledJobNumber": 14,
            "blockedJobNumber": 0,
            "removedJobNumber": 0,
            "unsendJobNumber": 0,
            "activeWorker": 0,
            "totalWorker": 80,
            "jobSimpleRuntimeInfoWrapperMap": {
                "ZONE_zone 1_JOB_Range IPs by ICMP": {
                    "jobName": "ZONE_zone 1_JOB_Range IPs by ICMP",
                    "zoneId": "zone 1",
                    "jobId": "Range IPs by ICMP",
                    "progress": 0,
                    "threadNumber": 0,
                    "totalTrigger": 1,
                    "succeededTriggerCI": 1,
                    "previousInvocationTime": 1718301527000,
                    "nextInvocationTime": 1718387927000,
                    "objectsWaitingInQueue": 0,
                    "lastDuration": 14,
                    "averageDuration": 14.032,
                    "recurence": 34,
                    "status": "Scheduled"
                }
            },
            "probeDiscoveryStatsMap": {
                "file_system": {
                    "createdcount": 0,
                    "updatedcount": 0,
                    "removedcount": 122,
                    "ignoredcount": 0,
                    "invalidcount": 0,
                    "totalcount": 122,
                    "failed": 0,
                    "unidentified": 0
                },
                "installed_software": {
                    "createdcount": 0,
                    "updatedcount": 0,
                    "removedcount": 3,
                    "ignoredcount": 0,
                    "invalidcount": 0,
                    "totalcount": 3,
                    "failed": 0,
                    "unidentified": 0
                },
                "usage": {
                    "createdcount": 0,
                    "updatedcount": 0,
                    "removedcount": 4,
                    "ignoredcount": 0,
                    "invalidcount": 0,
                    "totalcount": 4,
                    "failed": 0,
                    "unidentified": 0
                }
            },
            "externalVersion": "24.2.0.232",
            "tenantName": "",
            "totalHeapSize": 2147,
            "currentHeapUsage": 579,
            "heapUsage": 26.992249,
            "isFIPS": false,
            "certValidationLevel": 2,
            "customerID": "1",
            "serverName": "FTC06UCM43",
            "lastUpdateTime": 1718372666000,
            "isZoneBased": true
        }

    """
    url = f'/uiserver/probeService/dashboard/domain/{domain}/probe/{probe}/runtime'  # noqa: E501
    return self.server._request("GET",url)

queryIPs(ip_addr)

This method uses a GET call to the UCMDB REST API to determine which, if any, probe has a given IP Address in its ranges.

Parameters:

Name Type Description Default
ip_addr str

The IP Address to find (e.g. 10.1.1.1).

 required

Returns:

Name Type Description
Response

If found, returns the probe in a dictionary with a single entry called items, which is a list of dictionaries the IP address is in. Otherwise returns a dictionary with items and the list is empty. For example: { "items": [ { "probeName": "FTC06UCM43", "description": "", "probeVersion": "24.2.0.232", "probeInternalVersion": "11.8.0.232", "probeStatus": "CONNECTED", "probeIp": "16.71.201.63", "probeOS": "WINDOWS", "domainName": "DefaultDomain", "clusterName": "", "rangeCount": 1, "ipCount": 241, "versionCompatibility": "MATCHED", "upgradeStatus": "NO_ACTION", "lastAccessTime": 1718373382106, "tokenCompatible": true } ] }

or, if not found: { "items": [] }
Example

Finding an IP

To check if an IP exists within any probe ranges, initialize the server and call queryIPs:

myserver = UCMDBServer("user", "pass", "server")
find_ip = myserver.data_flow_management.queryIPs("10.1.1.1")
Source code in ucmdb_rest\data_flow_management.py 
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
def queryIPs(self, ip_addr):
    """
    This method uses a GET call to the UCMDB REST API to determine
    which, if any, probe has a given IP Address in its ranges.

    Parameters
    ----------
    ip_addr : str
        The IP Address to find (e.g. 10.1.1.1).

    Returns
    -------
    requests.Response
        If found, returns the probe in a dictionary with a single
        entry called items, which is a list of dictionaries the IP
        address is in. Otherwise returns a dictionary with items
        and the list is empty. For example:
        {
            "items": [
                {
                    "probeName": "FTC06UCM43",
                    "description": "",
                    "probeVersion": "24.2.0.232",
                    "probeInternalVersion": "11.8.0.232",
                    "probeStatus": "CONNECTED",
                    "probeIp": "16.71.201.63",
                    "probeOS": "WINDOWS",
                    "domainName": "DefaultDomain",
                    "clusterName": "",
                    "rangeCount": 1,
                    "ipCount": 241,
                    "versionCompatibility": "MATCHED",
                    "upgradeStatus": "NO_ACTION",
                    "lastAccessTime": 1718373382106,
                    "tokenCompatible": true
                }
            ]
        }

        or, if not found:
        {
            "items": []
        }
    Example:
        !!! example "Finding an IP"
            To check if an IP exists within any probe ranges, initialize the server 
            and call `queryIPs`:

            ```python
            myserver = UCMDBServer("user", "pass", "server")
            find_ip = myserver.data_flow_management.queryIPs("10.1.1.1")
            ```
    """
    url = f'/dataflowmanagement/probes?queriedIpAddress={ip_addr}'
    return self.server._request("GET",url)

queryProbe(ip_addr='', desc_filter='', domains=None, fields='', probestat=None, versioncomp=None)

The is a general purpose query about probes all the parameters are optional. If none are specified, all probes will be printed in a dictionary with a top level key of 'items' and one or more dictionaries of the fields specified, or all fields about the probe. Results appear to be 'or' results, not 'and' results with the exception of the probe status and version compatability items, which appear to and with things.

Parameters:

Name Type Description Default
ip_addr str

This is an IP that a probe contains in its range. It can be a partial IP which would get wildcarded (e.g. 10 would match any 10 in the ranges)

 ''
desc_filter str

This filters on the content of the description field that is returned

 ''
domains list[str]

This is a list of strings, e.g. ['DefaultDomain'] or ['DefaultDomain','MyDomain']

 None
fields str

This is a string representing the field to display. Can be comma separated For example: description,probename

 ''
probestat list[str]

This is a list which must contain at least one of these values, if specified DISCONNECTED, CONNECTED, STOPPED, RESTARTING, UPGRADING, AUTHENTICATION_FAILED, TOKEN_AUTHENTICATION_FAILED

 None
versioncomp list[str]

This is a list which must contain at least one of these values, if specified MATCHED, UPGRADEABLE, MUST_UPGRADE, NOT_SUPPORTED, UNKNOWN, COMPATIBLE, INCOMPATIBLE

 None
Notes

An example URL:
<protocol>://<Server>:<Port>/rest-api/dataflowmanagement/probes?queriedIpAddress=10&queriedprobedesc=24&domainNames=DefaultDomain &domainNames=MyDomain&fields=probename%2Cdescription&probeStatus=DISCONNECTED&probeStatus=CONNECTED&versionCompatibility=UPGRADEABLE &versionCompatibility=MUST_UPGRADE

Returns:

Type Description
Response
dict of items
Example
{
"items": [
    {
    "probeName": "sacucmrl254d",
    "description": "24.4.0.297",
    "probeVersion": "25.4.0.216",
    "probeInternalVersion": "11.13.0.216",
    "probeStatus": "STOPPED",
    "probeIp": "10.67.248.20",
    "probeOS": "WINDOWS",
    "domainName": "DefaultDomain",
    "clusterName": "",
    "rangeCount": 4,
    "ipCount": 7168,
    "versionCompatibility": "MATCHED",
    "upgradeStatus": "NO_ACTION",
    "lastAccessTime": 0,
    "tokenCompatible": true
    }
]
}
Source code in ucmdb_rest\data_flow_management.py 
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
def queryProbe(self,ip_addr="",desc_filter="",domains=None,fields="",probestat=None,versioncomp=None):  # noqa: E501
    """
    The is a general purpose query about probes all the parameters are optional.  If none are
    specified, all probes will be printed in a dictionary with a top level key of 'items' and
    one or more dictionaries of the fields specified, or all fields about the probe.  Results
    appear to be 'or' results, not 'and' results with the exception of the probe status and
    version compatability items, which appear to and with things.

    Parameters
    ----------
    ip_addr : str
        This is an IP that a probe contains in its range.  It can be a partial IP which 
        would get wildcarded (e.g. 10 would match any 10 in the ranges)
    desc_filter : str
        This filters on the content of the description field that is returned
    domains : list[str]
        This is a list of strings, e.g.  ['DefaultDomain'] or ['DefaultDomain','MyDomain']
    fields : str
        This is a string representing the field to display.  Can be comma separated
        For example:  description,probename
    probestat : list[str]
        This is a list which must contain at least one of these values, if specified
        DISCONNECTED, CONNECTED, STOPPED, RESTARTING, UPGRADING, AUTHENTICATION_FAILED,
        TOKEN_AUTHENTICATION_FAILED
    versioncomp : list[str]
        This is a list which must contain at least one of these values, if specified
        MATCHED, UPGRADEABLE, MUST_UPGRADE, NOT_SUPPORTED, UNKNOWN, COMPATIBLE, INCOMPATIBLE

    Notes
    ----------
    An example URL:   
    ``<protocol>://<Server>:<Port>/rest-api/dataflowmanagement/probes?queriedIpAddress=10&queriedprobedesc=24&domainNames=DefaultDomain``
    ``&domainNames=MyDomain&fields=probename%2Cdescription&probeStatus=DISCONNECTED&probeStatus=CONNECTED&versionCompatibility=UPGRADEABLE``
    ``&versionCompatibility=MUST_UPGRADE``

    Returns
    -------
    requests.Response
    dict of items

        Example
        -------
            {
            "items": [
                {
                "probeName": "sacucmrl254d",
                "description": "24.4.0.297",
                "probeVersion": "25.4.0.216",
                "probeInternalVersion": "11.13.0.216",
                "probeStatus": "STOPPED",
                "probeIp": "10.67.248.20",
                "probeOS": "WINDOWS",
                "domainName": "DefaultDomain",
                "clusterName": "",
                "rangeCount": 4,
                "ipCount": 7168,
                "versionCompatibility": "MATCHED",
                "upgradeStatus": "NO_ACTION",
                "lastAccessTime": 0,
                "tokenCompatible": true
                }
            ]
            }
    """
    domains = domains or []
    probestat = probestat or []
    versioncomp = versioncomp or []
    params = {}

    if ip_addr:
        params["queriedIpAddress"] = ip_addr
    if desc_filter:
        params["queriedprobedesc"] = desc_filter
    if domains:
        params["domainNames"] = domains
    if fields:
        no_spaces = fields.replace(" ", "")
        params["fields"] = no_spaces
    if probestat:
        params["probeStatus"] = probestat
    if versioncomp:
        params["versionCompatibility"] = versioncomp

    param_string = urlencode(params, doseq=True, safe="")
    url = f'/dataflowmanagement/probes?{param_string}'
    return self.server._request("GET",url)

updateRange(range_to_add, probe_name)

Updates an existing range in UCMDB for discovery.

This function makes a PATCH request to the UCMDB server to update the range of IP Addresses to a new range

Parameters:

Name Type Description Default
range_to_add dictionary containing 2 values 'oldRanges' and 'newRanges'

as keys to lists of dictionaries

 required
probe_name str

The name of the probe to which the range is to be added.

 required

Returns:

Type Description
Response
list of dicts

A string representation of the created range.

Example

{ "oldRanges": [ { "probe": "DataFlowProbe", "range": "1.1.1.1-1.1.1.2", "definitionType": "IP_RANGE", "ipVersion": "IPV4", "isIncluded": true } ], "newRanges": [ { "probe": "DataFlowProbe", "range": "1.1.1.1-1.1.1.2", "definitionType": "IP_RANGE", "ipVersion": "IPV4", "isIncluded": true, "rangeType": "DATA_CENTER", "description": "string" } ] }
Source code in ucmdb_rest\data_flow_management.py 
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
def updateRange(self, range_to_add, probe_name):
    """
    Updates an existing range in UCMDB for discovery.

    This function makes a PATCH request to the UCMDB server to update
    the range of IP Addresses to a new range

    Parameters
    ----------
    range_to_add : dictionary containing 2 values 'oldRanges' and 'newRanges'
        as keys to lists of dictionaries
    probe_name : str
        The name of the probe to which the range is to be added.

    Returns
    -------
    requests.Response
    list of dicts
        A string representation of the created range.

        Example
        -------
        {
            "oldRanges": [
                {
                "probe": "DataFlowProbe",
                "range": "1.1.1.1-1.1.1.2",
                "definitionType": "IP_RANGE",
                "ipVersion": "IPV4",
                "isIncluded": true
                }
            ],
            "newRanges": [
                {
                "probe": "DataFlowProbe",
                "range": "1.1.1.1-1.1.1.2",
                "definitionType": "IP_RANGE",
                "ipVersion": "IPV4",
                "isIncluded": true,
                "rangeType": "DATA_CENTER",
                "description": "string"
                }
            ]
        }
    """
    url = f'/dataflowmanagement/probes/{probe_name}/ranges'
    return self.server._request("PATCH",url, json=range_to_add)