Skip to content

Discovery

ucmdb_rest.discovery.Discovery(server)

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

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

createJobGroup(job_group)

Creates a new Discovery Job Group.

Parameters:

Name Type Description Default
job_group dict

A dictionary defining the job group. Example: { "name": "Inventory_Group", "description": "Custom inventory jobs", "jobs": [ {"jobName": "Host Connection by Shell", "isActivated": true}, {"jobName": "Host Applications by Shell", "isActivated": true} ] }

 required

Returns:

Type Description
Response

The response from the UCMDB server.
Source code in ucmdb_rest\discovery.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def createJobGroup(self, job_group):
    """
    Creates a new Discovery Job Group.

    Parameters
    ----------
    job_group : dict
        A dictionary defining the job group.
        Example:
        {
          "name": "Inventory_Group",
          "description": "Custom inventory jobs",
          "jobs": [
            {"jobName": "Host Connection by Shell", "isActivated": true},
            {"jobName": "Host Applications by Shell", "isActivated": true}
          ]
        }

    Returns
    -------
    requests.Response
        The response from the UCMDB server.
    """
    return self.server._request("POST",self._get_profile_url(), json=job_group)

createProfile(profile_name, job_groups)

Creates a Discovery Profile and assigns job groups to it.

Parameters:

Name Type Description Default
profile_name str

The unique name for the new profile.

 required
job_groups list of str

A list of existing job group names to be included in this profile. Example: ["Inventory Jobs", "Network Discovery"]

 required

Returns:

Type Description
Response
Source code in ucmdb_rest\discovery.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def createProfile(self, profile_name, job_groups):
    """
    Creates a Discovery Profile and assigns job groups to it.

    Parameters
    ----------
    profile_name : str
        The unique name for the new profile.
    job_groups : list of str
        A list of existing job group names to be included in this profile.
        Example: ["Inventory Jobs", "Network Discovery"]

    Returns
    -------
    requests.Response
    """
    payload = {
        "name": profile_name,
        "jobGroups": [{"name": group} for group in job_groups]
    }
    url = self._get_profile_url()
    return self.server._request("POST",url,json=payload)

deleteProfile(profile_name)

Deletes a Discovery Profile by name.

Parameters:

Name Type Description Default
profile_name str

The name of the profile to delete.

 required

Returns:

Type Description
Response
Source code in ucmdb_rest\discovery.py 
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def deleteProfile(self, profile_name):
    """
    Deletes a Discovery Profile by name.

    Parameters
    ----------
    profile_name : str
        The name of the profile to delete.

    Returns
    -------
    requests.Response
    """
    url = self._get_profile_url(profile_name)
    return self.server._request("DELETE",url)

deleteSpecificJobGroup(job_group)

Deletes a job group.

This function makes a DELETE request to the UCMDB server to delete a job group.

Parameters:

Name Type Description Default
job_group str

The name of the job group to delete.

 required

Returns:

Type Description
Response

Status code: - 200 : Success - 400 : Bad Request - 401 : Unauthorized - 404 : Resource Not Found - 500 : Internal Server Error
Source code in ucmdb_rest\discovery.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
def deleteSpecificJobGroup(self, job_group):
    """
    Deletes a job group.

    This function makes a DELETE request to the UCMDB server to 
    delete a job group.

    Parameters
    ----------
    job_group : str
        The name of the job group to delete.

    Returns
    -------
    requests.Response
        Status code:
        - 200 : Success
        - 400 : Bad Request
        - 401 : Unauthorized
        - 404 : Resource Not Found
        - 500 : Internal Server Error

    """
    return self.server._request("DELETE",self._get_profile_url(job_group))

getDiscoveryUseCases()

Retrieves the hierarchical tree of Discovery Use Cases.

This is useful for building a UI or identifying the correct 'name' for specific discovery categories.

Returns:

Type Description
Response

A JSON array of use-case objects containing 'name', 'checked', 'display', and 'children' (recursive).
Source code in ucmdb_rest\discovery.py 
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
def getDiscoveryUseCases(self):
    """
    Retrieves the hierarchical tree of Discovery Use Cases.

    This is useful for building a UI or identifying the correct 
    'name' for specific discovery categories.

    Returns
    -------
    requests.Response
        A JSON array of use-case objects containing 'name', 'checked', 
        'display', and 'children' (recursive).
    """
    url = '/discovery/discoverymetadata/usecases'
    return self.server._request("GET",url)

getIPRange()

