Monitor API

/api/juniper/vdirector/monitor/vm-datas

The following operations are supported on this resource:

  • GET - Get the performance data for the VM instance and the device running on it

GET /api/juniper/vdirector/monitor/vm-datas (v1)


Get the performance data for the VM instance and the device running on it.

Access Control

The following capabilities are required to access this API:
"VSMCap"


Example Usage

GET /api/juniper/vdirector/monitor/vm-datas?uuid=<uuid>


Parameters

NameTypeURI TypeDescriptionRequired
uuidStringQuery   Y

Content Types

  • Produces content types:
    application/net.juniper.vdirector.monitor.instance-perf-data+xml;version=1;q=0.01
    application/net.juniper.vdirector.monitor.instance-perf-data+json;version=1;q=0.01


  • Sample Output XML:
    <instance-perf-data href="/api/juniper/vdirector/monitor/vm-datas/{id}" uri="/api/juniper/vdirector/monitor/vm-datas">
         <id>Integer</id>
         <device-usage>
               <vc-name>String</vc-name>
               <id>Integer</id>
               <ip-addr>String</ip-addr>
               <data-complete>Boolean</data-complete>
               <vm-id>String</vm-id>
               <perf-data total="Integer" uri="/api/juniper/vdirector/monitor/vm-datas/perf-data">
                   <device-perf-data>
                         <ip-packets-forwarded>Integer</ip-packets-forwarded>
                         <flow-pkt-count-fwd>Long</flow-pkt-count-fwd>
                         <icmp-echo-reply>Integer</icmp-echo-reply>
                         <ip-packets-dropped>Integer</ip-packets-dropped>
                         <time-data-obtained>java.util.Date</time-data-obtained>
                         <tcp-send-packets-dropped>Integer</tcp-send-packets-dropped>
                         <last-configured-user>String</last-configured-user>
                         <ip-packets-received>Integer</ip-packets-received>
                         <ipsec-outbound-packets>Integer</ipsec-outbound-packets>
                         <tcp-packets-received>Integer</tcp-packets-received>
                         <active-user-count>Integer</active-user-count>
                         <igmp-mesg-received>Integer</igmp-mesg-received>
                         <tcp-total-packets-discarded>Integer</tcp-total-packets-discarded>
                         <interfaces-info total="Integer" uri="/api/juniper/vdirector/monitor/vm-datas/perf-data/interfaces-info">
                             <device-intf-data>
                                   <physical-addr>String</physical-addr>
                                   <if-output-packets>Integer</if-output-packets>
                                   <if-input-packets>Integer</if-input-packets>
                                   <oper-status>String</oper-status>
                                   <if-input-pps>Integer</if-input-pps>
                                   <if-input-bps>Integer</if-input-bps>
                                   <admin-status>String</admin-status>
                                   <if-name>String</if-name>
                                   <if-output-pps>Integer</if-output-pps>
                                   <if-output-bps>Integer</if-output-bps>
                                   <intf-flapped>String</intf-flapped>
                             </device-intf-data>
                         </interfaces-info>
                         <system-booted-time>String</system-booted-time>
                         <protocols-started-time>String</protocols-started-time>
                         <tcp-rcv-packets-dropped>Integer</tcp-rcv-packets-dropped>
                         <last-configured-time>String</last-configured-time>
                         <udp-datagrams-received>Integer</udp-datagrams-received>
                         <tcp-packets-sent>Integer</tcp-packets-sent>
                         <system-current-time>String</system-current-time>
                         <ipsec-inbound-packets>Integer</ipsec-inbound-packets>
                         <flow-pkt-count-drop>Integer</flow-pkt-count-drop>
                         <system-uptime>String</system-uptime>
                         <flow-pkt-count>Integer</flow-pkt-count>
                   </device-perf-data>
               </perf-data>
               <device-connection-state>vcenterNotMonitored</device-connection-state>
               <device-hostname>String</device-hostname>
               <vm-name>String</vm-name>
         </device-usage>
         <vm-usage>
               <vc-name>String</vc-name>
               <vcenter-connection-state>vcenterNotMonitored</vcenter-connection-state>
               <id>Integer</id>
               <vm-name>String</vm-name>
               <vm-id>String</vm-id>
               <perf-data total="Integer" uri="/api/juniper/vdirector/monitor/vm-datas/perf-data">
                   <vm-perf-data>
                         <uptime-seconds>Long</uptime-seconds>
                         <mem-used-mb>Float</mem-used-mb>
                         <cpu-used-mhz>Float</cpu-used-mhz>
                         <formatted-uptime>String</formatted-uptime>
                         <time-data-obtained>java.util.Date</time-data-obtained>
                         <cpu-used-percent>Float</cpu-used-percent>
                   </vm-perf-data>
               </perf-data>
               <data-complete>Boolean</data-complete>
               <total-usage-hours>Integer</total-usage-hours>
         </vm-usage>
    </instance-perf-data>


  • Sample Output JSON:
    {
       "instance-perf-data" : {
         "@href" : "/api/juniper/vdirector/monitor/vm-datas/{id}" ,
         "@uri" : "/api/juniper/vdirector/monitor/vm-datas" ,
         "id" : "Integer" ,
         "device-usage" : {
           "vc-name" : "String" ,
           "id" : "Integer" ,
           "ip-addr" : "String" ,
           "data-complete" : "Boolean" ,
           "vm-id" : "String" ,
           "perf-data" : {
             "@total" : "Integer" ,
             "@uri" : "/api/juniper/vdirector/monitor/vm-datas/perf-data" ,
             "device-perf-data" : {
               "ip-packets-forwarded" : "Integer" ,
               "flow-pkt-count-fwd" : "Long" ,
               "icmp-echo-reply" : "Integer" ,
               "ip-packets-dropped" : "Integer" ,
               "time-data-obtained" : "java.util.Date" ,
               "tcp-send-packets-dropped" : "Integer" ,
               "last-configured-user" : "String" ,
               "ip-packets-received" : "Integer" ,
               "ipsec-outbound-packets" : "Integer" ,
               "tcp-packets-received" : "Integer" ,
               "active-user-count" : "Integer" ,
               "igmp-mesg-received" : "Integer" ,
               "tcp-total-packets-discarded" : "Integer" ,
               "interfaces-info" : {
                 "@total" : "Integer" ,
                 "@uri" :
                 "/api/juniper/vdirector/monitor/vm-datas/perf-data/interfaces-info" ,
                 "device-intf-data" : {
                   "physical-addr" : "String" ,
                   "if-output-packets" : "Integer" ,
                   "if-input-packets" : "Integer" ,
                   "oper-status" : "String" ,
                   "if-input-pps" : "Integer" ,
                   "if-input-bps" : "Integer" ,
                   "admin-status" : "String" ,
                   "if-name" : "String" ,
                   "if-output-pps" : "Integer" ,
                   "if-output-bps" : "Integer" ,
                   "intf-flapped" : "String"
                 }
               } ,
               "system-booted-time" : "String" ,
               "protocols-started-time" : "String" ,
               "tcp-rcv-packets-dropped" : "Integer" ,
               "last-configured-time" : "String" ,
               "udp-datagrams-received" : "Integer" ,
               "tcp-packets-sent" : "Integer" ,
               "system-current-time" : "String" ,
               "ipsec-inbound-packets" : "Integer" ,
               "flow-pkt-count-drop" : "Integer" ,
               "system-uptime" : "String" ,
               "flow-pkt-count" : "Integer"
             }
           } ,
           "device-connection-state" : "vcenterNotMonitored" ,
           "device-hostname" : "String" ,
           "vm-name" : "String"
         } ,
         "vm-usage" : {
           "vc-name" : "String" ,
           "vcenter-connection-state" : "vcenterNotMonitored" ,
           "id" : "Integer" ,
           "vm-name" : "String" ,
           "vm-id" : "String" ,
           "perf-data" : {
             "@total" : "Integer" ,
             "@uri" : "/api/juniper/vdirector/monitor/vm-datas/perf-data" ,
             "vm-perf-data" : {
               "uptime-seconds" : "Long" ,
               "mem-used-mb" : "Float" ,
               "cpu-used-mhz" : "Float" ,
               "formatted-uptime" : "String" ,
               "time-data-obtained" : "java.util.Date" ,
               "cpu-used-percent" : "Float"
             }
           } ,
           "data-complete" : "Boolean" ,
           "total-usage-hours" : "Integer"
         }
       }
    }