Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get All Devices in a PHDC Configuration

 

Use this API to retrieve all devices assigned to a product health data collection (PHDC) configuration.

URI

https://[host]/api/juniper/servicenow/phdc-management/phdcs/{phdcId} /phdDeviceConfigurations (HTTP method = GET)

URI Parameters

Parameter

Type

Required

Description

phdcId

Integer

Yes

ID of the PHDC configuration from which device details are to be retrieved

Consumes

None

Produces

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

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

Response Elements

Element

Type

Description

uri

String

URI of the collection of devices assigned to a PHDC configuration

method

String

Method applicable to devices assigned to a PHDC configuration

phdDeviceConfiguration

phdDeviceConfiguration

Device assigned to a PHDC configuration

key

Integer

ID of the device

domainName

String

Name of the domain to which the device belongs

deviceName

String

Name of the device from which PHD is collected

serialNumber

String

Serial number of the device

status

String

Status of PHDC on devices

Possible values:

  • Scheduled—PHD collection is scheduled to run on the device at a specified time.

  • Starting—PHD collection is starting on the device.

  • Failed—PHD collection failed to start on the device.

  • Running—PHD is collected from the device.

  • Stopping—PHD collection is currently being stopped on the device.

  • Stopped—PHD collection is stopped on the device.

  • Enabling—PHD collection is enabled on the device after being disabled.

  • Disabling—PHD collection is disabled on the device.

  • Aborting—PHD collection is currently being aborted on the device.

availableFilesCount

Integer

Number of PHD files collected from the device

startTime

String

Date and time when PHDC was started on the device

Sample Output

Sample XML Output

Sample JSON Output