Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Get PHDC Configuration of a Device by PHD Device Configuration ID

    Use this API to retrieve the product health data collection (PHDC) configuration of a device from which product health data collected, by the device’s product health data (PHD) device configuration ID. The PHD device configuration ID identifies a device in a PHDC configuration.

    URI

    https://[host] /api/juniper/servicenow/device-analysis/phdDeviceConfigurations/{id} (HTTP method = GET)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    PHD device configuration ID of the device

    Consumes

    None

    Produces

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

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI of the PHDC configuration of a device

    method

    String

    Methods applicable to the configuration

    id

    String

    PHD device configuration ID of the device

    status

    Integer

    Status of PHDC on the device

    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

    collectionPeriodInDays

    String

    Number of days configured for collecting PHD on the device

    startTime

    String

    Date and Time when PHD collection started or is to start on the device

    endTime

    String

    Date and Time when PHD collection ended or is to end on the device

    phdcId

    Integer

    ID of the PHDC configuration to which the device is assigned

    Sample Output

    Sample XML Output

    <phdDeviceConfiguration uri="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643">
       <method href="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643/phds"/>
       <method href="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643/export"/>
       <id>35643</id>
       <status>Running</status>
       <availableFilesCount>53</availableFilesCount>
       <collectionPeriodInDays>30</collectionPeriodInDays>
       <startTime>2015-07-24 23:02:02 UTC</startTime>
       <endTime>2015-08-23 23:02:02 UTC</endTime>
       <phdcId>35638</phdcId>
    </phdDeviceConfiguration>
    

    Sample JSON Ouput

    {
      "phdDeviceConfiguration": {
        "@uri": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643",
        "method": [
          {
            "@href": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643/phds"
          },
          {
            "@href": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643/export"
          }
        ],
        "id": 35643,
        "status": "Running",
        "availableFilesCount": 53,
        "collectionPeriodInDays": 30,
        "startTime": "2015-07-24 23:02:02 UTC",
        "endTime": "2015-08-23 23:02:02 UTC",
        "phdcId": 35638
      }
    }
    

    Modified: 2016-08-10