Retrieves IP range profiles from the UCMDB server.

This method makes a GET request to the UCMDB server to retrieve IP range profiles.

Returns:

Type Description
Response

Response object containing the IP range profiles.
Summary of Output

The output represents a list of items, each describing a location or group of IP range profiles. Each item contains the following information:

  • Name: The name of the location or group.
  • ID: Unique identifier for the location or group.
  • Type: Type of the location or group.
  • OOB: Indicates if the location or group is Out Of Band (OOB).
  • Ranges: List of IP range profiles associated with the location or group. Each range contains information about the domain name, cluster name, probe name, and IP ranges.
  • RangeCount: Total number of IP range profiles within the location or group.
  • IPAddressCount: Total number of IP addresses covered by the IP range profiles within the location or group.
Source code in ucmdb_rest\discovery.py 
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
def getIPRange(self):
    """
    Retrieves IP range profiles from the UCMDB server.

    This method makes a GET request to the UCMDB server to retrieve IP 
    range profiles.

    Returns
    -------
    requests.Response
        Response object containing the IP range profiles.

    Summary of Output
    -----------------
    The output represents a list of items, each describing a location or 
    group of IP range profiles. Each item contains the following 
    information:

    - Name: The name of the location or group.
    - ID: Unique identifier for the location or group.
    - Type: Type of the location or group.
    - OOB: Indicates if the location or group is Out Of Band (OOB).
    - Ranges: List of IP range profiles associated with the location or 
      group. Each range contains information about the domain name, 
      cluster name, probe name, and IP ranges.
    - RangeCount: Total number of IP range profiles within the location 
      or group.
    - IPAddressCount: Total number of IP addresses covered by the IP 
      range profiles within the location or group.

    """
    url = '/discovery/iprangeprofiles'
    return self.server._request("GET",url)

getIPRangeForIP(ipaddr)

Retrieves IP range profiles associated with a specific IP address from the UCMDB server.

This method makes a GET request to the UCMDB server to retrieve IP range profiles associated with a specific IP address.

Parameters:

Name Type Description Default
ipaddr str

IP address for which to retrieve IP range profiles.

 required

Returns:

Type Description
Response

Response object containing the IP range profiles associated with the specified IP address.
Source code in ucmdb_rest\discovery.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def getIPRangeForIP(self, ipaddr):
    """
    Retrieves IP range profiles associated with a specific IP address 
    from the UCMDB server.

    This method makes a GET request to the UCMDB server to retrieve IP 
    range profiles associated with a specific IP address.

    Parameters
    ----------
    ipaddr : str
        IP address for which to retrieve IP range profiles.

    Returns
    -------
    requests.Response
        Response object containing the IP range profiles associated 
        with the specified IP address.

    """
    url = f'/discovery/iprangeprofiles?ipaddress={ipaddr}'
    return self.server._request("GET",url)

getJobGroup(fields='')

Retrieves a structure of jobs groups discovery.

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

Parameters:

Name Type Description Default
fields list of str

A comma separated list of strings E.g. name,id.

 ''

Returns:

Type Description
Response

A dictionary with a list of dictionaries. Each subdictionary in the list contains a response representing a job group for discovery. The structure includes: - name: The name of the discovery job group. - id: The id of the job group. - type: CMS. - oob: false. - description: The description of the discovery job group in the UI. - discoveryType: usually null. - jobs: A list of dictionaries representing the job. - jobName: The name of the discovery job included. - jobDisplayName: The display name of the discovery job. - adapterName: The name of the adapter the job is based on. - inputCi: The input CI for the job. - protocols: A list of protocols used by this job. - jobParameters: A dictionary of parameter:value. - triggerQueries: A list of the trigger queries. - jobInvokeOnNewTrigger: true/false. Does the job execute on new triggers immediately or wait until the next scheduled invocation.
Example

Example Output: { "items": [ { "name": "HRA", "id": "HRA", "type": "CMS", "oob": false, "description": null, "discoveryType": null, "jobs": [ { "jobName": "Host Connection by Shell", "jobDisplayName": "Host Connection by Shell", "adapterName": "Host_Connection_By_Shell", "inputCI": "ip_address", "jobType": "DynamicService", "protocols": [ "ntadminprotocol", "sshprotocol", "telnetprotocol", "udaprotocol", "powercmdprotocol" ], "jobParameters": {}, "triggerQueries": [], "jobInvokeOnNewTrigger": true }, { "jobName": "Range IPs by ICMP", "jobDisplayName": "Range IPs by ICMP", "adapterName": "ICMP_NET_Dis_IpRange", "inputCI": "discoveryprobegateway", "jobType": "DynamicService", "protocols": [], "jobParameters": {}, "triggerQueries": [], "jobInvokeOnNewTrigger": true } ] } ] }

