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 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

    <phdDeviceConfigurations uri="/api/juniper/servicenow/phdc-management/phdcs/35638/phdDeviceConfigurations" size="2">
       <method href="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/export"/>
       <phdDeviceConfiguration key="35643" href="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643">
          <domainName/>
          <deviceName>ex-4200-sn1</deviceName>
          <serialNumber>BM0210329678</serialNumber>
          <status>Running</status>
          <availableFilesCount>53</availableFilesCount>
          <startTime>2015-07-24 23:02:02 UTC</startTime>
       </phdDeviceConfiguration>
       <phdDeviceConfiguration key="35652" href="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35652">
          <domainName/>
          <deviceName>sn-space-ex4500-sys1</deviceName>
          <serialNumber>GG0213130986</serialNumber>
          <status>Running</status>
          <availableFilesCount>50</availableFilesCount>
          <startTime>2015-07-24 23:02:02 UTC</startTime>
       </phdDeviceConfiguration>
    </phdDeviceConfigurations>
    
    

    Sample JSON Output

      "phdDeviceConfigurations": {
        "@uri": "/api/juniper/servicenow/phdc-management/phdcs/35638/phdDeviceConfigurations",
        "@size": "2",
        "method": {
          "@href": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/export"
        },
        "phdDeviceConfiguration": [
          {
            "@key": "35643",
            "@href": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643",
            "domainName": "",
            "deviceName": "ex-4200-sn1",
            "serialNumber": "BM0210329678",
            "status": "Running",
            "availableFilesCount": 53,
            "startTime": "2015-07-24 23:02:02 UTC"
          },
          {
            "@key": "35652",
            "@href": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35652",
            "domainName": "",
            "deviceName": "sn-space-ex4500-sys1",
            "serialNumber": "GG0213130986",
            "status": "Running",
            "availableFilesCount": 50,
            "startTime": "2015-07-24 23:02:02 UTC"
          }
        ]
      }
    }
    

    Modified: 2016-08-10