Monitor API

/api/juniper/vdirector/monitor/vms

The following operations are supported on this resource:

GET /api/juniper/vdirector/monitor/vms (v1)


Access Control

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


Example Usage

GET /api/juniper/vdirector/monitor/vms

Data Notification

This API supports data notification.

See the following links for information about enabling data notifications changes to be received for this service:

  • Data Notification Usage.


Content Types

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


  • Sample Output XML:
    <vminstances total="Integer" uri="/api/juniper/vdirector/monitor/vms">
         <vminstance href="/api/juniper/vdirector/monitor/vms/{id}" uri="/api/juniper/vdirector/monitor/vms/{id}">
               <cluster-name>String</cluster-name>
               <v-cpus>Integer</v-cpus>
               <dc-name>String</dc-name>
               <cpu-usage>Integer</cpu-usage>
               <ipaddress>String</ipaddress>
               <guest-mem-usage>Integer</guest-mem-usage>
               <id>Integer</id>
               <annotation>String</annotation>
               <vc-hostname>String</vc-hostname>
               <name>String</name>
               <resource-pool-name>String</resource-pool-name>
               <device-id>Integer</device-id>
               <vc-name>String</vc-name>
               <host-mem-usage>Integer</host-mem-usage>
               <vm-type>String</vm-type>
               <alloc-mem>Integer</alloc-mem>
               <hostname>String</hostname>
               <vm-provision-initiator>String</vm-provision-initiator>
               <vi-id>String</vi-id>
               <v-nics>Integer</v-nics>
               <vm-status>String</vm-status>
               <time-modified>java.util.Date</time-modified>
               <vm-host-name>String</vm-host-name>
               <folder-name>String</folder-name>
               <uuid>String</uuid>
         </vminstance>
    </vminstances>


  • Sample Output JSON:
    {
       "vminstances" : {
         "@total" : "Integer" ,
         "@uri" : "/api/juniper/vdirector/monitor/vms" ,
         "vminstance" : {
           "@href" : "/api/juniper/vdirector/monitor/vms/{id}" ,
           "@uri" : "/api/juniper/vdirector/monitor/vms/{id}" ,
           "cluster-name" : "String" ,
           "v-cpus" : "Integer" ,
           "dc-name" : "String" ,
           "cpu-usage" : "Integer" ,
           "ipaddress" : "String" ,
           "guest-mem-usage" : "Integer" ,
           "id" : "Integer" ,
           "annotation" : "String" ,
           "vc-hostname" : "String" ,
           "name" : "String" ,
           "resource-pool-name" : "String" ,
           "device-id" : "Integer" ,
           "vc-name" : "String" ,
           "host-mem-usage" : "Integer" ,
           "vm-type" : "String" ,
           "alloc-mem" : "Integer" ,
           "hostname" : "String" ,
           "vm-provision-initiator" : "String" ,
           "vi-id" : "String" ,
           "v-nics" : "Integer" ,
           "vm-status" : "String" ,
           "time-modified" : "java.util.Date" ,
           "vm-host-name" : "String" ,
           "folder-name" : "String" ,
           "uuid" : "String"
         }
       }
    }