Source code in ucmdb_rest\discovery.py 
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
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
def getJobGroup(self, fields =''):
    """
    Retrieves a structure of jobs groups discovery.

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

    Parameters
    ----------
    fields : list of str, optional
        A comma separated list of strings E.g. name,id.

    Returns
    -------
    requests.Response
        A dictionary with a list of dictionaries. Each 
        subdictionary in the list contains a response representing 
        a job group for discovery. The structure includes:
        - name: The name of the discovery job group.
        - id: The id of the job group.
        - type: CMS.
        - oob: false.
        - description: The description of the discovery job group in 
          the UI.
        - discoveryType: usually null.
        - jobs: A list of dictionaries representing the job.
            - jobName: The name of the discovery job included.
            - jobDisplayName: The display name of the discovery job.
            - adapterName: The name of the adapter the job is based on.
            - inputCi: The input CI for the job.
            - protocols: A list of protocols used by this job.
            - jobParameters: A dictionary of parameter:value.
            - triggerQueries: A list of the trigger queries.
            - jobInvokeOnNewTrigger: true/false. Does the job 
              execute on new triggers immediately or wait until the 
              next scheduled invocation.

    Example
    -------
    Example Output:
    {
      "items": [
        {
          "name": "HRA",
          "id": "HRA",
          "type": "CMS",
          "oob": false,
          "description": null,
          "discoveryType": null,
          "jobs": [
            {
              "jobName": "Host Connection by Shell",
              "jobDisplayName": "Host Connection by Shell",
              "adapterName": "Host_Connection_By_Shell",
              "inputCI": "ip_address",
              "jobType": "DynamicService",
              "protocols": [
                "ntadminprotocol",
                "sshprotocol",
                "telnetprotocol",
                "udaprotocol",
                "powercmdprotocol"
              ],
              "jobParameters": {},
              "triggerQueries": [],
              "jobInvokeOnNewTrigger": true
            },
            {
              "jobName": "Range IPs by ICMP",
              "jobDisplayName": "Range IPs by ICMP",
              "adapterName": "ICMP_NET_Dis_IpRange",
              "inputCI": "discoveryprobegateway",
              "jobType": "DynamicService",
              "protocols": [],
              "jobParameters": {},
              "triggerQueries": [],
              "jobInvokeOnNewTrigger": true
            }
          ]
        }
      ]
    }
    """
    if not fields:
        url = self._get_profile_url()
    else:
        url = f'{self._get_profile_url()}?fields={quote(fields)}'
    return self.server._request("GET",url)

getJobMetaData()

Retrieves a structure of jobs for discovery.

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

Returns:

Type Description
Response

A dictionary with a list of dictionaries. Each subdictionary in the list contains response representing a job for discovery. The structure includes: - name: The name of the discovery job. - id: The id of the job. - type: usually null. - oob: usually null. - jobDisplayName: The name of the discovery job in the UI. - adapterName: The name of the adapter for this discovery job. - tags: A list of tags for the job. - dependOnJobs: A list of jobs this one is dependent upon. - moduleName: The name of the containing module. - jobType: DynamicService or Workflow. - inputCi: The input CI for the job. - outputCis: The CIs created by this job. - flat: boolean flag (all ootb are set to false). - protocols: A list of protocols used by this job. - discoveryType: BASIC, ADVANCED or sometimes null for what kind of license is used consumed as a result of this job. - inputCiDisplayName: Display name of the input CI. - outputCiDisplayName: A list containing the display name of the output CIs. - protocolsDisplayName: A list containing the protocols display labels.
Example

