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

    Generate a PBN Report

    Service Insight provides Proactive Bug Notifications (PBNs) as a proactive measure to alert you about known issues that can impact the devices in your network. The Generate PBN Report method lets you create a PBN report for either a specific device or for all available Service Insight devices.

    URI

    https://[host]/api/juniper/serviceinsight/exposureanalyzer/generatepbnreport? queue=http://[host]/api/hornet-q/queues/jms.queue.[QueueName] (HTTP method = POST)

    Consumes

    • application/vnd.juniper.serviceinsight.exposureanalyzer.generatepbnreport+xml;version=3; charset=UTF-8
    • application/vnd.juniper.serviceinsight.exposureanalyzer.generatepbnreport+json;version=3; charset=UTF-8

    Request Elements

    Parameter

    Type

    Required

    Description

    pbnreportname

    String

    Yes

    User defined name for report. The report name is displayed at the top of the generated PBN report. The PBN report name can contain only alphanumeric characters and must be less than 64 characters in length.

    device

    String

    No

    Device for which the PBN report is to be generated. You can specify multiple device.

    If you do not specify this parameter, the PBN report is generated for all available service insight device.

    emails

    String

    No

    A list of comma-separated e-mail addresses. E-mails are sent to these addresses once the PBN report is generated.

    domainId

    Integer

    No

    ID of the domain to which the PBN report belongs

    This is an optional element. The value provided in this element is ignored if the value is invalid or a domainId other than the current domainId is provided.

    Sample Inputs

    The <devices> input element is optional. Specify the <devices> element to generate a report for a specific set of devices. if <devices> is not provided, then the PBN report is generated for all the available Service Insight devices.

    The <emails> element is a list of comma-separated email addresses. An email is sent to these addresses when the report is generated. No checks are done to ensure valid email addresses.

    Sample XML Input

    <pbnreport>
       <pbnreportname>NewSDKReport</pbnreportname>
       <devices>
          <device href = "/api/juniper/serviceinsight/exposureanalyzer/sidevices/196609"/>
       </devices>
       <emails>aprasar@mycompany.net</emails>
    </pbnreport>
    

    Sample JSON Input

    {
        "pbnreport": {
            "pbnreportname": "FinalSDKReprt",
            "devices": {
                "device": {
                    "@href": "/api/juniper/serviceinsight/exposureanalyzer/sidevices/393252"
                }
            },
            "emails": "aprasar@mycompany.net"
        }
    }
    

    Response

    The PBN report includes the following information:

    • Device name
    • Device serial number
    • Product or platform
    • Junos OS version
    • Device group
    • Connected member for the device
    • Service Now organization for the device
    • PBN title
    • PBN Juniper ID
    • PBN description
    • PBN customer impact

    Sample Output

    Sample XML Output

    <task href="/api/space/job-management/jobs/524292"><id>524292</id></task>

    Sample JSON Output

    task:{
            href:'/api/space/job-management/jobs/524292',
            id:524292
        }
    

    Response Status Code

    Message

    Description

    400 Bad Request

    Invalid PBN report name. Report name must begin with a letter and should have only alphanumeric (a-z0-9) characters.

    400 Bad Request

    Invalid PBN report name. The report name exceeds the maximum character length of 64.

    Modified: 2016-08-10