Name: VirtualMachineFilterSpec

VirtualMachine query parameter filter

Data Structure
{
   "typeId": "com.tintri.api.rest.v310.dto.VirtualMachineFilterSpec",
   "affinityRuleTypes": [<String>],
   "allStats": <Boolean>,
   "bytesRemainingMB": <String>,
   "changeMBPerDay": <String>,
   "cloneDedupeFactor": <String>,
   "cloneFrom": <String>,
   "compressionFactor": <String>,
   "cpuPercent": <String>,
   "cpuReadyPercent": <String>,
   "cpuSwapWaitPercent": <String>,
   "datastores": [<String>],
   "dedupeFactor": <String>,
   "deleted": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "filterAttributeList": [SortFilterAttribute],
   "filterParams": MultivaluedMap,
   "flashHitPercent": <String>,
   "hasSnapshots": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "highFrequencySnapshotEnabled": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "host": <String>,
   "hosts": [<String>],
   "hypervisorManagerDisplayName": <String>,
   "hypervisorPath": <String>,
   "hypervisorPathPrefixes": [<String>],
   "hypervisorType": [<String>],
   "includeComposition": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "instanceUuid": <String>,
   "ioAlignedPercent": <String>,
   "lastReplicatedSnapshotDate": <String>,
   "lastSnapshotDate": <String>,
   "latencyContentionMs": <String>,
   "latencyDiskMs": <String>,
   "latencyFlashMs": <String>,
   "latencyHostMs": <String>,
   "latencyNetworkMs": <String>,
   "latencyStorageMs": <String>,
   "latencyThrottleMs": <String>,
   "latencyTotalMs": <String>,
   "latestSliceUuid": <String>,
   "limit": <Number>,
   "live": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "liveLogicalFootprint": <String>,
   "maxNormalizedIops": <String>,
   "metric": <String>,
   "migrationBytesRemainingMB": <String>,
   "migrationDestination": <String>,
   "migrationThroughputLogicalMBps": <String>,
   "migrationThroughputPhysicalMBps": <String>,
   "minNormalizedIops": <String>,
   "name": <String>,
   "offset": <Number>,
   "offsetType": 'POSITION' | 'NAME' | 'UUID' | 'INVALID',
   "offsetValue": <Object>,
   "page": <Number>,
   "performanceReserveAutoAllocated": <String>,
   "performanceReserveChange": <String>,
   "performanceReserveChangePercent": <String>,
   "performanceReserveUsed": <String>,
   "policyErrorCodes": [<String>],
   "powered": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "protections": [<String>],
   "provisionedType": [<String>],
   "qosConfigured": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "qParams": MultivaluedMap,
   "QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAX": <Number>,
   "QUERY_TIMEOUT_IN_SEC_DEFAULT": <Number>,
   "QUERY_TIMEOUT_IN_SEC_MAX": <Number>,
   "queryType": 'TOP_DOCS_BY_TIME' | 'TOP_DOCS_BY_LATEST_TIME' | 'OFFSET_BY_TIME' | 'OFFSET_BY_SEQUENCE',
   "refresh": <Boolean>,
   "replDestination": <String>,
   "replicationHasIssue": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "replLinkId": Uuid,
   "replLinkIds": [<String>],
   "replSource": <String>,
   "replState": [<String>],
   "requestSizeKiB": <String>,
   "serviceGroupId": <String>,
   "serviceGroupIds": [<String>],
   "serviceGroupName": <String>,
   "since": <Date>,
   "snapshotScheduleType": [<String>],
   "sortedBy": <String>,
   "sortOrder": <String>,
   "spaceProvisionedGiB": <String>,
   "spaceSavingsFactor": <String>,
   "spaceUsedChangeGiB": <String>,
   "spaceUsedChangePercent": <String>,
   "spaceUsedGiB": <String>,
   "spaceUsedLiveGiB": <String>,
   "spaceUsedSnapshotsHypervisorGiB": <String>,
   "spaceUsedSnapshotsTintriGiB": <String>,
   "storageContainer": <String>,
   "storageContainerId": <String>,
   "subdir": <String>,
   "syslogForwarding": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP',
   "template": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "throughputLogicalMBps": <String>,
   "throughputPhysicalMBps": <String>,
   "timeout": <Number>,
   "timeRemainingSeconds": <String>,
   "totalIops": <String>,
   "totalMBps": <String>,
   "totalNormalizedIops": <String>,
   "totalUsedSpace": <String>,
   "types": [<String>],
   "until": <Date>,
   "useDefaultSchedule": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "uuid": <String>,
   "vcenterName": <String>,
   "vcenterNames": [<String>],
}

