Summary:
List settings and status of IPAM, modify the settings, and manually start a scan of IPAM networks.
URL:
http(s)://{server hostname}/api/ipam
Methods summary
- GET Method - returns settings and status of IPAM.
- PUT Method - modifies IPAM settings.
- POST Method - manually starts a scan of IPAM networks.
GET Method detail
Returns information about IPAM settings and status.
Response:
| Name | Description |
|---|---|
| historyExpiry | number of days before history entries are removed from the IP History table. Must be an integer between 1 and 14, by default 7. |
| usageEvents | if usage % events are enabled, either 'true' or 'false'. |
| usageMedium | % threshold above which the network usage bar in the Networks table will turn yellow. Must be between 1 and 100, by default 50. |
| scanPeriodHours | number of hours betwen scheduled Ping, Reverse DNS, and ARP scans. Must be an integer between 1 and 24, by default 2. |
| usageHigh | % threshold above which the network usage bar in the Networks table will turn yellow. Must be between 1 and 100. |
| maxScannableLength |
maximum number of IP addresses in a range that a single network can cover, if scanning is enabled, one of the following:
|
| dhcpConflictEvents | if DHCP Conflict Events are enabled, either 'true' or 'false'. |
| dhcpScanPeriodHours | number of hours between scheduled DHCP server scans. Must be an integer between 2 and 48, by default 4. |
| activeTimeframeHours | imeframe (in hours) in which a successful scan of an IP address should fall to be considered active, by default 12. I.e., if an IP address was last successfully scanned within the last 12 hours, then the IP address is considered active. Must be an integer between 2 and 72, and must be greater than both scanPeriodHours and dchpScanPeriodHours. |
Example:
INPUT
curl -u admin:admin https://localhost/api/ipam?media=json
OUTPUT
[
[ "Store: OK", "Service: OK", "Scanner: No scans running", "Scheduler: Running - Network Scan in 01:56:49, DHCP Scan in 03:56:49, Expire clean in 01:26:49" ],
{
"historyExpiry" : 7,
"usageEvents" : true,
"usageMedium" : 50,
"scanPeriodHours" : 2,
"usageHigh" : 80,
"maxScannableLength" : 6,
"dhcpConflictEvents" : true,
"dhcpScanPeriodHours" : 4,
"activeTimeframeHours" : 12
}
]
PUT Method detail
Modifies IPAM settings.
Request:
Same as the 'GET Method - Response' above.
Response:
Updated IPAM settings.
Example:
INPUT
curl -u admin:admin https://localhost/api/ipam?media=json -X PUT -H "content-type:application/json" -d \
'{
"historyExpiry" : 10,
"usageEvents" : true,
"usageMedium" : 50,
"scanPeriodHours" : 2,
"usageHigh" : 80,
"maxScannableLength" : 6,
"dhcpConflictEvents" : true,
"dhcpScanPeriodHours" : 4,
"activeTimeframeHours" : 12
}'
OUTPUT
[
[ "Store: OK", "Service: OK", "Scanner: No scans running", "Scheduler: Running - Network Scan in 01:56:49, DHCP Scan in 03:56:49, Expire clean in 01:26:49" ],
{
"historyExpiry" : 10,
"usageEvents" : true,
"usageMedium" : 50,
"scanPeriodHours" : 2,
"usageHigh" : 80,
"maxScannableLength" : 6,
"dhcpConflictEvents" : true,
"dhcpScanPeriodHours" : 4,
"activeTimeframeHours" : 12
}
]
POST Method detail
Manually starts a scan of IPAM networks.
Response:
"OK" if successful.
Example:
INPUT
curl -u admin:admin https://localhost/api/ipam?media=json -X POST -H "content-type:application/json"
OUTPUT
{
"message" : "OK"
}
Comments
0 comments
Please sign in to leave a comment.