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

    Disable Devices in a PHDC Configuration

    Use this API to disable product health data collection (PHDC) on devices on which PHDC is running in a PHDC configuration.

    URI

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

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the PHDC configuration in which PHDC is to be disabled on devices

    Consumes

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

    Request Elements

    Element

    Type

    Description

    device

    device

    A device on which PHDC is to be disabled

    href

    String

    Link to the device on which PHDC is to be disabled

    uri

    String

    URI of the device on which PHDC is to be disabled

    Produces

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

    Response Elements

    Element

    Type

    Description

    id

    Integer

    ID of the PHDC configuration disable job

    statusMessage

    String

    Status message of the disable job

    Sample Input

    Sample XML Input

    <devices>
    <device href= "/api/juniper/servicenow/device-management/devices/1114128" uri="/api/juniper/servicenow/device-management/devices/1114128" />
    <device href= "/api/juniper/servicenow/device-management/devices/1114132" uri="/api/juniper/servicenow/device-management/devices/1114132" />
    </devices>
    

    Sample JSON Input

    {
       "devices": {
          "device": [
             {
                "_href": "/api/juniper/servicenow/device-management/devices/34736",
                "_uri": "/api/juniper/servicenow/device-management/devices/34736"
             },
             {
                "_href": "/api/juniper/servicenow/device-management/devices/34737",
                "_uri": "/api/juniper/servicenow/device-management/devices/34737"
             }
          ]
       }
    }

    Sample Output

    Sample XML Output

    <phdStatusMessage>
       <id>1182702</id>
       <statusMessage> Product Health Data Collection will be disabled on the selected devices </statusMessage>
    </phdStatusMessage>
    

    Sample JSON Output

    {
      "phdStatusMessage": {
        "id": "1182702",
        "statusMessage": "Product Health Data Collection will be disabled on the selected devices "
          }
    }
    

    Modified: 2016-08-10