REST API Resource Model

Media Type Diagram


Media Types

Media Type Index


Resource Model Tables

DeleteTargetList (net.juniper.vsm.provision.deleteTargets;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
targetVMTarget[]NY Y  

DeploySpecs (net.juniper.vsm.provision.deploySpecs;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
provisionTemplateStringNY Y  
bootConfigBootConfigNY Y  
vmSpecsVMSpecsNY Y  
provisionLocatorProvisionLocatorNY Y  
multiplierProvisionMultiplierNY Y  
saveAsTemplateStringNY Y  
templateNameStringNY Y  
templateVersionStringNY Y  
deployedByStringNY Y  

DiscoverTargetList (net.juniper.vsm.provision.discoverTargets;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
targetDiscoverVMTarget[]NY Y  

Groupobject (net.juniper.vdirector.groups.groupobject;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@hrefString(URI)YY N Link to an external Groupobject. Here, href points to the Groupobject in the primary Groupobjects collection.

Hyperlink Template: /api/juniper/vdirector/groups/groups/{id}.
@uriString(URI)YY N Link to this Groupobject node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobject in the tree path.

Hyperlink Template: /api/juniper/vdirector/groups/group-by-names.
static-vmsGroupobject.staticVmsNY Y *  
descStringNY Y * Description for the group.
date-modifiedDateNY Y * Date the group was modified.
num-exprsIntegerNY Y * Number of expressions in the group rule.
group-typeGroupTypeNY Y * Type of group.

Possible Values: BUILTIN, USER_DEFINED_SMART, USER_DEFINED_STATIC.
*idIntegerYY N Database ID of the group.
nameStringNY Y * Name of the group.
date-createdDateNY Y * Date group was created.
smart-def-strStringNY Y * String containing smart group rule.
smart-defGroupobject.smartDefsNY Y *  
group-sizeIntegerNY Y * Number of members in the group.

Groupobject.staticVms

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Groupobject.staticVms node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobject.staticVms in the tree path.

Hyperlink Template: /api/juniper/vdirector/groups/group-by-names/static-vms.
static-memberGroupobject.staticVms.staticMember[]NY Y *  

Groupobject.staticVms.staticMember

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this Groupobject.staticVms.staticMember node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobject.staticVms.staticMember in the tree path.
uuidStringNY Y * NNUUID for the VM.

Groupobject.smartDefs

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Groupobject.smartDefs node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobject.smartDefs in the tree path.

Hyperlink Template: /api/juniper/vdirector/groups/group-by-names/smart-def.
smart-exprGroupobject.smartDefs.smartExpr[]NY Y *  

Groupobject.smartDefs.smartExpr

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this Groupobject.smartDefs.smartExpr node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobject.smartDefs.smartExpr in the tree path.
compSmartGroupComparatorNY Y * NNComparator or operator for the expressions.

Possible Values: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS.
valueStringNY Y * NNValue operand of the expression.
matchSmartGroupMatchNY Y * NNLogical operator joining the expressions.

Possible Values: NONE, AND, OR.
propSmartGroupPropertyNY Y * NNProperty operand of the expression.

Possible Values: VI_ATTRIBUTE, VI_CLUSTER, VI_DATACENTER, VI_FOLDER, VI_HOST, VI_NAME, VI_NOTES, VI_PORTGROUP, VI_POWERSTATE, VI_RESOURCEPOOL.

Groupobjects (net.juniper.vdirector.groups.groupobjects;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Groupobjects node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobjects in the tree path.
@totalIntegerYY N Total number of groupobjects in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of groupobjects in all the pages of the result set.
groupobjectGroupobjects.groupobject[]NY Y *  

Groupobjects.groupobject

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external Groupobjects.groupobject. Here, href points to the Groupobjects.groupobject in the primary Groupobjects collection.

Hyperlink Template: /api/juniper/vdirector/groups/groups/{id}.
@uriString(URI)YY N NNLink to this Groupobjects.groupobject node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobjects.groupobject in the tree path.

Hyperlink Template: /api/juniper/vdirector/groups/groups/{id}.
group-typeGroupTypeNY Y * YYType of group.

Possible Values: BUILTIN, USER_DEFINED_SMART, USER_DEFINED_STATIC.
num-exprsIntegerNY Y * YNNumber of expressions in the group rule.
date-modifiedDateNY Y * YNDate the group was modified.
descStringNY Y * YNDescription for the group.
static-vmsGroupobjects.groupobject.staticVmsNY Y * YN 
idIntegerYY N YNDatabase ID of the group.
smart-defGroupobjects.groupobject.smartDefsNY Y * YN 
nameStringNY Y * YYName of the group.
group-sizeIntegerNY Y * YNNumber of members in the group.
smart-def-strStringNY Y * YNString containing smart group rule.
date-createdDateNY Y * YNDate group was created.

Groupobjects.groupobject.staticVms

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Groupobjects.groupobject.staticVms node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobjects.groupobject.staticVms in the tree path.

Hyperlink Template: /api/juniper/vdirector/groups/groups/{id}/static-vms.
static-memberGroupobjects.groupobject.staticVms.staticMember[]NY Y *  

Groupobjects.groupobject.staticVms.staticMember

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this Groupobjects.groupobject.staticVms.staticMember node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobjects.groupobject.staticVms.staticMember in the tree path.
uuidStringNY Y * NNUUID for the VM.

Groupobjects.groupobject.smartDefs

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Groupobjects.groupobject.smartDefs node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobjects.groupobject.smartDefs in the tree path.

Hyperlink Template: /api/juniper/vdirector/groups/groups/{id}/smart-def.
smart-exprGroupobjects.groupobject.smartDefs.smartExpr[]NY Y *  

Groupobjects.groupobject.smartDefs.smartExpr

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this Groupobjects.groupobject.smartDefs.smartExpr node in the current node context. This link can be used to retrieve or operate on the currently referenced Groupobjects.groupobject.smartDefs.smartExpr in the tree path.
compSmartGroupComparatorNY Y * NNComparator or operator for the expressions.

Possible Values: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS.
valueStringNY Y * NNValue operand of the expression.
matchSmartGroupMatchNY Y * NNLogical operator joining the expressions.

Possible Values: NONE, AND, OR.
propSmartGroupPropertyNY Y * NNProperty operand of the expression.

Possible Values: VI_ATTRIBUTE, VI_CLUSTER, VI_DATACENTER, VI_FOLDER, VI_HOST, VI_NAME, VI_NOTES, VI_PORTGROUP, VI_POWERSTATE, VI_RESOURCEPOOL.

GroupOperations (net.juniper.vdirector.groups.group-operations;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this GroupOperations node in the current node context. This link can be used to retrieve or operate on the currently referenced GroupOperations in the tree path.
@totalIntegerYY N Total number of group-operations in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of group-operations in all the pages of the result set.
group-operationString[]NY Y *  

GroupTypes (net.juniper.vdirector.groups.group-types;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this GroupTypes node in the current node context. This link can be used to retrieve or operate on the currently referenced GroupTypes in the tree path.
@totalIntegerYY N Total number of group-types in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of group-types in all the pages of the result set.
group-typeString[]NY Y *  

IDName (net.juniper.vsm.provision.template.idName;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
idintNY Y *  
nameStringNY Y *  

IDNameList (net.juniper.vsm.provision.template.idnameList;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of idnameList in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of idnameList in all the pages of the result set.
idnameIDName[]NY Y *  

InstancePerfData (net.juniper.vdirector.monitor.instance-perf-data;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@hrefString(URI)YY N Link to an external InstancePerfData. Here, href points to the InstancePerfData in the primary InstancePerfData collection.

Hyperlink Template: /api/juniper/vdirector/monitor/vm-datas/{id}.
@uriString(URI)YY N Link to this InstancePerfData node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData in the tree path.

Hyperlink Template: /api/juniper/vdirector/monitor/vm-datas.
*idIntegerYY N ID of this performance data.
device-usageInstancePerfData.deviceUsageNY Y *  
vm-usageInstancePerfData.vmUsageNY Y *  

InstancePerfData.deviceUsage

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this InstancePerfData.deviceUsage node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.deviceUsage in the tree path.
vc-nameStringNY Y * Name of the vCenter.
idIntegerYY N ID of this device usage entry.

Default: 0.
ip-addrStringNY Y * The IP address of the device.
data-completeBooleanNY Y * Flag indicating if the statistical data collection is complete.
vm-idStringNY Y * ID of the VM on the vCenter.
perf-dataInstancePerfData.deviceUsage.perfDatasNY Y  
device-connection-stateDataCollectorStatusNY Y * The state of the device connection to the Space system.

Possible Values: vcenterNotMonitored, vcenterDown, vcenterUnreachable, vcenterSuccessful, deviceDown, deviceUnreachable, deviceNotDiscovered, deviceNotMonitored, deviceSuccessful, unknown.
device-hostnameStringNY Y * Hostname of the device.
vm-nameStringNY Y * Name of the VM hosting the device.

InstancePerfData.deviceUsage.perfDatas

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this InstancePerfData.deviceUsage.perfDatas node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.deviceUsage.perfDatas in the tree path.

Hyperlink Template: /api/juniper/vdirector/monitor/vm-datas/perf-data.
@totalIntegerYY N Total number of gen_instance-perf-data-device-usage-perf-data in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_instance-perf-data-device-usage-perf-data in all the pages of the result set.
device-perf-dataInstancePerfData.deviceUsage.perfDatas.devicePerfData[]NY Y *  

InstancePerfData.deviceUsage.perfDatas.devicePerfData

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this InstancePerfData.deviceUsage.perfDatas.devicePerfData node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.deviceUsage.perfDatas.devicePerfData in the tree path.
ip-packets-forwardedIntegerNY Y * NNNumber of IP packets forwarded.
flow-pkt-count-fwdLongNY Y * NNNumber of flow packets count forwarded.
icmp-echo-replyIntegerNY Y * NNNumber of ICMP echo reply.
ip-packets-droppedIntegerNY Y * NNNumber of IP packets dropped.
time-data-obtainedDateNY Y * NNtime data was taken.
tcp-send-packets-droppedIntegerNY Y * NNNumber of TCP send packets dropped.
last-configured-userStringNY Y * NNName of last configured user.
ip-packets-receivedIntegerNY Y * NNNumber of IP packets received.
ipsec-outbound-packetsIntegerNY Y * NNNumber of IPSEC outbound packets.
tcp-packets-receivedIntegerNY Y * NNNumber of TCP Packets received.
active-user-countIntegerNY Y * NNNumber of active user count.
igmp-mesg-receivedIntegerNY Y * NNNumber of IGMP mesg received.
tcp-total-packets-discardedIntegerNY Y * NNTotal number of TCP packets discarded.
interfaces-infoInstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfosNY Y NN 
system-booted-timeStringNY Y * NNTime system was booted.
protocols-started-timeStringNY Y * NNTime protocols started.
tcp-rcv-packets-droppedIntegerNY Y * NNNumber of TCP received packets dropped.
last-configured-timeStringNY Y * NNTime device was last configured.
udp-datagrams-receivedIntegerNY Y * NNNumber of UDP datagrams received.
tcp-packets-sentIntegerNY Y * NNNumber of TCP packets sent.
system-current-timeStringNY Y * NNsystem current time.
ipsec-inbound-packetsIntegerNY Y * NNNumber of IPSEC inbound packets.
flow-pkt-count-dropIntegerNY Y * NNNumber of flow packets count drop.
system-uptimeStringNY Y * NNSystem uptime.
flow-pkt-countIntegerNY Y * NNNumber of flow packets count.

InstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfos

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this InstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfos node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfos in the tree path.

Hyperlink Template: /api/juniper/vdirector/monitor/vm-datas/perf-data/interfaces-info.
@totalIntegerYY N Total number of gen_instance-perf-data-device-usage-perf-data-perf-datas-interfaces-info in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_instance-perf-data-device-usage-perf-data-perf-datas-interfaces-info in all the pages of the result set.
device-intf-dataInstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfos.deviceIntfData[]NY Y *  

InstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfos.deviceIntfData

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this InstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfos.deviceIntfData node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.deviceUsage.perfDatas.devicePerfData.interfacesInfos.deviceIntfData in the tree path.
physical-addrStringNY Y * NNInterface physical address.
if-output-packetsIntegerNY Y * NNNumber of interface output packets.
if-input-packetsIntegerNY Y * NNNumber of interface input packets.
oper-statusStringNY Y * NNDevice operation status.
if-input-ppsIntegerNY Y * NNNumber of interface input packets per second.
if-input-bpsIntegerNY Y * NNNumber of interface input bytes per second.
admin-statusStringNY Y * NNAdministrator status.
if-nameStringNY Y * NNinterface name.
if-output-ppsIntegerNY Y * NNNumber of output packets per second.
if-output-bpsIntegerNY Y * NNNumber of interface output bytes per second.
intf-flappedStringNY Y * NNFlag for interface flapped.

InstancePerfData.vmUsage

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this InstancePerfData.vmUsage node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.vmUsage in the tree path.
vc-nameStringNY Y * Name of vCenter.
vcenter-connection-stateDataCollectorStatusNY Y * The status of the connection from the Space to vCenter.

Possible Values: vcenterNotMonitored, vcenterDown, vcenterUnreachable, vcenterSuccessful, deviceDown, deviceUnreachable, deviceNotDiscovered, deviceNotMonitored, deviceSuccessful, unknown.
idIntegerYY N ID for this VM usage.

Default: 0.
vm-nameStringNY Y * Name of VM hosting the device.
vm-idStringNY Y * ID of the VM on vCenter.
perf-dataInstancePerfData.vmUsage.perfDatasNY Y  
data-completeBooleanNY Y * Flag indicating if VM statistical data collection is complete.
total-usage-hoursIntegerNY Y * Number of total usage hours.

InstancePerfData.vmUsage.perfDatas

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this InstancePerfData.vmUsage.perfDatas node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.vmUsage.perfDatas in the tree path.

Hyperlink Template: /api/juniper/vdirector/monitor/vm-datas/perf-data.
@totalIntegerYY N Total number of gen_instance-perf-data-vm-usage-perf-data in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of gen_instance-perf-data-vm-usage-perf-data in all the pages of the result set.
vm-perf-dataInstancePerfData.vmUsage.perfDatas.vmPerfData[]NY Y *  

InstancePerfData.vmUsage.perfDatas.vmPerfData

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this InstancePerfData.vmUsage.perfDatas.vmPerfData node in the current node context. This link can be used to retrieve or operate on the currently referenced InstancePerfData.vmUsage.perfDatas.vmPerfData in the tree path.
uptime-secondsLongNY Y * NNVM uptime in seconds.
mem-used-mbFloatNY Y * NNmemory in use in megabytes.
cpu-used-mhzFloatNY Y * NNCPU in used in MHz.
formatted-uptimeStringNY Y * NNFormatted VM uptime.
time-data-obtainedDateNY Y * NNtime data was taken.
cpu-used-percentFloatNY Y * NNCPU in used in percent.

ManageSpecs (net.juniper.vdirector.groups.manage-specs;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this ManageSpecs node in the current node context. This link can be used to retrieve or operate on the currently referenced ManageSpecs in the tree path.
group-typeGroupTypeNY Y * Type of group.

Possible Values: BUILTIN, USER_DEFINED_SMART, USER_DEFINED_STATIC.
operationGroupOperationNY Y * Operation to be performed on group.

Possible Values: CREATE, DELETE, MODIFY, VIEW.
idIntegerYY N Database ID of group.
descStringNY Y * Description of group.
nameStringNY Y * Group name.
smart-defManageSpecs.smartDefsNY Y  
static-vmsManageSpecs.staticVmsNY Y  

ManageSpecs.smartDefs

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this ManageSpecs.smartDefs node in the current node context. This link can be used to retrieve or operate on the currently referenced ManageSpecs.smartDefs in the tree path.

Hyperlink Template: /smart-def.
smart-exprManageSpecs.smartDefs.smartExpr[]NY Y *  

ManageSpecs.smartDefs.smartExpr

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this ManageSpecs.smartDefs.smartExpr node in the current node context. This link can be used to retrieve or operate on the currently referenced ManageSpecs.smartDefs.smartExpr in the tree path.
compSmartGroupComparatorNY Y * NNComparator or operator for the expressions.

Possible Values: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS.
valueStringNY Y * NNValue operand of the expression.
matchSmartGroupMatchNY Y * NNLogical operator joining the expressions.

Possible Values: NONE, AND, OR.
propSmartGroupPropertyNY Y * NNProperty operand of the expression.

Possible Values: VI_ATTRIBUTE, VI_CLUSTER, VI_DATACENTER, VI_FOLDER, VI_HOST, VI_NAME, VI_NOTES, VI_PORTGROUP, VI_POWERSTATE, VI_RESOURCEPOOL.

ManageSpecs.staticVms

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this ManageSpecs.staticVms node in the current node context. This link can be used to retrieve or operate on the currently referenced ManageSpecs.staticVms in the tree path.

Hyperlink Template: /static-vms.
static-memberManageSpecs.staticVms.staticMember[]NY Y *  

ManageSpecs.staticVms.staticMember

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this ManageSpecs.staticVms.staticMember node in the current node context. This link can be used to retrieve or operate on the currently referenced ManageSpecs.staticVms.staticMember in the tree path.
uuidStringNY Y * NNUUID of the VM belonging in the static group.

ModifySpecsList (net.juniper.vsm.provision.modifyList;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
modifySpecModifySpecs[]NY Y  

OVF (net.juniper.vsm.provision.template.ovf;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
idintNY Y *  
nameStringNY Y *  
productStringNY Y *  
vmdkSizeStringNY Y  
versionStringNY Y  
osStringNY Y  
cpuStringNY Y  
memoryStringNY Y  
diskStringNY Y  

OVFList (net.juniper.vsm.provision.template.ovflist;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of idnameList in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of idnameList in all the pages of the result set.
idnameIDName[]NY Y *  

OVFObjectList (net.juniper.vsm.provision.template.ovfobjects;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of ovfObjects in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of ovfObjects in all the pages of the result set.
ovfOVF[]NY Y *  

ProvisionRequestStatus (net.juniper.vsm.provision.jobstatus;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
idintNY Y  
requestIDStringNY Y  
requestTypeStringNY Y  
stateProvisionRequestStateNY Y

Possible Values: created, queued, started, completed, failed, timedout, unknown.
percentStringNY Y  
summaryStringNY Y  
enqueTimeDateNY Y  
startTimeDateNY Y  
endTimeDateNY Y  

ProvisionRequestStatusList (net.juniper.vsm.provision.alljobstatus;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of alljobstatus in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of alljobstatus in all the pages of the result set.
requestProvisionRequestStatusList.provisionRequestStatus[]NY Y  

ProvisionRequestStatusList.provisionRequestStatus

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
idintNY Y NN 
requestIDStringNY Y NN 
requestTypeStringNY Y NN 
stateProvisionRequestStateNY Y NN

Possible Values: created, queued, started, completed, failed, timedout, unknown.
percentStringNY Y NN 
summaryStringNY Y NN 
enqueTimeDateNY Y NN 
startTimeDateNY Y NN 
endTimeDateNY Y NN 

ProvisionTaskLogList (net.juniper.vsm.provision.taskloglist;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of taskloglist in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of taskloglist in all the pages of the result set.
logProvisionTaskLog[]NY Y  

ProvisionTemplate (net.juniper.vsm.provision.template.provisionTemplate;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
idintNY Y  
nameStringNY Y *  
productStringNY Y  
bootConfigBootConfigNY Y *  
vmSpecsVMSpecsNY Y *  
vmTemplateStringNY Y *  
provisionLocatorProvisionLocatorNY Y *  
swVersionStringNY Y  
nextStartIPStringNY Y  
nextHostnameSeqintNY Y  
nextVMNameSeqintNY Y  
deployedStringNY Y  
pendingOperationStringNY Y  

ProvisionTemplateList (net.juniper.vsm.provision.template.provisionTemplates;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of provisionTemplates in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of provisionTemplates in all the pages of the result set.
templateProvisionTemplateList.provisionTemplate[]NY Y *  

ProvisionTemplateList.provisionTemplate

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
idintNY Y NN 
nameStringNY Y * YY 
productStringNY Y NN 
bootConfigBootConfigNY Y * NN 
vmSpecsVMSpecsNY Y NN 
vmTemplateStringNY Y * YY 
provisionLocatorProvisionLocatorNY Y * NN 
swVersionStringNY Y YY 
nextStartIPStringNY Y NN 
nextHostnameSeqintNY Y NN 
nextVMNameSeqintNY Y NN 
deployedStringNY Y NN 

SmartGroupComparators (net.juniper.vdirector.groups.smart-group-comparators;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this SmartGroupComparators node in the current node context. This link can be used to retrieve or operate on the currently referenced SmartGroupComparators in the tree path.
@totalIntegerYY N Total number of smart-group-comparators in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of smart-group-comparators in all the pages of the result set.
smart-group-comparatorString[]NY Y *  

SmartGroupMatchs (net.juniper.vdirector.groups.smart-group-matchs;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this SmartGroupMatchs node in the current node context. This link can be used to retrieve or operate on the currently referenced SmartGroupMatchs in the tree path.
@totalIntegerYY N Total number of smart-group-matchs in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of smart-group-matchs in all the pages of the result set.
smart-group-matchString[]NY Y *  

SmartGroupProperties (net.juniper.vdirector.groups.smart-group-properties;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this SmartGroupProperties node in the current node context. This link can be used to retrieve or operate on the currently referenced SmartGroupProperties in the tree path.
@totalIntegerYY N Total number of smart-group-properties in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of smart-group-properties in all the pages of the result set.
smart-group-propertyString[]NY Y *  

StateChange (net.juniper.vsm.provision.stateChange;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
targetVMTarget[]NY Y  
desiredStateStringNY Y  

TemplateIDNameList (net.juniper.vsm.provision.template.templateNames;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of templateNames in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of templateNames in all the pages of the result set.
listTemplateIDName[]NY Y *  

Virtualprovider (net.juniper.vdirector.vconnector.virtualprovider;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Virtualprovider node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/juniper/vdirector/vconnector/virtualproviders/{id}.
@hrefString(URI)YY N Link to an external Virtualprovider. Here, href points to the Virtualprovider in the primary Virtualproviders collection.

Hyperlink Template: /api/juniper/vdirector/vconnector/virtualproviders/{id}.
vprovider-typeVirtualProviderTypeNY Y *

Possible Values: VMWARE.
total-data-centersIntegerNY Y *  
vprovider-nameStringNY Y *  
vprovider-versionStringNY Y *  
modify-dateDateNY Y *  
server-nameStringNY Y *  
deletedBooleanNY Y *  
passwordStringNY Y *  
total-hostsIntegerNY Y *  
*idIntegerYY N  

Default: 0.
user-nameStringNY Y *  
uuidStringNY Y *  
create-dateDateNY Y *  
active-connectionsIntegerNY Y *  
total-virtual-machinesIntegerNY Y *  
disabledBooleanNY Y *  
ip-addressStringNY Y *  

Virtualproviderobjects (net.juniper.vdirector.monitor.virtualproviderobjects;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Virtualproviderobjects node in the current node context. This link can be used to retrieve or operate on the currently referenced Virtualproviderobjects in the tree path.
@totalIntegerYY N Total number of virtualproviderobjects in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of virtualproviderobjects in all the pages of the result set.
virtualproviderobjectVirtualproviderobjects.virtualproviderobject[]NY Y *  

Virtualproviderobjects.virtualproviderobject

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external Virtualproviderobjects.virtualproviderobject. Here, href points to the Virtualproviderobjects.virtualproviderobject in the primary Virtualproviderobjects collection.

Hyperlink Template: /api/juniper/vdirector/monitor/vp-status/{mOID}.
@uriString(URI)YY N NNLink to this Virtualproviderobjects.virtualproviderobject node in the current node context. This link can be used to retrieve or operate on the currently referenced Virtualproviderobjects.virtualproviderobject in the tree path.

Hyperlink Template: /api/juniper/vdirector/monitor/vp-status/{mOID}.
vp-statusVirtualProviderStatusNY Y * NNStatus of the virtual provider.

Possible Values: unreachable, unresponsive, inaccessible, down, up, unknown.
vp-hostnameStringNY Y * NNHostname of the virtual provider.
vp-last-sync-timeDateNY Y * NNTime the Virtual Director was last synced with the vCenter.
moidStringYY N NNManaged Object ID.

VirtualProviderQuery (net.juniper.vsm.provision.template.resourceQuery;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
hostStringNY Y  
pathStringNY Y  
typeStringNY Y  

Virtualproviders (net.juniper.vdirector.vconnector.virtualproviders;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Virtualproviders node in the current node context. This link can be used to retrieve or operate on the currently referenced Virtualproviders in the tree path.
@totalIntegerYY N Total number of virtualproviders in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of virtualproviders in all the pages of the result set.
virtualproviderVirtualproviders.virtualprovider[]NY Y *  

Virtualproviders.virtualprovider

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@uriString(URI)YY N NNLink to this Virtualproviders.virtualprovider node in the current node context. This link can be used to retrieve or operate on the currently referenced Virtualproviders.virtualprovider in the tree path.

Hyperlink Template: /api/juniper/vdirector/vconnector/virtualproviders/{id}.
@hrefString(URI)YY N NNLink to an external Virtualprovider. Here, href points to the Virtualprovider in the primary Virtualproviders collection.

Hyperlink Template: /api/juniper/vdirector/vconnector/virtualproviders/{id}.
vprovider-typeVirtualProviderTypeNY Y * YY

Possible Values: VMWARE.
total-data-centersIntegerNY Y * NN 
vprovider-nameStringNY Y * YY 
vprovider-versionStringNY Y * YY 
modify-dateDateNY Y * YY 
server-nameStringNY Y * YY 
deletedBooleanNY Y * NN 
passwordStringNY Y * NN 
total-hostsIntegerNY Y * NN 
idIntegerYY N YY 

Default: 0.
user-nameStringNY Y * NN 
uuidStringNY Y * NN 
create-dateDateNY Y * YY 
active-connectionsIntegerNY Y * NN 
total-virtual-machinesIntegerNY Y * NN 
disabledBooleanNY Y * NN 
ip-addressStringNY Y * NN 

Vminstance (net.juniper.vdirector.monitor.vminstance;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@hrefString(URI)YY N Link to an external Vminstance. Here, href points to the Vminstance in the primary Vminstances collection.

Hyperlink Template: /api/juniper/vdirector/monitor/vms/{id}.
@uriString(URI)YY N Link to this Vminstance node in the current node context. For primary collection members, href and uri are always the same.

Hyperlink Template: /api/juniper/vdirector/monitor/vms/{vi-id}.
cluster-nameStringNY Y * Name of cluster.
v-cpusIntegerNY Y * Number of CPUs.
dc-nameStringNY Y * Name of datacenter.
cpu-usageIntegerNY Y * Number of CPUs used.
ipaddressStringNY Y * IP address of the device.
guest-mem-usageIntegerNY Y * Guest memory usage.
*idIntegerYY N Database ID of this VM.
annotationStringNY Y * Notes annotation for this VM.
vc-hostnameStringNY Y * Hostname of the vCenter.
nameStringNY Y * Name of the VM.
resource-pool-nameStringNY Y * Name of resource pool.
device-idIntegerNY Y * ID for the device generated by Space.
vc-nameStringNY Y * Name of vCenter.
vm-typeStringNY Y * Type of VM.
host-mem-usageIntegerNY Y * Host memory usage.
alloc-memIntegerNY Y * Memory allocated.
hostnameStringNY Y * Hostname of the device.
vm-provision-initiatorStringNY Y * Flag to indicate if VM was provisioned by Virtual Director.
vi-idStringNY Y * ID of the VM on vCenter.
v-nicsIntegerNY Y * Number of NICs.
time-modifiedDateNY Y * Time this VM was modified.
vm-statusStringNY Y * Status of this VM.
vm-host-nameStringNY Y * Host name for this VM.
folder-nameStringNY Y * Folder name.
uuidStringNY Y * UUID for this VM on vCenter.
attributesVminstance.attributesNY Y  
port-groupsVminstance.portGroupsNY Y  

Vminstance.attributes

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Vminstance.attributes node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstance.attributes in the tree path.
attributeString[]NY Y * Attributes annotation for this VM.

Vminstance.portGroups

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Vminstance.portGroups node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstance.portGroups in the tree path.
port-groupString[]NY Y * Portgroups for this VM.

Vminstance_REFs (net.juniper.vdirector.groups.vminstance-refs;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Vminstances node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstances in the tree path.
@totalIntegerYY N Total number of vminstances in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of vminstances in all the pages of the result set.
vminstanceVminstance_REFs.vminstance[]NY Y *  

Vminstance_REFs.vminstance

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@hrefString(URI)NY Y * NNLink to an external Vminstance_REFs.vminstance. Here, href points to the Vminstance_REFs.vminstance in the primary Vminstance_REFs.vminstance collection.

Hyperlink Template: /api/juniper/vdirector/monitor/vms/{id}.
@uriString(URI)YY N NNLink to this Vminstances.vminstance node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstances.vminstance in the tree path.

Hyperlink Template: /api/juniper/vdirector/groups/group-vms/{id}.
vm-provision-initiatorStringNY Y NNFlag indicating if VM was provisioned by Virtual Director.
v-nicsIntegerNY Y YNNumber of NICs.
vm-statusStringNY Y NNStatus of VM (can be poweredOn or poweredOff).
cpu-usageIntegerNY Y YNCPU resource used.
vm-typeStringNY Y YYType of VM.
alloc-memIntegerNY Y YNMemory allocated.
host-mem-usageIntegerNY Y YNHost memory usage.
ipaddressStringNY Y YYIP address of the device.
hostnameStringNY Y YYHostname of the device.
device-idIntegerNY Y NNID of the device generated by Space system.
v-cpusIntegerNY Y YNNumber of CPUs.
time-modifiedDateNY Y NNTime this VM was modified.
dc-nameStringNY Y YYDatacenter name.
uuidStringNY Y YYUUID of this VM on vCenter.
annotationStringNY Y NNNotes annotation of the VM.
vc-hostnameStringNY Y NNVcenter hostname.
cluster-nameStringNY Y YYCluster name.
vc-nameStringNY Y YYvCenter name.
idIntegerYY N YNDatabase ID of the VM.
nameStringNY Y YYName of the VM.
resource-pool-nameStringNY Y YYResource pool name.
vm-host-nameStringNY Y YYHost name for the VM.
folder-nameStringNY Y YYFolder name.
port-groupsVminstance_REFs.vminstance.portGroupsNY Y * NN 
attributesVminstance_REFs.vminstance.attributesNY Y * NN 

Vminstance_REFs.vminstance.portGroups

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Vminstances.vminstance.portGroups node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstances.vminstance.portGroups in the tree path.
port-groupString[]NY Y * Port groups for the VM.

Vminstance_REFs.vminstance.attributes

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Vminstances.vminstance.attributes node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstances.vminstance.attributes in the tree path.
attributeString[]NY Y * Attributes annotation of the VM.

Vminstances (net.juniper.vdirector.monitor.vminstances;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@uriString(URI)YY N Link to this Vminstances node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstances in the tree path.
@totalIntegerYY N Total number of vminstances in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of vminstances in all the pages of the result set.
vminstanceVminstances.vminstance[]NY Y *  

Vminstances.vminstance

Field NameTypeRead OnlyGETPUT/POSTSortFilterDescription
@hrefString(URI)YY N NNLink to an external Vminstance. Here, href points to the Vminstance in the primary Vminstances collection.

Hyperlink Template: /api/juniper/vdirector/monitor/vms/{id}.
@uriString(URI)YY N NNLink to this Vminstances.vminstance node in the current node context. This link can be used to retrieve or operate on the currently referenced Vminstances.vminstance in the tree path.

Hyperlink Template: /api/juniper/vdirector/monitor/vms/{id}.
cluster-nameStringNY Y * YYName of cluster.
v-cpusIntegerNY Y * YNNumber of CPUs.
dc-nameStringNY Y * YYName of datacenter.
cpu-usageIntegerNY Y * YNNumber of CPUs used.
ipaddressStringNY Y * YYIP address of the device.
guest-mem-usageIntegerNY Y * YNGuest memory usage.
idIntegerYY N YNDatabase ID of this VM.
annotationStringNY Y * NNNotes annotation for this VM.
vc-hostnameStringNY Y * NNHostname of the vCenter.
nameStringNY Y * YYName of the VM.
resource-pool-nameStringNY Y * YYName of resource pool.
device-idIntegerNY Y * NNID for the device generated by Space.
vc-nameStringNY Y * YYName of vCenter.
host-mem-usageIntegerNY Y * YNHost memory usage.
vm-typeStringNY Y * YYType of VM.
alloc-memIntegerNY Y * YNMemory allocated.
hostnameStringNY Y * YYHostname of the device.
vm-provision-initiatorStringNY Y * NNFlag to indicate if VM was provisioned by Virtual Director.
vi-idStringNY Y * YYID of the VM on vCenter.
v-nicsIntegerNY Y * YNNumber of NICs.
vm-statusStringNY Y * YYStatus of this VM.
time-modifiedDateNY Y * NNTime this VM was modified.
vm-host-nameStringNY Y * YYHost name for this VM.
folder-nameStringNY Y * YYFolder name.
uuidStringNY Y * YYUUID for this VM on vCenter.

VSRXList (net.juniper.vsm.provision.vsrxes;version=1)

Field NameTypeRead OnlyGETPUT/POSTDescription
@totalintNY Y * Total number of vsrxes in the API result set. If paging parameters are used in the query to limit the result set size, then total represents the total number of vsrxes in all the pages of the result set.
vsrxVSRX[]NY Y *  

Deprecated

This section lists all deprecated media types.