Configure Advanced Parameter Settings
Use this API to configure AI-Scripts on a device by using Service Now GUI.
URI
https://[host]/api/juniper/servicenow/device-management/devices/ configureAdvancedParamsSettings?queue=https://[host]/api/ hornet-q/queues/jms.queue.testdee (HTTP method = POST)
URI Parameters
None
Consumes
application/vnd.juniper.servicenow.device-management.configureadvancedparams+ xml;version=1;charset=UTF-8
application/vnd.juniper.servicenow.device-management.configureadvancedparams+ json;version=1;charset=UTF-8
Request Elements
Element | Type | Description |
|---|---|---|
advancedParametersSettings | advancedParametersSettings | advancedParametersSettings object |
devices | device | Collection of devices on which AI-Scripts should be configured |
device | device | A device on which AI-Scripts should be configured |
uri | String | URI of the device on which AI-Scripts should be configured |
jmbCleanupAgeInDays | Integer | Number of days from this list after which AI-Scripts should delete JMBs from the device. |
deviceSnapshotCollectionDOW | Integer | Day of the week from this list when AI-Scripts should execute scripts for collecting device snapshot from the devic |
deviceSnapshotCollectionTOD | Integer | Time of the day from this list when AI-Scripts should execute scripts for collecting device snapshot from the device. |
collectLogsFromAllNodes | Boolean | Specifies whether system log files should be collected from all devices. Possible values:
|
maxSimultaneouslyProcessedEventsOnBox | Integer | Number of events that AI-Scripts can process when multiple events occur on the device at the same time |
thresholdDiskUsagePercentForWarnMessage | Integer | Percentage of disk used beyond which AI-Scripts should log a warning message indicating that the disk usage has reached the specified threshold |
thresholdDiskUsagePercentForDataDampening | Integer | Percentage of disk used after which AI-Scripts should not generate JMBs when one or more events occur on the device |
applyToAllDevices | Boolean | Specifies if the AI-Scripts configuration should be applied to all managed devices Possible values:
|
domainId | Integer | ID to which the device belongs |
Produces
application/vnd.juniper.servicenow.device-management.device+xml;version=1
application/vnd.juniper.servicenow.device-management.device+json;version=1
Sample Input
Sample XML Input
<advancedParametersSettings> <devices> <device uri="/api/juniper/servicenow/device-management/devices/34959"/> </devices> <jmbCleanupAgeInDays>4</jmbCleanupAgeInDays> <deviceSnapshotCollectionDOW>Monday</deviceSnapshotCollectionDOW> <deviceSnapshotCollectionTOD>12:01 am</deviceSnapshotCollectionTOD> <collectLogsFromAllNodes>1</collectLogsFromAllNodes> <maxSimultaneouslyProcessedEventsOnBox>11</maxSimultaneouslyProcessedEventsOnBox> <thresholdDiskUsagePercentForWarnMessage>70</thresholdDiskUsagePercentForWarnMessage> <thresholdDiskUsagePercentForDataDampening>80</thresholdDiskUsagePercentForDataDampening> <applyToAllDevices>false</applyToAllDevices> <domainId>2</domainId> </advancedParametersSettings>
Sample JSON Input
{
"advancedParametersSettings": {
"devices": {
"device": {
"@href": "/api/juniper/servicenow/device-management/devices/34951"
}
},
"jmbCleanupAgeInDays": "4",
"deviceSnapshotCollectionDOW": "Monday",
"deviceSnapshotCollectionTOD": "12:01 am",
"collectLogsFromAllNodes": "1",
"maxSimultaneouslyProcessedEventsOnBox": "11",
"thresholdDiskUsagePercentForWarnMessage": "70",
"thresholdDiskUsagePercentForDataDampening": "80",
"applyToAllDevices": "false",
"domainId": "2"
}
}