Groups API

/api/juniper/vdirector/groups/group-by-names

The following operations are supported on this resource:

  • GET - Gets a group's details whose name is passed as parameter

GET /api/juniper/vdirector/groups/group-by-names (v1)


Gets a group's details whose name is passed as parameter.

Access Control

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


Example Usage

GET /api/juniper/vdirector/groups/group-by-names?name=<name>


Parameters

NameTypeURI TypeDescriptionRequired
nameStringQuery   Y

Content Types

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


  • Sample Output XML:
    <groupobject href="/api/juniper/vdirector/groups/groups/{id}" uri="/api/juniper/vdirector/groups/group-by-names">
         <static-vms uri="/api/juniper/vdirector/groups/group-by-names/static-vms">
               <static-member>
                   <uuid>String</uuid>
               </static-member>
         </static-vms>
         <desc>String</desc>
         <date-modified>java.util.Date</date-modified>
         <num-exprs>Integer</num-exprs>
         <group-type>BUILTIN</group-type>
         <id>Integer</id>
         <name>String</name>
         <date-created>java.util.Date</date-created>
         <smart-def-str>String</smart-def-str>
         <smart-def uri="/api/juniper/vdirector/groups/group-by-names/smart-def">
               <smart-expr>
                   <comp>EQUALS</comp>
                   <value>String</value>
                   <match>NONE</match>
                   <prop>VI_ATTRIBUTE</prop>
               </smart-expr>
         </smart-def>
         <group-size>Integer</group-size>
    </groupobject>


  • Sample Output JSON:
    {
       "groupobject" : {
         "@href" : "/api/juniper/vdirector/groups/groups/{id}" ,
         "@uri" : "/api/juniper/vdirector/groups/group-by-names" ,
         "static-vms" : {
           "@uri" : "/api/juniper/vdirector/groups/group-by-names/static-vms" ,
           "static-member" : {
             "uuid" : "String"
           }
         } ,
         "desc" : "String" ,
         "date-modified" : "java.util.Date" ,
         "num-exprs" : "Integer" ,
         "group-type" : "BUILTIN" ,
         "id" : "Integer" ,
         "name" : "String" ,
         "date-created" : "java.util.Date" ,
         "smart-def-str" : "String" ,
         "smart-def" : {
           "@uri" : "/api/juniper/vdirector/groups/group-by-names/smart-def" ,
           "smart-expr" : {
             "comp" : "EQUALS" ,
             "value" : "String" ,
             "match" : "NONE" ,
             "prop" : "VI_ATTRIBUTE"
           }
         } ,
         "group-size" : "Integer"
       }
    }