Page History

...

utilization

URL /api/v1/api.php?target=ipam&action=utilization

Description Gets the utilization percentages for a specific ip block or ip block and mask combination.

Example URLs https://ops.6connect.com/qa-4.1/api/v1/api.php?target=ipam&action=aggregate&id=23131

Returns

Examples:

SUCCESSFUL	`{"success":1,"message":"` ","totalHosts":"88","hostsAssigned":"16","hostsAvailable":"72","availablePercentage":81.8,"assignedPercentage":18.2,"allocatedPercentage":18.2,"totalBlocks":11,"blocksAssigned":2,"blocksAvailable":9 `10.2.0.128\/25 aggregated into 10.2.0.0\/24","id":16326}`
ERROR	{'success':0, 'message':'error message'}

Required Parameters

Name	Type	Example	Description
id	int	125	ID of the IP block.

Optional Parameters

Name	Type	Example	Description
mask	int	24	The specific mask size to retrieve utilization for. If using this parameter, the id parameter should be the id of the aggregate.

aggregate

URL

/api/v1/api.php?target=ipam&action=aggregate

Description

Aggregates a selected block to the mask specified. If no mask specified, re-aggregates blocks to next parent. IE. calling aggregate on a /25 will aggregate both children back to the parent /24. All child blocks must be Available for aggregation to succeed.

Returns

Examples:

SUCCESSFUL	{"success":1,"message":"","totalHosts":"88","hostsAssigned":"16","hostsAvailable":"72","availablePercentage":81.8,"assignedPercentage":18.2,"allocatedPercentage":18.2,"totalBlocks":11,"blocksAssigned":2,"blocksAvailable":9}
ERROR	{'success':0, 'message':'error message'}

Required Parameters

Name	Type	Example	Description
id	int	125	ID of the IP block.

Optional Parameters

Name	Type	Example	Description
mask	int	24	Auto aggregate the block back to this mask size. Note all blocks up this mask size must be Available or the call will fail.
block*	STRING	213.37.29.0/24	CIDR block. Only the block id OR the block CIDR can be specified. Not both.

Page tree

Versions Compared

Old Version 6

New Version 7

Key