TechLibrary

Table of Contents

Guide That Contains This Content

[+] Expand All

[-] Collapse All

Get Events Associated with an Auto Submit Policy

An auto submit policy enables incidents that occur on devices to be submitted to JSS or Service Now partner automatically for creating a technical support case. Use this API to retrieve all events associated with a specific auto submit policy.

URI

https://[host]/api/juniper/servicenow/autosubmit-policy-management/autosubmitpolicies /{id}/events (HTTP method = GET)

URI Parameters

Parameter	Type	Required	Description
id	Integer	Yes	ID of the auto submit policy for which information about associated events must be retrieved

Consumes

None

Produces

application/vnd.juniper.servicenow.autosubmit-policy-management.events +xml;version=2
application/vnd.juniper.servicenow.autosubmit-policy-management.events +json;version=2

Response

Element	Type	Description
uri	String	URI to the collection of events associated with the auto submit policy
size	Integer	Number of records in the collection
event	event	An event associated with the auto submit policy
name	String	Event name.
category	String	Event category.
type	String	Event type. Possible values: Software failure Hardware failure Resource exhaustion
subType	String	Event subtype.
briefDescription	String	A terse description of the event.
eventDescription	String	A detailed description of the event.
minimumVersion	String	Minimum version of Junos in which event is enabled.
dampening	String	Dampening status of the event Possible values: None—An Incident is created in Service Now for each occurrence of the event. Always—No incident is created in Service Now after the first occurrence of the event. Dampening interval—Time interval for which an incident is not created for the event when the event recurs.

Sample Output

Sample XML Output

<events size=”2” uri="/api/juniper/servicenow/autosubmit-policy-management/autosubmitpolicies /360457/events">
       <event>
              <name>ACCT_XFER_POPEN_FAIL</name>
              <fileName>ACCT_XFER_POPEN_FAIL.slax</fileName>
              <category>ACCT</category>
              <type>Software Failure</type>
              <subType>Communication Error</subType>
              <briefDescription>ACCT_XFER_POPEN_FAIL</briefDescription>
              <eventDescription>A call to the popen() function failed when the accounting statistics process invoked the indicated command to transfer the indicated file.</eventDescription>
              <activateDescription>Capture ACCT_XFER_POPEN_FAIL Events</activateDescription>
              <featureName>ACCT_XFER_POPEN_FAIL.slax</featureName>
              <minimumVersion>9.4</minimumVersion>
              <helpText>ACCT_XFER_POPEN_FAIL</helpText>
              <dampening>1 hr</ dampening>
       </event>
       <event>
              <name>CONNECTION_CHASSISD_FAIL</name>
              <fileName>CONNECTION_CHASSISD_FAIL.slax</fileName>
              <category>ALARMD</category>
              <type>Software Failure</type>
              <subType>Initialization failure</subType>
              <briefDescription>CONNECTION_CHASSISD_FAIL</briefDescription>
              <eventDescription>The alarm process (alarmd) was unable to connect to the chassis process (chassisd).</eventDescription>
              <activateDescription>Capture CONNECTION_CHASSISD_FAIL Events</activateDescription>
              <featureName>CONNECTION_CHASSISD_FAIL.slax</featureName>
              <minimumVersion>9.5</minimumVersion>
              <helpText>SW-common-2:CONNECTION_CHASSISD_FAIL</helpText>
              <dampening>None</ dampening>
       </event>
</events>

Sample JSON Output

{
        "events":{
"@size":"2", 
        "@uri":"/api/juniper/servicenow/autosubmit-policy-management/autosubmitpolicies /360457/events",
        "event":[
            {
                 "name":"ACCT_XFER_POPEN_FAIL",
                "filename":"ACCT_XFER_POPEN_FAIL.slax",
                "category":"ACCT",
                "type":"Software Failure",
                "subtype":"Communication Error",
                "briefdescription":"ACCT_XFER_POPEN_FAIL",
                "eventdescription":"A call to the popen() function failed when the accounting statistics process invoked the indicated command to transfer the indicated file. ",
                "activatedescription":"Capture ACCT_XFER_POPEN_FAIL Events",
                "featurename":"ACCT_XFER_POPEN_FAIL.slax",
                "minimumversion":"9.4",
                "helptext":"ACCT_XFER_POPEN_FAIL",
      “dampening”:”1 hr”
            },
            {
                "name":"CONNECTION_CHASSISD_FAIL",
                "filename":"CONNECTION_CHASSISD_FAIL.slax",
                "category":"ALARMD",
                "type":"Software Failure",
                "subtype":"Initialization failure", 
                "briefdescription":"CONNECTION_CHASSISD_FAIL",
                "eventdescription":"The alarm process (alarmd) was unable to connect to the chassis process (chassisd). ",
                "activatedescription":"Capture CONNECTION_CHASSISD_FAIL Events",
                "featurename":"CONNECTION_CHASSISD_FAIL.slax",
                "minimumversion":"9.5",
                "helptext":"SW-common-2:CONNECTION_CHASSISD_FAIL"
       “dampening”:”None”
            }
        ]
    }
}

Response Status Code

Message	Description
500 Internal Server Error	No events are associated with the specified auto submit policy.

TechLibrary

Related Documentation

Get Events Associated with an Auto Submit Policy

Related Documentation

Modified: 2016-08-11