Example Output: { "items": [ { "name": "A10 vThunder by SNMP", "id": "A10 vThunder by SNMP", "type": null, "oob": null, "jobDisplayName": "A10 vThunder by SNMP", "adapterName": "A10_vThunder_by_SNMP", "tags": [ "Load Balancer" ], "dependOnJobs": [ "Host Connection by SNMP" ], "moduleName": "A10 vThunder", "jobType": "DynamicService", "inputCi": "snmp", "outputCis": [ "a10_vthunder", "composition", "configuration_document", "containment", "ip_address", "ip_service_endpoint", "lb", "loadbalancecluster", "membership", "node", "ownership" ], "flat": false, "protocols": [ "snmpprotocol" ], "discoveryType": "ADVANCED", "inputCiDisplayName": "SNMP", "outputCiDisplayName": [ "A10 vThunder", "Composition", "ConfigurationDocument", "Containment", "IpAddress", "IpServiceEndpoint", "Load Balancer", "Load Balancing Cluster", "Membership", "Node", "Ownership" ], "protocolsDisplayName": [ "SNMP Protocol" ] } ] }

Source code in ucmdb_rest\discovery.py 
272
273
274
275
276
277
278
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
336
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
def getJobMetaData(self):
    """
    Retrieves a structure of jobs for discovery.

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

    Returns
    -------
    requests.Response
        A dictionary with a list of dictionaries. Each 
        subdictionary in the list contains response representing 
        a job for discovery. The structure includes:
        - name: The name of the discovery job.
        - id: The id of the job.
        - type: usually null.
        - oob: usually null.
        - jobDisplayName: The name of the discovery job in the UI.
        - adapterName: The name of the adapter for this discovery 
          job.
        - tags: A list of tags for the job.
        - dependOnJobs: A list of jobs this one is dependent upon.
        - moduleName: The name of the containing module.
        - jobType: DynamicService or Workflow.
        - inputCi: The input CI for the job.
        - outputCis: The CIs created by this job.
        - flat: boolean flag (all ootb are set to false).
        - protocols: A list of protocols used by this job.
        - discoveryType: BASIC, ADVANCED or sometimes null for what 
          kind of license is used consumed as a result of this job.
        - inputCiDisplayName: Display name of the input CI.
        - outputCiDisplayName: A list containing the display name of 
          the output CIs.
        - protocolsDisplayName: A list containing the protocols 
          display labels.

    Example
    -------
    Example Output:
    {
      "items": [
        {
          "name": "A10 vThunder by SNMP",
          "id": "A10 vThunder by SNMP",
          "type": null,
          "oob": null,
          "jobDisplayName": "A10 vThunder by SNMP",
          "adapterName": "A10_vThunder_by_SNMP",
          "tags": [
            "Load Balancer"
          ],
          "dependOnJobs": [
            "Host Connection by SNMP"
          ],
          "moduleName": "A10 vThunder",
          "jobType": "DynamicService",
          "inputCi": "snmp",
          "outputCis": [
            "a10_vthunder",
            "composition",
            "configuration_document",
            "containment",
            "ip_address",
            "ip_service_endpoint",
            "lb",
            "loadbalancecluster",
            "membership",
            "node",
            "ownership"
          ],
          "flat": false,
          "protocols": [
            "snmpprotocol"
          ],
          "discoveryType": "ADVANCED",
          "inputCiDisplayName": "SNMP",
          "outputCiDisplayName": [
            "A10 vThunder",
            "Composition",
            "ConfigurationDocument",
            "Containment",
            "IpAddress",
            "IpServiceEndpoint",
            "Load Balancer",
            "Load Balancing Cluster",
            "Membership",
            "Node",
            "Ownership"
          ],
          "protocolsDisplayName": [
            "SNMP Protocol"
          ]
        }
      ]
    }
    """
    url = '/discovery/discoverymetadata/jobmetadata'
    return self.server._request("GET",url)

getModuleTree()

Retrieves a hierarchical structure of modules and jobs for discovery.

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

Returns:

Type Description
Response

A JSON response representing a hierarchical structure of modules and jobs for discovery. The structure includes: - name: The name of the use case. - path: The path of the current folder. - children: A list of dictionaries containing recursive directories and modules. - jobs: At the bottom level, a list of jobs in a given path.
Example

Example Output: { "name": "Discovery Modules", "path": "full path", "children": [ { "name": "Middleware", "path": "Middleware\Web Services\UDDI Registry", "children": [ { "name": "Web Services", "path": "Middleware\Web Services\UDDI Registry", "children": [ { "name": "UDDI Registry", "path": "Middleware\Web Services\UDDI Registry", "children": [], "jobs": [ "Webservices by UDDI Registry", "Webservice Connections by UDDI Registry", "WebServices by URL" ] } ], "jobs": null } ] } ] }