Elements
NameTypeDescription
affinityRuleTypesxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: affinityRuleTypes
Description: The affinityRuleTypes of the VMs, can be one or more of (NONE, NEVER, EXCLUDE_DATASTORES)
Multivalued: Yes
Usage:
  • ?affinityRuleTypes=value1[,value2,value3..] OR
  • ?affinityRuleTypes=value1[&affinityRuleTypes=value2&affinityRuleTypes=value3...]
allStatsxsd:boolean
For query param info, refer to: allStats
bytesRemainingMBxsd:string
Query Param Info: (VMstoreOnly)
Param Name: bytesRemainingMB
Description: Numeric filter on logical amount of data(MB) yet to be replicated for a VM specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.replication.bytesRemainingMB
Usage: ?bytesRemainingMB=value
changeMBPerDayxsd:string
Query Param Info:
Param Name: changeMBPerDay
Description: Numeric filter on snapshot change rate(MB/Day) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.changeMBPerDay
Usage: ?changeMBPerDay=value
cloneDedupeFactorxsd:string
For query param info, refer to: cloneDedupeFactor
cloneFromxsd:string
Query Param Info:
Param Name: cloneFrom
Description: cloned from a snapshot
Multivalued: No
Mapped to attributes:
  • VirtualMachine.snapshot.cloneFromSnapshot
Usage: ?cloneFrom=value
compressionFactorxsd:string
For query param info, refer to: compressionFactor
cpuPercentxsd:string
Query Param Info:
Param Name: cpuPercent
Description: Numeric filter on '%' CPU usage specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.cpuPercent
Usage: ?cpuPercent=value
cpuReadyPercentxsd:string
Query Param Info: (VMstoreOnly)
Param Name: cpuReadyPercent
Description: Numeric filter on '%' CPU time specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.readyPercent
Usage: ?cpuReadyPercent=value
cpuSwapWaitPercentxsd:string
Query Param Info: (VMstoreOnly)
Param Name: cpuSwapWaitPercent
Description: Numeric filter on '%' CPU time spent waiting for swap-in specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.swapWaitPercent
Usage: ?cpuSwapWaitPercent=value
datastoresxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: datastores
Description: The datastores of the requested VMs
Multivalued: Yes
Usage:
  • ?datastores=value1[,value2,value3..] OR
  • ?datastores=value1[&datastores=value2&datastores=value3...]
dedupeFactorxsd:string
For query param info, refer to: dedupeFactor
deletedBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: deleted
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.isDeleted
Usage: ?deleted=value
filterAttributeListxsd:list[SortFilterAttribute]Iterates over all the @Filter query params and builds SortFilterAttribute objects from it. SortFilterAttribute wraps attribute name and String value; per mapped attribute.
filterParamsMultivaluedMap
flashHitPercentxsd:string
For query param info, refer to: flashHitPercent
hasSnapshotsBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: hasSnapshots
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.hasSnapshots
Usage: ?hasSnapshots=value
highFrequencySnapshotEnabledBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: highFrequencySnapshotEnabled
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.snapshot.highFrequencySnapshotConfig.isEnabled
Usage: ?highFrequencySnapshotEnabled=value
hostxsd:string
Query Param Info:
Param Name: host
Description: Virtual machine host name
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.host
Usage: ?host=value
hostsxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: hosts
Description: The hosts of the requested VMs
Multivalued: Yes
Usage:
  • ?hosts=value1[,value2,value3..] OR
  • ?hosts=value1[&hosts=value2&hosts=value3...]
