Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Create an On-Demand Device Snapshot

 

Use this API to generate a device snapshot without having to wait for receiving one from the device.

URI

https://[host]/api/juniper/servicenow/device-management/devices/ createOnDemandDeviceSnapshot?queue=https://[host]/api/hornet-q/queues/ jms.queue.[QueueName](HTTP method = POST)

URI Parameters

Parameter

Type

Required

Description

QueueName

String

Yes

Name of the create on-demand device snapshot job queue

Consumes

  • application/vnd.juniper.servicenow.device-management. ondemanddevicesnapshot+xml;version=1;charset=UTF-8

  • application/vnd.juniper.servicenow.device-management. ondemanddevicesnapshot +json;version=1;charset=UTF-8

Request Elements

Element

Type

Description

device

String

Link to the device for which device snapshot should be created

uploadIJMB

Boolean

Flag to indicate whether this on-demand device snapshot files should be uploaded to JSS or not

Possible values:

  • true—The on-demand device snapshot files are uploaded to JSS.

  • false—The on-demand device snapshot files are not uploaded to JSS.

verifyCPUUsage

Boolean

Flag to indicate whether or not usage of device CPU must be verified while generating this on-demand incident

Possible values:

  • true—CPU usage is verified

  • false—CPU usage is not verified

Produces

  • application/vnd.juniper.servicenow.device-management.device+json;version=1

  • application/vnd.juniper.servicenow.device-management.device+xml;version=1

Response Elements

Element

Type

Description

href

String

Link to the create on-demand device snapshot job

id

Integer

ID of the create on-demand device snapshot job

Sample Input

Sample XML Input

Sample JSON Input

Sample Output

Sample XML Output

Sample JSON Output

Error Codes

Message

Description

400 Bad Request

  • Cannot create on-demand device snapshot if more than five devices are selected.

  • The device is not associated with any device group.

  • The device Is an end-customer device.

  • The device Is a fabric node (TOR).

  • The device Is a DCF device.

  • The follow-up method specified in the request is invalid.

  • The priority specified in the request is invalid.

  • The e-mail ID specified in the request is invalid.

404 Not Found

The device specified in the request is not a valid Service Now device.