Skip to content

Management Zones

ucmdb_rest.management_zone.ManagementZones(server)

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

Source code in ucmdb_rest\management_zone.py 
16
17
18
19
20
21
def __init__(self, server):
    """
    Initialize the service with a reference to the main level UCMDB server
    """
    self.server = server
    self.base_path = '/discovery/managementzones'

activateZone(zone_id)

Activates a management zone on the UCMDB server.

This method makes a PATCH request to the UCMDB server to activate a specific management zone.

Parameters:

zone_id : str The ID of the management zone to activate.

Returns:

requests.Response Response object confirming the activation of the management zone.

Source code in ucmdb_rest\management_zone.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def activateZone(self, zone_id):
    """
    Activates a management zone on the UCMDB server.

    This method makes a PATCH request to the UCMDB server to activate a specific
    management zone.

    Parameters:
    -----------
    zone_id : str
        The ID of the management zone to activate.

    Returns:
    --------
    requests.Response
        Response object confirming the activation of the management zone.

    """
    url = f'{self._get_url(zone_id)}?operation=activate'
    return self.server._request("PATCH",url)

createManagementZone(mgmtZone)

Creates a new management zone on the UCMDB server.

This method makes a POST request to the UCMDB server to create a new management zone.

Parameters:

Name Type Description Default
mgmtZone dict

Dictionary containing the details of the management zone to be created. Example: { "name": "Zone Via REST-API", "activated": False, "ipRangeProfiles": [ { "ipRangeProfileId": "All IP Range Groups" } ], "discoveryActivities": [ { "discoveryProfileId": "Added Thru REST-API", "scheduleProfileId": "Interval 1 Day (Default)", "credentialProfileId": "All Credentials" } ] }

 required

Returns:

Type Description
Response

Response object confirming the creation of the management zone.
Source code in ucmdb_rest\management_zone.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def createManagementZone(self, mgmtZone):
    """
    Creates a new management zone on the UCMDB server.

    This method makes a POST request to the UCMDB server to create a 
    new management zone.

    Parameters
    ----------
    mgmtZone : dict
        Dictionary containing the details of the management zone to be 
        created.
        Example:
        {
            "name": "Zone Via REST-API",
            "activated": False,
            "ipRangeProfiles": [
                {
                    "ipRangeProfileId": "All IP Range Groups"
                }
            ],
            "discoveryActivities": [
                {
                    "discoveryProfileId": "Added Thru REST-API",
                    "scheduleProfileId": "Interval 1 Day (Default)",
                    "credentialProfileId": "All Credentials"
                }
            ]
        }

    Returns
    -------
    requests.Response
        Response object confirming the creation of the management zone.
    """
    return self.server._request("POST",self._get_url(), json=mgmtZone)

deleteManagementZone(zone_id)

Deletes a management zone from the UCMDB server.

This method makes a DELETE request to the UCMDB server to delete a specific management zone.

Parameters:

zone_id : str The ID of the management zone to delete.

Returns:

requests.Response Response object confirming the deletion of the management zone.

Source code in ucmdb_rest\management_zone.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def deleteManagementZone(self, zone_id):
    """
    Deletes a management zone from the UCMDB server.

    This method makes a DELETE request to the UCMDB server to delete a specific
    management zone.

    Parameters:
    -----------
    zone_id : str
        The ID of the management zone to delete.

    Returns:
    --------
    requests.Response
        Response object confirming the deletion of the management zone.
    """
    return self.server._request("DELETE",self._get_url(zone_id))

getMgmtZone()

Retrieves management zone details from the UCMDB server.

This method makes a GET request to the UCMDB server to retrieve management zone details.

Returns:

requests.Response The response contains a dictionary of items, the items are a list of dictionaries including: - name : String - The name of the management zone - activated : Boolean - Is the zone active? - ipRangeProfiles : A list of dictionaries containing the id - discoveryActivities : A list of dictionaries with: - discoveryProfileId : String - Name of the acitivity - scheduleProfileId : String - Name of the interval - credentialProfileId : String - Name of the credentials - id : String - Zone name - description : String - Description of the discovery - triggerSummary : Dictionary - A list of trigger statuses

Source code in ucmdb_rest\management_zone.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def getMgmtZone(self):
    """
    Retrieves management zone details from the UCMDB server.

    This method makes a GET request to the UCMDB server to retrieve management
    zone details.

    Returns:
    --------
    requests.Response
        The response contains a dictionary of items, the items are a list of
        dictionaries including:
            - name : String - The name of the management zone
            - activated :  Boolean - Is the zone active?
            - ipRangeProfiles : A list of dictionaries containing the id
            - discoveryActivities : A list of dictionaries with:
                - discoveryProfileId : String - Name of the acitivity
                - scheduleProfileId : String - Name of the interval
                - credentialProfileId : String - Name of the credentials
            - id : String - Zone name
            - description : String - Description of the discovery
            - triggerSummary : Dictionary - A list of trigger statuses

    """
    return self.server._request("GET",self._get_url())

getSpecificMgmtZone(zone_id)

Retrieves a specific management zone from the UCMDB server.

This method makes a GET request to the UCMDB server to retrieve a specific management zone.

Parameters:

zone_id : str The ID of the management zone to retrieve.

Returns:

requests.Response The return is a list of dictionaries with a single entry, 'items' Items contains a list of dictionaries - name : str - Activated: bool - IP Range Profiles: list of dicts - Discovery Activities: list of dicts - Discovery Profile: str - Schedule Profile: str - Credential Profile: str - ID: str - Trigger Summary: dict - Total Count: int - Pending Count: int - In Progress Count: int - Success Count: int - Warning Count: int - Error Count: int - Result CI Count: int - Active Jobs: dict - ASMish: list of str

Source code in ucmdb_rest\management_zone.py 
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
166
167
168
169
def getSpecificMgmtZone(self, zone_id):
    """
    Retrieves a specific management zone from the UCMDB server.

    This method makes a GET request to the UCMDB server to retrieve a specific
    management zone.

    Parameters:
    -----------
    zone_id : str
        The ID of the management zone to retrieve.

    Returns:
    --------
    requests.Response
        The return is a list of dictionaries with a single entry, 'items'
        Items contains a list of dictionaries
            - name : str
            - Activated: bool
            - IP Range Profiles: list of dicts
            - Discovery Activities: list of dicts
                - Discovery Profile: str
                - Schedule Profile: str
                - Credential Profile: str
            - ID: str
            - Trigger Summary: dict
                - Total Count: int
                - Pending Count: int
                - In Progress Count: int
                - Success Count: int
                - Warning Count: int
                - Error Count: int
            - Result CI Count: int
            - Active Jobs: dict
                - ASMish: list of str

    """
    return self.server._request("GET",self._get_url(zone_id))

getStatisticsForZone(zone_id)

Retrieves real-time discovery statistics for a specific management zone.

Parameters:

Name Type Description Default
zone_id str

The unique ID or Name of the management zone.

 required

Returns:

Type Description
Response

Contains trigger summaries (Success, Warning, Error, In Progress) and the total count of discovered CIs.
Source code in ucmdb_rest\management_zone.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
def getStatisticsForZone(self, zone_id):
    """
    Retrieves real-time discovery statistics for a specific management zone.

    Parameters
    ----------
    zone_id : str
        The unique ID or Name of the management zone.

    Returns
    -------
    requests.Response
        Contains trigger summaries (Success, Warning, Error, In Progress) 
        and the total count of discovered CIs.
    """
    # This uses a different base (/discovery/results/statistics), so we build it manually
    url = f'/discovery/results/statistics?mzoneId={quote(zone_id)}'
    return self.server._request("GET",url)