hypervisorManagerDisplayNamexsd:string
Query Param Info:
Param Name: hypervisorManagerDisplayName
Description: Hypervisor manager display name
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.hypervisorManagerDisplayName
Usage: ?hypervisorManagerDisplayName=value
hypervisorPathxsd:string
Query Param Info:
Param Name: hypervisorPath
Description: hypervisor path for a VM
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.hypervisorPath
Usage: ?hypervisorPath=value
hypervisorPathPrefixesxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: hypervisorPathPrefixes
Description: The Prefix match of the hypervisorPath for the requested VMs
Multivalued: Yes
Usage:
  • ?hypervisorPathPrefixes=value1[,value2,value3..] OR
  • ?hypervisorPathPrefixes=value1[&hypervisorPathPrefixes=value2&hypervisorPathPrefixes=value3...]
hypervisorTypexsd:list[xsd:string]
Query Param Info:
Param Name: hypervisorType
Description: One or more of (VMWARE, RHEV, HYPERV, OPENSTACK, XENSERVER, VMWARE_VVOL, UNKNOWN)
Multivalued: Yes
Mapped to attributes:
  • VirtualMachine.vmware.hypervisorType
Usage:
  • ?hypervisorType=value1[,value2,value3..] OR
  • ?hypervisorType=value1[&hypervisorType=value2&hypervisorType=value3...]
includeCompositionBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info: (TgcOnly)
Param Name: includeComposition
Description: Indicates if VirtualMachineComposition objects to be populated
Multivalued: No
Usage: ?includeComposition=value
instanceUuidxsd:string
For query param info, refer to: instanceUuid
ioAlignedPercentxsd:string
For query param info, refer to: ioAlignedPercent
lastReplicatedSnapshotDatexsd:string
Query Param Info:
Param Name: lastReplicatedSnapshotDate
Description: Numeric filter on latest replicated snapshot date(in milliseconds) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.snapshot.latestReplicated.createTime
Usage: ?lastReplicatedSnapshotDate=value
lastSnapshotDatexsd:string
Query Param Info:
Param Name: lastSnapshotDate
Description: Numeric filter on latest created snapshot date(in milliseconds) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.snapshot.latest.createTime
Usage: ?lastSnapshotDate=value
latencyContentionMsxsd:string
For query param info, refer to: latencyContentionMs
latencyDiskMsxsd:string
For query param info, refer to: latencyDiskMs
latencyFlashMsxsd:string
For query param info, refer to: latencyFlashMs
latencyHostMsxsd:string
For query param info, refer to: latencyHostMs
latencyNetworkMsxsd:string
For query param info, refer to: latencyNetworkMs
latencyStorageMsxsd:string
For query param info, refer to: latencyStorageMs
latencyThrottleMsxsd:string
For query param info, refer to: latencyThrottleMs
latencyTotalMsxsd:string
For query param info, refer to: latencyTotalMs
latestSliceUuidxsd:string
Query Param Info: (VMstoreOnly)
Param Name: latestSliceUuid
Description: Tintri UUID of latest slice of the result
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.uuid.uuid
Usage: ?latestSliceUuid=value
limitxsd:int
For query param info, refer to: limit
liveBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: live
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.isLive
Usage: ?live=value
liveLogicalFootprintxsd:string
For query param info, refer to: liveLogicalFootprint
maxNormalizedIopsxsd:string
Query Param Info:
Param Name: maxNormalizedIops
Description: Numeric filter on max normalizd allocated iops specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.qosConfig.maxNormalizedIops
Usage: ?maxNormalizedIops=value
metricxsd:string
For query param info, refer to: metric
migrationBytesRemainingMBxsd:string
Query Param Info: (VMstoreOnly)
Param Name: migrationBytesRemainingMB
Description: Numeric filter on logical amount of data(MB) yet to be replicated for a VM specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.migration.migrationOutgoingDataRemainingMB
Usage: ?migrationBytesRemainingMB=value
migrationDestinationxsd:string
Query Param Info:
Param Name: migrationDestination
Description: VM migration destination
Multivalued: No
Mapped to attributes:
  • VirtualMachine.migration.migrationConfigurationOutgoing.destinationAddress