Source code in ucmdb_rest\discovery.py 
371
372
373
374
375
376
377
378
379
380
381
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
417
418
419
420
421
422
423
def getModuleTree(self):
    """
    Retrieves a hierarchical structure of modules and jobs for discovery.

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

    Returns
    -------
    requests.Response
        A JSON response representing a hierarchical structure of modules 
        and jobs for discovery. The structure includes:
        - name: The name of the use case.
        - path: The path of the current folder.
        - children: A list of dictionaries containing recursive directories 
                    and modules.
        - jobs: At the bottom level, a list of jobs in a given path.

    Example
    -------
    Example Output:
    {
      "name": "Discovery Modules",
      "path": "full path",
      "children": [
        {
          "name": "Middleware",
          "path": "Middleware\\\\Web Services\\\\UDDI Registry",
          "children": [
            {
              "name": "Web Services",
              "path": "Middleware\\\\Web Services\\\\UDDI Registry",
              "children": [
                {
                  "name": "UDDI Registry",
                  "path": "Middleware\\\\Web Services\\\\UDDI Registry",
                  "children": [],
                  "jobs": [
                    "Webservices by UDDI Registry",
                    "Webservice Connections by UDDI Registry",
                    "WebServices by URL"
                  ]
                }
              ],
              "jobs": null
            }
          ]
        }
      ]
    }
    """
    url = '/discovery/discoverymetadata/moduletree'
    return self.server._request("GET",url)

getQuestions(job_name)

Retrieves questions for a specific discovery job.

This function makes a GET request to the UCMDB server to retrieve the questions for a specific discovery job.

Parameters:

Name Type Description Default
job_name str

The job name, for example 'Host Connection by Shell'.

 required

Returns:

Type Description
Response

A dictionary object containing the questions for the parameters. Example: { "questions": [ { "questionTextAlt": "Specify the Universal Discovery Protocol connection order", "questionTextL10ID": "QUESTION_HOST_CONNECTION_BY_SHELL_0", "helpID": "", "questionType": "DropDownList", "tag": "", "groupId": "", "groupType": "", "dependency": "", "dependencyCondition": "", "choices": [ { "choiceText": "first", "choiceTextL10Key": "QUESTION_HOST_CONNECTION_BY_SHELL_0_CHOICE_0", "defaultState": "Unchecked", "behavior": "Parameter Change", "mappingToJobs": [], "mappingToParams": { "Host Connection by Shell": { "udaConnectionOrder": "first" } } }, ... ] } ], "jobQuestions": [...] }
Source code in ucmdb_rest\discovery.py 
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
def getQuestions(self, job_name):
    """
    Retrieves questions for a specific discovery job.

    This function makes a GET request to the UCMDB server to 
    retrieve the questions for a specific discovery job.

    Parameters
    ----------
    job_name : str
        The job name, for example 'Host Connection by Shell'.

    Returns
    -------
    requests.Response
        A dictionary object containing the questions for the 
        parameters. Example:
        {
          "questions": [
            {
              "questionTextAlt": 
                  "Specify the Universal Discovery Protocol connection order",
              "questionTextL10ID": 
                  "QUESTION_HOST_CONNECTION_BY_SHELL_0",
              "helpID": "",
              "questionType": "DropDownList",
              "tag": "",
              "groupId": "",
              "groupType": "",
              "dependency": "",
              "dependencyCondition": "",
              "choices": [
                {
                  "choiceText": "first",
                  "choiceTextL10Key": 
                      "QUESTION_HOST_CONNECTION_BY_SHELL_0_CHOICE_0",
                  "defaultState": "Unchecked",
                  "behavior": "Parameter Change",
                  "mappingToJobs": [],
                  "mappingToParams": {
                    "Host Connection by Shell": {
                      "udaConnectionOrder": "first"
                    }
                  }
                },
                ...
              ]
            }
          ],
          "jobQuestions": [...]
        }
    """
    job_name = quote(job_name)
    url = f'/discovery/discoverymeta/tags/questions?jobNames={job_name}'
    return self.server._request("GET",url)

getSchedules()

Retrieves a list of all schedules.

This function makes a GET request to the UCMDB server to retrieve a list of schedules.

Returns:

Type Description
Response

