Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get Details of a PHDC Configuration

 

Use this API to retrieve a specific product health data collection (PHDC) configuration.

URI

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

URI Parameters

Parameter

Type

Required

Description

id

Integer

Yes

ID of the PHDC configuration to be retrieved

Consumes

None

Produces

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

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

Response Elements

Element

Type

Description

uri

String

URI of the 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

id

Integer

ID of the PHDC configuration

method

String

Methods applicable to the PHDC configuration

name

String

Name of the PHDC configuration

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

String

Number of devices in the PHDC configuration

collectionPeriodInDays

String

Number of days configured for collecting product health data (PHD) from devices

uploadPHDFile

Boolean

Flag to upload PHD file to Juniper Support System (JSS)

Possible Values:

  • true—Service Now uploads PHD files to JSS.

  • false—Service Now does not upload PHD files to JSS.

deletePHDFileAfterUpload

Boolean

Flag to delete PHD files affter upload to JSS

Possible Values:

  • true—Service Now deletes PHD files from database after upload to JSS.

  • false—Service Now does not delete PHD files after upload to JSS.

maskIPAddress

Boolean

Flag to mask IP addresses in PHD files.

  • true—IP addresses are masked with asterisk in PHD files.

  • false—IP addresses are not masked with asterisk in PHD files.

startTime

String

Date and time PHD collection started from devices included in the PHDC configuration

endTime

String

Date and time PHD collection ended on devices included in the PHDC configuration

lastModifiedTime

String

Date and time the PHDC configuration was last modifiied

createdBy

String

Username of user who configured the PHDC

domainId

Integer

ID of the domain to which the PHDC configuration is assigned

Sample Output

Sample XML Output

Sample JSON Output

Related Documentation