Usage: ?migrationDestination=value
migrationThroughputLogicalMBpsxsd:string
Query Param Info:
Param Name: migrationThroughputLogicalMBps
Description: Numeric filter on outgoing logical migration throughput(MBps) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.migration.migrationThroughputOutgoingLogicalMBps
Usage: ?migrationThroughputLogicalMBps=value
migrationThroughputPhysicalMBpsxsd:string
Query Param Info:
Param Name: migrationThroughputPhysicalMBps
Description: Numeric filter on outgoing physical migration throughput(MBps) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.migration.migrationThroughputOutgoingPhysicalMBps
Usage: ?migrationThroughputPhysicalMBps=value
minNormalizedIopsxsd:string
Query Param Info:
Param Name: minNormalizedIops
Description: Numeric filter on min normalizd allocated iops specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.qosConfig.minNormalizedIops
Usage: ?minNormalizedIops=value
namexsd:string
For query param info, refer to: name
offsetxsd:int
For query param info, refer to: offset
offsetTypePOSITION | NAME | UUID | INVALIDThe offset type of 'offsetValue'.
POSITIONoffsetType is a position in the page
NAMEoffterType is a name string
UUIDofftestType is a name UUID
INVALIDofftestType is invalid
offsetValuexsd:anyThe offset value in the terms of 'offsetType'.
pagexsd:int
For query param info, refer to: page
performanceReserveAutoAllocatedxsd:string
For query param info, refer to: performanceReserveAutoAllocated
performanceReserveChangexsd:string
For query param info, refer to: performanceReserveChange
performanceReserveChangePercentxsd:string
For query param info, refer to: performanceReserveChangePercent
performanceReserveUsedxsd:string
For query param info, refer to: performanceReserveUsed
policyErrorCodesxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: policyErrorCodes
Description: List of PolicyError codes, same as that returned in api: GET /vm/policyErrorStat
Multivalued: Yes
Usage:
  • ?policyErrorCodes=value1[,value2,value3..] OR
  • ?policyErrorCodes=value1[&policyErrorCodes=value2&policyErrorCodes=value3...]
poweredBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: powered
Description: Virtual machine power state. Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.isPowered
Usage: ?powered=value
protectionsxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: protections
Description: The protection strategies of the requested VMs, which can be one or more of (NONE, SCHEDULE, NOT_CONFIGURED, REPLICATED, REPLICATED_INCOMING, NOTREPLICATED, NOTREPLICATED_INCOMING, CUSTOM, DEFAULT, ANY)
Multivalued: Yes
Usage:
  • ?protections=value1[,value2,value3..] OR
  • ?protections=value1[&protections=value2&protections=value3...]
provisionedTypexsd:list[xsd:string]
Query Param Info: (VMstoreOnly)
Param Name: provisionedType
Description: One or more of (THICK, THIN, PENDING)
Multivalued: Yes
Mapped to attributes:
  • VirtualMachine.provisionedType
Usage:
  • ?provisionedType=value1[,value2,value3..] OR
  • ?provisionedType=value1[&provisionedType=value2&provisionedType=value3...]
qosConfiguredBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: qosConfigured
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.qosConfig.isConfigured
Usage: ?qosConfigured=value
qParamsMultivaluedMap
QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAXxsd:intMax job completion timeout (in minutes)
QUERY_TIMEOUT_IN_SEC_DEFAULTxsd:intDefault search timeout (in seconds)
QUERY_TIMEOUT_IN_SEC_MAXxsd:intMax search timeout (in seconds)
queryTypeTOP_DOCS_BY_TIME | TOP_DOCS_BY_LATEST_TIME | OFFSET_BY_TIME | OFFSET_BY_SEQUENCE
TOP_DOCS_BY_TIMEsort top contributors by time based on since and until values
TOP_DOCS_BY_LATEST_TIMEsort top contributors by time based on latest update time
OFFSET_BY_TIMEsort by time starting with a time offset
OFFSET_BY_SEQUENCEsort by offset starting with a page offset
For query param info, refer to: queryType
refreshxsd:boolean
For query param info, refer to: refresh
replDestinationxsd:string
Query Param Info:
Param Name: replDestination
Description: VM replication destination
Multivalued: No
Mapped to attributes:
  • VirtualMachine.replication.replDestination
