Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Create a PHDC Configuration

 

Use this API to configure product health data collection (PHDC) in Junos Space Service Now.

URI

https://[host] /api/juniper/servicenow/phd-management/phdcs/configure (HTTP method = POST)

Consumes

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

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

Request Elements

Element

Type

Description

configuration

configuration

A PHDC configuration

name

String

Name of PHDC configuration

collectionPeriodInDays

String

Number of days product health data (PHD) is to be collected from devices

uploadPHDFile

Boolean

Flag to specify if PHD file should be uploaded 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 specify if PHD files should be deleted after 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 specify if IP addresses is masked in PHD files.

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

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

devices

String

URI of devices to be included in the PHDC configuration

domianID

Integer

ID of the domain in which PHDC should be created.

This is an optional element. If no domain ID is provided, the PHDC is created in the Global domain.

Note: The create request fails if a user does not have access to the Global domain and if no domain ID is provided with the create request.

Produces

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

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

Response Elements

Element

Type

Description

id

Integer

ID of the PHDC configuration job

status-message

String

Status message of the PHDC configuration job

Sample Input

Sample XML Input

Sample JSON Input

Sample Output

Sample XML Output

Sample JSON Output