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

    Fault and Monitoring API Elements and Sample Output Files

    This topic provides the following sample API requests and associated output:

    • Resource utilization
    • Alarms and alarm count trend data
    • Port traffic trend data
    • Client sessions

    Options on how to display the output are also provided. Options include viewing the output based on a range of pages (pagination) and the amount of detail (detail).

    This topic provides the following information:

    Managed Devices API Sample Output

    All APIs require that you provide an accept header in the API request, otherwise the output data will be presented by default.

    Here is an example of an API request, followed by sample output. The sample output is in JSON format:

    https://10.94.45.84/api/juniper/nd/monitoring/devices
    Authorization: Basic c3VwZXI6anVuaXBlcjEyMw== Accept: application/vnd.juniper.nd.devices+json;version=2;q=0.01
    {
        "managedDeviceList": {
            "@total": "3",
            "device": [
                {
                    "@uri": "/api/juniper/nd/monitoring/devices/qfx/622592",
                    "resourceType": "JUNOS_QFX",
                    "instanceId": 622592,
                    "hostname": "qfx5100-01",
                    "platform": "QFX5100-96S-8Q",
                    "ipaddr": "192.168.48.168",
                    "serial": "VB3113470018",
                    "osVersion": "13.2X51-D20.2",
                    "family": "JUNOS_QFX",
                    "type": "NORMAL",
                    "connStatus": "UP",
                    "configState": "OUT_OF_SYNC"
                },
                {
                    "@uri": "/api/juniper/nd/monitoring/devices/qfx/622593",
                    "resourceType": "JUNOS_QFX",
                    "instanceId": 622593,
                    "hostname": "qfx5100-02",
                    "platform": "QFX5100-48S-6Q",
                    "ipaddr": "192.168.55.88",
                    "serial": "TA3714141203",
                    "osVersion": "13.2X51-D20.2",
                    "family": "JUNOS_QFX",
                    "type": "NORMAL",
                    "connStatus": "UP",
                    "configState": "OUT_OF_SYNC"
                },
                {
                    "@uri": "/api/juniper/nd/monitoring/devices/ex/622611",
                    "resourceType": "JUNOS_MX",
                    "instanceId": 622611,
                    "hostname": "EX9200-01",
                    "platform": "MX240",
                    "ipaddr": "10.204.245.71",
                    "serial": "IBM888",
                    "osVersion": "13.3R2.7",
                    "family": "JUNOS",
                    "type": "NORMAL",
                    "connStatus": "DOWN",
                    "configState": "SYNCHRONIZING"
                }
            ]
        }
    }
    

    Managed Devices API Sample Output Using Paging Option

    You can use the paging option to apply filters on the output. For example, you can specify how many entries to display and from which entry in the output set. In this example, the API request specifies output for three entries, starting from the second entry.

    Here is an example API request, followed by sample output. The sample output is in JSON format:

    https://10.94.45.84/api/juniper/nd/monitoring/devices?paging=(start eq 2, limit eq 3)
    {
        "managedDeviceList": {
            "@total": "3",
            "device": [
                {
                    "@uri": "/api/juniper/nd/monitoring/devices/qfx/622592",
                    "resourceType": "JUNOS_QFX",
                    "instanceId": 622592,
                    "hostname": "QFX5100-01",
                    "platform": "QFX5100-96S-8Q",
                    "ipaddr": "192.168.48.168",
                    "serial": "VB3113470018",
                    "osVersion": "13.2X51-D20.2",
                    "family": "JUNOS_QFX",
                    "type": "NORMAL",
                    "connStatus": "UP",
                    "configState": "OUT_OF_SYNC"
                },
                {
                    "@uri": "/api/juniper/nd/monitoring/devices/qfx/622593",
                    "resourceType": "JUNOS_QFX",
                    "instanceId": 622593,
                    "hostname": "QFX5100-04",
                    "platform": "QFX5100-48S-6Q",
                    "ipaddr": "192.168.55.88",
                    "serial": "TA3714141203",
                    "osVersion": "13.2X51-D20.2",
                    "family": "JUNOS_QFX",
                    "type": "NORMAL",
                    "connStatus": "UP",
                    "configState": "OUT_OF_SYNC"
                },
                {
                    "@uri": "/api/juniper/nd/monitoring/devices/ex/622611",
                    "resourceType": "JUNOS_MX",
                    "instanceId": 622611,
                    "hostname": "EX9200-06",
                    "platform": "MX240",
                    "ipaddr": "10.204.245.71",
                    "serial": "IBM888",
                    "osVersion": "13.3R2.7",
                    "family": "JUNOS",
                    "type": "NORMAL",
                    "connStatus": "DOWN",
                    "configState": "SYNCHRONIZING"
                }
            ]
        }
    }

    Managed Devices API Sample Output Using Detail Option

    You can request detailed information for a device by using the query parameter in each device summary block.

    Here is an example API request, followed by sample output. This sample output is in XML format.

    https://10.94.45.84/api/juniper/nd/monitoring/devices/ex/622611/
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <junosDeviceMO uri="/api/juniper/nd/monitoring/devices/ex/622611">
        <resourceType>JUNOS_MX</resourceType>
        <instanceId>622611</instanceId>
        <hostname>EX9200-01</hostname>
        <platform>MX240</platform>
        <ipaddr>10.204.245.71</ipaddr>
        <serial>IBM888</serial>
        <osVersion>13.3R2.7</osVersion>
        <family>JUNOS</family>
        <type>NORMAL</type>
        <connStatus>DOWN</connStatus>
        <configState>SYNCHRONIZING</configState>
        <usedMacCount>0</usedMacCount>
        <usedVlanCount>0</usedVlanCount>
        <lastChanged>Tue Jun 24 05:08:34 +0000 2014</lastChanged>
        <tempRange>avg=48, max=62 (FPC 1 XM 0 Chip)</tempRange>
        <totalPortUps>32</totalPortUps>
        <totalPortDowns>0</totalPortDowns>
        <totalPortFrees>32</totalPortFrees>
        <totalPortUsed>0</totalPortUsed>
        <psStatus>
            <name>PEM 0</name>
            <status>ABSENT</status>
        </psStatus>
        <psStatus>
            <name>PEM 1</name>
            <status>ABSENT</status>
        </psStatus>
        <psStatus>
            <name>PEM 2</name>
            <status>ABSENT</status>
        </psStatus>
        <psStatus>
            <name>PEM 3</name>
            <status>OK</status>
        </psStatus>
        <fanStatus>
            <name>Front Fan</name>
            <status>OK</status>
        </fanStatus>
        <fanStatus>
            <name>Middle Fan</name>
            <status>OK</status>
        </fanStatus>
        <fanStatus>
            <name>Rear Fan</name>
            <status>OK</status>
        </fanStatus>
        <uptime>3d:18h:14m:41s</uptime>
    </junosDeviceMO>
    

    Resource Utilization and Alarm Count Trending APIs Sample Output

    Resource utilization and alarm count trend data are supported only on EX Series devices, Access Points, Wireless LAN Controllers, and QFabric systems.

    Here is an example API request, followed by sample output. This sample output is in XML format.

    https://10.94.45.84/api/juniper/nd/monitoring/devices/ex/622611/resource-utilization-trend?hours=2
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <resourceUtilizationTrend total="0”/>
    
    https://10.94.45.84/api/juniper/nd/monitoring/devices/ex/622611/alarm-count-trend?hours=1
    Output:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <alarmCountTrend total="12">
        <stat>
            <collectionTimestamp>1403815500</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403815800</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403816100</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403816400</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403816700</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403817000</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403817300</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403817600</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403817900</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403818200</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403818500</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
        <stat>
            <collectionTimestamp>1403818800</collectionTimestamp>
            <allInfoAlarm>0.0</allInfoAlarm>
            <allMinorAlarm>0.0</allMinorAlarm>
            <allMajorAlarm>1.0</allMajorAlarm>
            <allCriticalAlarm>0.0</allCriticalAlarm>
            <newInfoAlarm>0.0</newInfoAlarm>
            <newMinorAlarm>0.0</newMinorAlarm>
            <newMajorAlarm>0.0</newMajorAlarm>
            <newCriticalAlarm>0.0</newCriticalAlarm>
        </stat>
    </alarmCountTrend>

    Port APIs Sample Output

    You can use port API requests to query managed ports for summary information for each port based on query parameters. If the query parameter value is omitted, summary information for all ports will be displayed.

    Here is an example without any query parameters:

    https://10.94.45.84/api/juniper/nd/monitoring/ports

    Output is not included.

    You can use the paging option to apply filters on the output. For example, you can specify how many entries to display and from which entry in the output set. In this example, the API request specifies output for three entries, starting from the tenth entry.

    Here is an example API request, followed by sample output. The sample output is in XML format:

    https://10.94.45.84/api/juniper/nd/monitoring/ports?paging=(start eq 10, limit eq 3)
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ports uri="/api/juniper/nd/monitoring/ports">
        <port uri="/api/juniper/nd/monitoring/ports/ex/VB3113470018_xe-0.0.90">
            <instanceId>VB3113470018_xe-0.0.90</instanceId>
            <portId>VB3113470018_xe-0.0.90</portId>
            <portName>xe-0/0/90</portName>
            <portMac>88:e0:f3:1d:6b:5d</portMac>
            <hostSerial>VB3113470018</hostSerial>
            <hostname>analytics-qfx5100-01</hostname>
            <portSpeed>10000</portSpeed>
            <portType>10-Gigabit</portType>
            <adminStatus>UP</adminStatus>
            <operStatus>UP</operStatus>
            <lastFlap>2 Days 5 Hrs 15 Mins 24 Secs ago</lastFlap>
        </port>
        <port uri="/api/juniper/nd/monitoring/ports/ex/VB3113470018_xe-0.0.91">
            <instanceId>VB3113470018_xe-0.0.91</instanceId>
            <portId>VB3113470018_xe-0.0.91</portId>
            <portName>xe-0/0/91</portName>
            <portMac>88:e0:f3:1d:6b:5e</portMac>
            <hostSerial>VB3113470018</hostSerial>
            <hostname>analytics-qfx5100-01</hostname>
            <portSpeed>10000</portSpeed>
            <portType>10-Gigabit</portType>
            <adminStatus>UP</adminStatus>
            <operStatus>UP</operStatus>
            <lastFlap>2 Days 5 Hrs 15 Mins 24 Secs ago</lastFlap>
        </port>
        <port uri="/api/juniper/nd/monitoring/ports/ex/VB3113470018_xe-0.0.92">
            <instanceId>VB3113470018_xe-0.0.92</instanceId>
            <portId>VB3113470018_xe-0.0.92</portId>
            <portName>xe-0/0/92</portName>
            <portMac>88:e0:f3:1d:6b:5f</portMac>
            <hostSerial>VB3113470018</hostSerial>
            <hostname>analytics-qfx5100-01</hostname>
            <portSpeed>10000</portSpeed>
            <portType>10-Gigabit</portType>
            <adminStatus>UP</adminStatus>
            <operStatus>UP</operStatus>
            <lastFlap>2 Days 5 Hrs 15 Mins 23 Secs ago</lastFlap>
        </port>
    </ports>
    

    Port APIs Sample Output Using Detail Option

    You can request detailed information for a port by using the query parameter in each port summary block.

    Here is an example API request, followed by sample output. The sample output is in XML format:

    https://10.94.45.84/api/juniper/nd/monitoring/ports/ex/VB3113470018_xe-0.0.91
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <portTraffic uri="/api/juniper/nd/monitoring/ports/ex/VB3113470018_xe-0.0.91">
        <instanceId>VB3113470018_xe-0.0.91</instanceId>
        <portId>VB3113470018_xe-0.0.91</portId>
        <portName>xe-0/0/91</portName>
        <portMac>88:e0:f3:1d:6b:5e</portMac>
        <hostSerial>VB3113470018</hostSerial>
        <hostname>analytics-qfx5100-01</hostname>
        <portSpeed>10000</portSpeed>
        <portType>10-Gigabit</portType>
        <adminStatus>UP</adminStatus>
        <operStatus>UP</operStatus>
        <lastFlap>2 Days 5 Hrs 25 Mins 18 Secs ago</lastFlap>
        <trafficInOut>
            <collectionTimestamp>1403819400</collectionTimestamp>
            <unicastInRate>0.0</unicastInRate>
            <unicastOutRate>0.0</unicastOutRate>
            <broadcastInRate>0.0</broadcastInRate>
            <broadcastOutRate>0.0</broadcastOutRate>
            <multicastInRate>0.0</multicastInRate>
            <multicastOutRate>0.0</multicastOutRate>
        </trafficInOut>
        <trafficError>
            <collectionTimestamp>0</collectionTimestamp>
            <dropsInErrs>0.0</dropsInErrs>
            <framingErrsIn>0.0</framingErrsIn>
            <runtInErr>0.0</runtInErr>
            <discardsInErr>0.0</discardsInErr>
            <l3IncompletesIn>0.0</l3IncompletesIn>
            <l2ChannelErrorsIn>0.0</l2ChannelErrorsIn>
            <l2MismatchTmeout>0.0</l2MismatchTmeout>
            <fifoErrsIn>0.0</fifoErrsIn>
            <resourceErrsIn>0.0</resourceErrsIn>
            <carrierTransOut>0.0</carrierTransOut>
            <collisionOut>0.0</collisionOut>
            <dropsOut>0.0</dropsOut>
            <agedPktsOut>0.0</agedPktsOut>
            <mtuErrsOut>0.0</mtuErrsOut>
            <hsLinkCrcErr>0.0</hsLinkCrcErr>
            <fifoErrsOut>0.0</fifoErrsOut>
            <resourceErrsOut>0.0</resourceErrsOut>
            <crcErrsIn>0.0</crcErrsIn>
            <crcErrsOut>0.0</crcErrsOut>
            <oversizedFrmIn>0.0</oversizedFrmIn>
            <oversizedFrmOut>0.0</oversizedFrmOut>
            <jabberFrmIn>0.0</jabberFrmIn>
            <fragFrmIn>0.0</fragFrmIn>
            <codeViolationIn>0.0</codeViolationIn>
        </trafficError>
    </portTraffic>
    

    Port Traffic Trend Data APIs Sample Output

    You can use Port traffic trend data API requests to query ports based on the port ID as well as the time range given by the parameters. You must provide either start time and end time of the query or the last number of hours.

    Here is an example API request, followed by sample output. The sample output is in XML format:

    https://0.94.45.84/api/juniper/nd/monitoring/ports/ex/VB3113470018_xe-0.0.91/port-traffic-trend?startTime=2014-03-03T01:02:00Z&endTime=2014-03-14T10:00:00Z
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <portTrafficTrend total="12" uri="/api/juniper/nd/monitoring/ports/ex/VB3113470018_xe-0.0.91">
        <instanceId>VB3113470018_xe-0.0.91</instanceId>
        <portId>VB3113470018_xe-0.0.91</portId>
        <portName>xe-0/0/91</portName>
        <portMac>88:e0:f3:1d:6b:5e</portMac>
        <hostSerial>VB3113470018</hostSerial>
        <hostname>analytics-qfx5100-01</hostname>
        <portSpeed>10000</portSpeed>
        <portType>10-Gigabit</portType>
        <adminStatus>UP</adminStatus>
        <operStatus>UP</operStatus>
        <lastFlap>2 Days 5 Hrs 25 Mins 18 Secs ago</lastFlap>
        <trafficInOut>
            <collectionTimestamp>1403816100</collectionTimestamp>
            <unicastInRate>0.0</unicastInRate>
            <unicastOutRate>0.0</unicastOutRate>
            <broadcastInRate>0.0</broadcastInRate>
            <broadcastOutRate>0.0</broadcastOutRate>
            <multicastInRate>0.0</multicastInRate>
            <multicastOutRate>0.0</multicastOutRate>
        </trafficInOut>
        <trafficInOut>
            <collectionTimestamp>1403816400</collectionTimestamp>
            <unicastInRate>0.0</unicastInRate>
            <unicastOutRate>0.0</unicastOutRate>
            <broadcastInRate>0.0</broadcastInRate>
            <broadcastOutRate>0.0</broadcastOutRate>
            <multicastInRate>0.0</multicastInRate>
            <multicastOutRate>0.0</multicastOutRate>
        </trafficInOut>
        <trafficInOut>
            <collectionTimestamp>1403816700</collectionTimestamp>
            <unicastInRate>0.0</unicastInRate>
            <unicastOutRate>0.0</unicastOutRate>
            <broadcastInRate>0.0</broadcastInRate>
            <broadcastOutRate>0.0</broadcastOutRate>
            <multicastInRate>0.0</multicastInRate>
            <multicastOutRate>0.0</multicastOutRate>
        </trafficInOut>
        <trafficInOut>
            <collectionTimestamp>1403817000</collectionTimestamp>
            <unicastInRate>0.0</unicastInRate>
            <unicastOutRate>0.0</unicastOutRate>
            <broadcastInRate>0.0</broadcastInRate>
            <broadcastOutRate>0.0</broadcastOutRate>
            <multicastInRate>0.0</multicastInRate>
            <multicastOutRate>0.0</multicastOutRate>
        </trafficInOut>
    ...
    </portTrafficTrend>

    Client Sessions APIs Sample Output

    You can use the client sessions APIs to query client sessions based on search parameters, such as username, MAC address, IPv4 address, IPv6 address, and so on. If you do not specify a search parameter, an exception error is issued.

    Here is an example API request, followed by sample output. The sample output is in XML format:

    https://10.94.45.84/api/juniper/nd/monitoring/client-sessions?search=18:26:66:72:81:62
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <clientSessions total="1" uri="/api/juniper/nd/monitoring/client-sessions">
        <session uri="/api/juniper/nd/monitoring/client-sessions/wireless/18:26:66:72:81:62">
            <instanceId>18:26:66:72:81:62</instanceId>
            <resourceType>WIRELESSCLIENT</resourceType>
            <macAddress>18:26:66:72:81:62</macAddress>
            <userName>last-resort-AWN-2105</userName>
            <ipv4>192.168.34.175</ipv4>
            <ipv6>[]</ipv6>
            <linkLocal>fe80::1a26:66ff:fe72:8162</linkLocal>
        </session>
    </clientSessions>

    You can also search using partial search data:

    Here is an example API request, followed by sample output. The sample output is in XML format:

    https://10.94.45.84/api/juniper/nd/monitoring/client-sessions?search=BB
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <clientSessions total="3" uri="/api/juniper/nd/monitoring/client-sessions">
        <session uri="/api/juniper/nd/monitoring/client-sessions/wireless/1c:b0:94:4c:bb:09">
            <instanceId>1c:b0:94:4c:bb:09</instanceId>
            <resourceType>WIRELESSCLIENT</resourceType>
            <macAddress>1c:b0:94:4c:bb:09</macAddress>
            <userName>last-resort-AWN-2095</userName>
            <ipv4>192.168.33.197</ipv4>
            <ipv6>[]</ipv6>
            <linkLocal>fe80::1eb0:94ff:fe4c:bb09</linkLocal>
        </session>
        <session uri="/api/juniper/nd/monitoring/client-sessions/wireless/34:bb:26:df:ec:05">
            <instanceId>34:bb:26:df:ec:05</instanceId>
            <resourceType>WIRELESSCLIENT</resourceType>
            <macAddress>34:bb:26:df:ec:05</macAddress>
            <userName>last-resort-AWN-2124</userName>
            <ipv4>192.168.32.95</ipv4>
            <ipv6>[]</ipv6>
            <linkLocal>fe80::36bb:26ff:fedf:ec05</linkLocal>
        </session>
        <session uri="/api/juniper/nd/monitoring/client-sessions/wireless/58:a2:b5:d0:49:bb">
            <instanceId>58:a2:b5:d0:49:bb</instanceId>
            <resourceType>WIRELESSCLIENT</resourceType>
            <macAddress>58:a2:b5:d0:49:bb</macAddress>
            <userName>last-resort-AWN-2262</userName>
            <ipv4>192.168.33.3</ipv4>
            <ipv6>[]</ipv6>
            <linkLocal>fe80::5aa2:b5ff:fed0:49bb</linkLocal>
        </session>
    </clientSessions>
    

    Alarm APIs Sample Output

    You can use alarm API requests to query alarms based on the query parameters. If you omit the query parameter, information for all alarms will be provided.

    Here is an example API request, followed by sample output. The sample output is in XML format:

    https://10.94.45.84/api/juniper/nd/monitoring/alarms?paging=(start eq 10, limit eq 3)
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <alarms uri="/api/juniper/nd/monitoring/alarms" total="93">
        <alarm uri="/api/juniper/nd/monitoring/alarms/11">
            <instanceId>11</instanceId>
            <alarmId>11</alarmId>
            <name>Port High Non-Unicast Traffic</name>
            <catergory>Threshold</catergory>
            <severity>MAJOR</severity>
            <state>ACTIVE</state>
            <ack>false</ack>
            <entityId>Port:LX0212521598.ge-0/0/2</entityId>
            <source>10.94.45.171</source>
            <creationTime>Thu Jun 12 18:48:23 UTC 2014</creationTime>
            <lastUpdated>Mon Jun 23 19:48:23 UTC 2014</lastUpdated>
            <updatedBy>System</updatedBy>
        </alarm>
        <alarm uri="/api/juniper/nd/monitoring/alarms/12">
            <instanceId>12</instanceId>
            <alarmId>12</alarmId>
            <name>Device High CPU Utilization</name>
            <catergory>Threshold</catergory>
            <severity>MAJOR</severity>
            <state>ACTIVE</state>
            <ack>false</ack>
            <entityId>Device:LX0212521598</entityId>
            <source>10.94.45.171</source>
            <creationTime>Thu Jun 12 19:48:23 UTC 2014</creationTime>
            <lastUpdated>Thu Jun 26 17:54:16 UTC 2014</lastUpdated>
            <updatedBy>System</updatedBy>
        </alarm>
        <alarm uri="/api/juniper/nd/monitoring/alarms/13">
            <instanceId>13</instanceId>
            <alarmId>13</alarmId>
            <name>Port High Utilization</name>
            <catergory>Threshold</catergory>
            <severity>MAJOR</severity>
            <state>ACTIVE</state>
            <ack>false</ack>
            <entityId>Port:P5228.xe-0/0/30</entityId>
            <source>192.168.48.246</source>
            <creationTime>Thu Jun 12 22:18:23 UTC 2014</creationTime>
            <lastUpdated>Thu Jun 26 17:54:17 UTC 2014</lastUpdated>
            <updatedBy>System</updatedBy>
        </alarm>
    </alarms>

    Alarm APIs Sample Output Using Detail Option

    You can use alarm API requests to query alarms based on query parameters. If you omit the query parameter, information for all alarms will be provided.

    Here is an example API request, followed by sample output. The sample output is in XML format:

    https://10.94.45.84/api/juniper/nd/monitoring/alarms/10
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <alarm uri="/api/juniper/nd/monitoring/alarms/10">
        <instanceId>10</instanceId>
        <alarmId>10</alarmId>
        <name>Port High Non-Unicast Traffic</name>
        <catergory>Threshold</catergory>
        <severity>MAJOR</severity>
        <state>ACTIVE</state>
        <ack>false</ack>
        <entityId>Port:PG3713400425.ge-0/0/23</entityId>
        <source>10.204.247.50</source>
        <creationTime>Thu Jun 12 18:48:23 UTC 2014</creationTime>
        <lastUpdated>Thu Jun 26 17:54:16 UTC 2014</lastUpdated>
        <updatedBy>System</updaedBy>
    </alarm>

    Modified: 2016-03-17