Usage: ?replDestination=value
replicationHasIssueBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info: (TgcOnly)
Param Name: replicationHasIssue
Description: Whether its replication link has any issue (lagging or error state) of requested VMs.Applicable values (True/False/Both)
Multivalued: No
Usage: ?replicationHasIssue=value
replLinkIdUuid
For query param info, refer to: replLinkId
replLinkIdsxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: replLinkIds
Description: The replication link IDs of the requested VMs
Multivalued: Yes
Usage:
  • ?replLinkIds=value1[,value2,value3..] OR
  • ?replLinkIds=value1[&replLinkIds=value2&replLinkIds=value3...]
replSourcexsd:string
Query Param Info:
Param Name: replSource
Description: VM replication source
Multivalued: No
Mapped to attributes:
  • VirtualMachine.replication.replSource
Usage: ?replSource=value
replStatexsd:list[xsd:string]
Query Param Info:
Param Name: replState
Description: One or more of (NOT_CONFIGURED, PAUSED, RUNNING)
Multivalued: Yes
Mapped to attributes:
  • VirtualMachine.replication.replicationState
Usage:
  • ?replState=value1[,value2,value3..] OR
  • ?replState=value1[&replState=value2&replState=value3...]
requestSizeKiBxsd:string
For query param info, refer to: requestSizeKiB
serviceGroupIdxsd:string
Query Param Info: (VMstoreOnly)
Param Name: serviceGroupId
Description: Service group ID that the VM is a member of.
Multivalued: No
Mapped to attributes:
  • VirtualMachine.serviceGroup.groupId
Usage: ?serviceGroupId=value
serviceGroupIdsxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: serviceGroupIds
Description: The Tintri UUIDs of the Service Groups which the requested VMs belong to
Multivalued: Yes
Usage:
  • ?serviceGroupIds=value1[,value2,value3..] OR
  • ?serviceGroupIds=value1[&serviceGroupIds=value2&serviceGroupIds=value3...]
serviceGroupNamexsd:string
Query Param Info:
Param Name: serviceGroupName
Description: Service group name that the VM is a member of.
Multivalued: No
Mapped to attributes:
  • VirtualMachine.serviceGroup.name
Usage: ?serviceGroupName=value
sincexsd:datetime
For query param info, refer to: since
snapshotScheduleTypexsd:list[xsd:string]
Query Param Info:
Param Name: snapshotScheduleType
Description: One or more of (HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY)
Multivalued: Yes
Mapped to attributes:
  • VirtualMachine.snapshot.schedulesInternal
Usage:
  • ?snapshotScheduleType=value1[,value2,value3..] OR
  • ?snapshotScheduleType=value1[&snapshotScheduleType=value2&snapshotScheduleType=value3...]
