Get Information About an Event Profile
Use this API to retrieve information about an event profile.
URI
https://[host]/api/juniper/servicenow/event-profile-management/eventProfiles/{id} (HTTP method = GET)
URI Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
id | Integer | Yes | ID of the event profile for which information is to be retrieved |
Consumes
None
Produces
application/vnd.juniper.servicenow.event-profile-management.eventprofile+xml;version=3
application/vnd.juniper.servicenow.event-profile-management.eventprofile+json;version=3
Response
Element | Type | Description |
|---|---|---|
uri | String | URI of the event profile |
id | Integer | Unique ID of this event profile |
profileName | String | Event profile name |
scriptBundleName | String | Name of the script bundle from which this profile is created |
scriptBundleVersion | String | Version number of the script bundle |
method | String | Method applicable to the event profile |
installed-device | installed-device | Collection of devices on which the event profile is installed |
device | device | A device on whieh the event profile is installed |
id | Integer | ID of the device |
profileId | Integer | Unique ID of this event profile (same as the id element) |
hostName | String | Hostname of the device on which this profile is installed |
events | event | Collection of events in the event profile |
uri | String | URI of the events in the event profile |
size | Integer | Number of events in this profile |
event | event | An event in the event profile |
name | String | Name of each event in this profile |
category | String | Category of each event in this profile |
type | String | Event type of each event in this profile |
subType | String | Subtype of each event in this profile |
priority | String | Event priority |
KBArticle | String | Link to KB article related for that event |
briefDescription | String | Terse description of the event |
eventDescription | String | Detailed description of the event |
domainId | Integer | ID of the domain in which the event profile is created |
Sample Output
Sample XML Output
<eventprofile uri="/api/juniper/servicenow/event-profile-management/eventProfiles/163857">
<id>163857</id>
<profileName>testProfile</profileName>
<domainId>10</domainId>
<scriptBundleName>jais-3.1R1.1-signed.tgz</scriptBundleName>
<scriptBundleVersion>3.1R1.1</scriptBundleVersion>
<method href="/api/juniper/servicenow/event-profile-management/eventProfiles/163857/installEventProfile"
rel="Install Profile on Devices"/>
<installed-devices uri="/api/juniper/servicenow/event-profile-management/eventProfiles/163857/installedDevices">
<device href="/api/juniper/servicenow/device-management/devices/163840">
<id>163840</id>
<profileId>163857</profileId>
<hostName>mx480-2-re0</hostName>
</device>
<device href="/api/juniper/servicenow/device-management/devices/163841">
<id>163841</id>
<profileId>163857</profileId>
<hostName>ex-4200.50.182</hostName>
</device>
<device href="/api/juniper/servicenow/device-management/devices/163842">
<id>163842</id>
<profileId>163857</profileId>
<hostName>mx480_ais_1.re0</hostName>
</device>
<device href="/api/juniper/servicenow/device-management/devices/163843">
<id>163843</id>
<profileId>163857</profileId>
<hostName>SN-SRX1400test</hostName>
</device>
</installed-devices>
<events size=”4” uri="/api/juniper/servicenow/event-profile-management/eventProfiles/163857/events">
<event>
<name>ACCT_XFER_POPEN_FAIL</name>
<category>ACCT</category>
<type>Software Failure</type>
<subType>Communication Error</subType>
<priority>MED</priority>
<KBArticle>
https://kb.juniper.net/InfoCenter/index?page=content&actp=SN&id=KB18778
</KBArticle>
<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>
</event>
<event>
<name>CONNECTION_CHASSISD_FAIL</name>
<category>ALARMD</category>
<type>Software Failure</type>
<subType>Initialization failure</subType>
<priority>HIGH</priority>
<KBArticle>
https://kb.juniper.net/InfoCenter/index?page=content&actp=SN&id=KB18779
</KBArticle>
<briefDescription>
CONNECTION_CHASSISD_FAIL
</briefDescription>
<eventDescription>
The alarm process (alarmd) was unable to connect to the chassis process (chassisd).
</eventDescription>
</event>
</events>
</eventprofile>
Sample JSON Output
eventprofile:{
uri:'/api/juniper/servicenow/event-profile-management/eventProfiles/163857',
id:163857,
profilename:'testProfile',
scriptbundlename:'jais-3.1R1.1-signed.tgz',
domainId:"10",
scriptbundleversion:'3.1R1.1',
method:{
href:'/api/juniper/servicenow/event-profile-management/eventProfiles/163857/installEventProfile',
rel:'Install Profile on Devices'
},
installed-devices:{
uri:'/api/juniper/servicenow/event-profile-management/eventProfiles/163857/installedDevices',
device:[
{
href:'/api/juniper/servicenow/device-management/devices/163840',
id:163840,
profileid:163857,
hostname:'mx480-2-re0'
},
{
href:'/api/juniper/servicenow/device-management/devices/163841',
id:163841,
profileid:163857,
hostname:'ex-4200.50.182'
},
{
href:'/api/juniper/servicenow/device-management/devices/163842',
id:163842,
profileid:163857,
hostname:'mx480_ais_1.re0'
},
{
href:'/api/juniper/servicenow/device-management/devices/163843',
id:163843,
profileid:163857,
hostname:'SN-SRX1400test'
}
]
},
events:{
size:4,
uri:'/api/juniper/servicenow/event-profile-management/eventProfiles/163857/events',
event:[
{
name:'ACCT_XFER_POPEN_FAIL',
category:'ACCT',
type:'Software Failure',
subtype:'Communication Error',
priority:'MED',
Response Status Code
Message | Description |
|---|---|
404 Not Found | Invalid event profile ID specified. |