Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get All PHDCs

 

Use this API to retrieve all product health data collection (PHDC) configurations present in Junos Space Service Now.

URI

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

Consumes

None

Produces

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

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

Response Elements

Element

Type

Description

uri

String

Link to the PHDC configuration collection

size

Integer

Number of records in the PHDC collection

PHDC

PHDC

A PHDC configuration

key

Integer

ID of the PHDC configuration

href

String

Link to a PHDC configuration

domainId

Integer

ID of the domain to which the PHDC configuration belongs

domainName

String

Name of the domain to which the PHDC configuration belongs

name

String

Name of the PHDC configuration

startTime

String

Date and time configured in the PHDC configuration to start collecting product health data (PHD) from devices

endTime

String

Date and time configured in the PHDC configuration to end collecting product health data (PHD) from devices

lastModifiedTime

String

Date and time the PHDC configuraiton was last modified

status

String

Status of the PHDC configuration

Possible values:

  • Scheduled—PHD is scheduled to be collected from all the managed devices assigned to the PHDC configuration at the scheduled time.

  • Starting—PHD collection is starting on all the devices included in the PHDC configuration.

  • Running—PHD is currently being collected from all the devices included in the configuration.

  • Stopping—PHD collection is currently being stopped from one or more devices included in the configuration.

  • Completed—PHD collection is complete on all devices included in the configuration.

  • Aborting—PHD collection is being aborted from all devices included in the configuration.

  • Failed—PHD collection failed to be start on all devices, stop or aborted in one or more devices included in the configuration.

  • Aborted—PHD collection is aborted on all the devices included in the configuration.

devicesCount

Integer

Number of devices included in the PHDC configuration

createdBy

String

Username of user who configured the PHDC configuration

domainId

Integer

ID of the domain to which a PHDC is assigned

Sample Output

Sample XML Output

Sample JSON Output

Related Documentation