sortedByxsd:string
For query param info, refer to: sortedBy
sortOrderxsd:string
For query param info, refer to: sortOrder
spaceProvisionedGiBxsd:string
For query param info, refer to: spaceProvisionedGiB
spaceSavingsFactorxsd:string
For query param info, refer to: spaceSavingsFactor
spaceUsedChangeGiBxsd:string
For query param info, refer to: spaceUsedChangeGiB
spaceUsedChangePercentxsd:string
For query param info, refer to: spaceUsedChangePercent
spaceUsedGiBxsd:string
For query param info, refer to: spaceUsedGiB
spaceUsedLiveGiBxsd:string
For query param info, refer to: spaceUsedLiveGiB
spaceUsedSnapshotsHypervisorGiBxsd:string
For query param info, refer to: spaceUsedSnapshotsHypervisorGiB
spaceUsedSnapshotsTintriGiBxsd:string
For query param info, refer to: spaceUsedSnapshotsTintriGiB
storageContainerxsd:string
Query Param Info:
Param Name: storageContainer
Description: Storage container name where this VM (or part of this VM) is located.
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.storageContainers
Usage: ?storageContainer=value
storageContainerIdxsd:string
Query Param Info:
Param Name: storageContainerId
Description: Storage container IDs from hypervisor manager where this VM (or part of this VM) is located.
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.storageContainerIds
Usage: ?storageContainerId=value
subdirxsd:string
Query Param Info:
Param Name: subdir
Description: directory path of the VM relative to the submount
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.subdir
Usage: ?subdir=value
syslogForwardingxsd:string
For query param info, refer to: syslogForwarding
targetVM | VDISK | SNAPSHOT | JOB | ALERTS | DATASTORE_STAT | VM_STAT | VDISK_STAT | SERVICE_GROUP
VMVirtual machine
VDISKVirtual disk
SNAPSHOTSnapshot
JOBJob
ALERTSAlert
DATASTORE_STATDatastore statistics
VM_STATVirtual Machine statistics
VDISK_STATVirtual disk statistics
SERVICE_GROUPService group
For query param info, refer to: target
templateBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: template
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.isTemplate
Usage: ?template=value
throughputLogicalMBpsxsd:string
Query Param Info:
Param Name: throughputLogicalMBps
Description: Numeric filter on outgoing logical replication throughput(MBps) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.replication.throughputLogicalMBps
Usage: ?throughputLogicalMBps=value
throughputPhysicalMBpsxsd:string
Query Param Info:
Param Name: throughputPhysicalMBps
Description: Numeric filter on outgoing physical replication throughput(MBps) specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.replication.throughputPhysicalMBps
Usage: ?throughputPhysicalMBps=value
timeoutxsd:long
For query param info, refer to: timeout
timeRemainingSecondsxsd:string
Query Param Info:
Param Name: timeRemainingSeconds
Description: Numeric filter on remaining time(in seconds) to complete the replication specified as range - MIN:MAX
Multivalued: No
Mapped to attributes:
  • VirtualMachine.stat.latestSlice.replication.timeRemainingSeconds
Usage: ?timeRemainingSeconds=value
totalIopsxsd:string
For query param info, refer to: totalIops
totalMBpsxsd:string
For query param info, refer to: totalMBps
totalNormalizedIopsxsd:string
For query param info, refer to: totalNormalizedIops
totalUsedSpacexsd:string
For query param info, refer to: totalUsedSpace
typesxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: types
Description: The types of the requested VMs, which can be one or more of (SYNTHETIC, LIVE, HISTORICAL)
Multivalued: Yes
Usage:
  • ?types=value1[,value2,value3..] OR
  • ?types=value1[&types=value2&types=value3...]
untilxsd:datetime
For query param info, refer to: until
useDefaultScheduleBOTH | TRUE | FALSE | NOT_FOUND
BOTH
TRUE
FALSE
NOT_FOUND
Query Param Info:
Param Name: useDefaultSchedule
Description: Applicable values (True/False/Both)
Multivalued: No
Mapped to attributes:
  • VirtualMachine.snapshot.useDefaultSystemSchedule
Usage: ?useDefaultSchedule=value
uuidxsd:string
For query param info, refer to: uuid
vcenterNamexsd:string
Query Param Info:
Param Name: vcenterName
Description: vCenter server name
Multivalued: No
Mapped to attributes:
  • VirtualMachine.vmware.vcenterName
Usage: ?vcenterName=value
vcenterNamesxsd:list[xsd:string]
Query Param Info: (TgcOnly)
Param Name: vcenterNames
Description: The vCenters of the requested VMs
Multivalued: Yes
Usage:
  • ?vcenterNames=value1[,value2,value3..] OR
  • ?vcenterNames=value1[&vcenterNames=value2&vcenterNames=value3...]