A dictionary object containing the schedules. Example: { "items": [ { "name": "MWF", "id": "MWF", "type": "CMS", "oob": false, "scheduleDetail": { "invocationTime": null, "intervalUnit": null, "interval": null, "invocationHours": [ "17:00" ], "daysOfWeek": [ 2, 4, 6 ], "monthsOfYear": null, "daysOfMonth": null, "cronExpr": null }, "runDuringTimeRange": { "type": "always", "timeRange": null, "alwaysRunBetween": null }, "startTime": null, "endTime": null, "timeZone": null, "scheduleType": "scheduler_cron_Schedule", "cronExpression": "0 0 17 ? * 2 ;0 0 17 ? * 4 ;0 0 17 ? * 6", "offset": null, "generateFrom": "WEEKLY", "templateType": null, "templateSource": null } ] }
Source code in ucmdb_rest\discovery.py 
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
def getSchedules(self):
    """
    Retrieves a list of all schedules.

    This function makes a GET request to the UCMDB server to 
    retrieve a list of schedules.

    Returns
    -------
    requests.Response
        A dictionary object containing the schedules. Example:
        {
          "items": [
            {
              "name": "MWF",
              "id": "MWF",
              "type": "CMS",
              "oob": false,
              "scheduleDetail": {
                "invocationTime": null,
                "intervalUnit": null,
                "interval": null,
                "invocationHours": [
                  "17:00"
                ],
                "daysOfWeek": [
                  2,
                  4,
                  6
                ],
                "monthsOfYear": null,
                "daysOfMonth": null,
                "cronExpr": null
              },
              "runDuringTimeRange": {
                "type": "always",
                "timeRange": null,
                "alwaysRunBetween": null
              },
              "startTime": null,
              "endTime": null,
              "timeZone": null,
              "scheduleType": "scheduler_cron_Schedule",
              "cronExpression": 
                  "0 0 17 ? * 2 ;0 0 17 ? * 4 ;0 0 17 ? * 6",
              "offset": null,
              "generateFrom": "WEEKLY",
              "templateType": null,
              "templateSource": null
            }
          ]
        }
    """
    url = '/discovery/scheduleprofiles'
    return self.server._request("GET",url)

getSpecificJobGroup(job_group)

Retrieves a job group.

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

Parameters:

Name Type Description Default
job_group str

The name of the job group to retrieve.

 required

Returns:

Type Description
Response

A dictionary object containing the job group. Example: { "name": "HRA", "id": "HRA", "type": "CMS", "oob": false, "description": null, "discoveryType": null, "jobs": [ { "jobName": "Host Connection by Shell", "jobDisplayName": "Host Connection by Shell", "adapterName": "Host_Connection_By_Shell", "inputCI": "ip_address", "jobType": "DynamicService", "protocols": [ "ntadminprotocol", "sshprotocol", "telnetprotocol", "udaprotocol", "powercmdprotocol" ], "jobParameters": {}, "triggerQueries": [], "jobInvokeOnNewTrigger": true }, { "jobName": "Range IPs by ICMP", "jobDisplayName": "Range IPs by ICMP", "adapterName": "ICMP_NET_Dis_IpRange", "inputCI": "discoveryprobegateway", "jobType": "DynamicService", "protocols": [], "jobParameters": {}, "triggerQueries": [], "jobInvokeOnNewTrigger": true } ] }
Source code in ucmdb_rest\discovery.py 
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
def getSpecificJobGroup(self, job_group):
    """
    Retrieves a job group.

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

    Parameters
    ----------
    job_group : str
        The name of the job group to retrieve.

    Returns
    -------
    requests.Response
        A dictionary object containing the job group. Example:
        {
          "name": "HRA",
          "id": "HRA",
          "type": "CMS",
          "oob": false,
          "description": null,
          "discoveryType": null,
          "jobs": [
            {
              "jobName": "Host Connection by Shell",
              "jobDisplayName": "Host Connection by Shell",
              "adapterName": "Host_Connection_By_Shell",
              "inputCI": "ip_address",
              "jobType": "DynamicService",
              "protocols": [
                "ntadminprotocol",
                "sshprotocol",
                "telnetprotocol",
                "udaprotocol",
                "powercmdprotocol"
              ],
              "jobParameters": {},
              "triggerQueries": [],
              "jobInvokeOnNewTrigger": true
            },
            {
              "jobName": "Range IPs by ICMP",
              "jobDisplayName": "Range IPs by ICMP",
              "adapterName": "ICMP_NET_Dis_IpRange",
              "inputCI": "discoveryprobegateway",
              "jobType": "DynamicService",
              "protocols": [],
              "jobParameters": {},
              "triggerQueries": [],
              "jobInvokeOnNewTrigger": true
            }
          ]
        }
    """
    return self.server._request("GET",self._get_profile_url(job_group))