/api/juniper/vdirector/groups/group-vms

The following operations are supported on this resource:

• GET

GET /api/juniper/vdirector/groups/group-vms (v1)

Access Control

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

Example Usage

Parameters

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.groups.vminstance-refs+xml;version=1;q=0.01
  application/net.juniper.vdirector.groups.vminstance-refs+json;version=1;q=0.01



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



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