XML element SnapshotFilterSpec

Name: SnapshotFilterSpec

Object which models the query parameters used to filter for the snapshot managed entity.

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.SnapshotFilterSpec",
   "allStats": <Boolean>,
   "consistency": [<String>],
   "contain": <String>,
   "deleted": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "filterAttributeList": [SortFilterAttribute],
   "filterParams": MultivaluedMap,
   "fromDate": <Date>,
   "fromVmstore": [<String>],
   "hasClone": [<String>],
   "limit": <Number>,
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "offsetType": 'POSITION' | 'NAME' | 'UUID' | 'INVALID',
   "offsetValue": <Object>,
   "orphaned": [<String>],
   "page": <Number>,
   "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>,
   "removeReplica": <Boolean>,
   "replica": [<String>],
   "replicaTintriUuids": [<String>],
   "replLinkId": Uuid,
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "syslogForwarding": <String>,
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP',
   "timeout": <Number>,
   "toDate": <Date>,
   "type": [<String>],
   "until": <Date>,
   "uuid": <String>,
   "vmUuid": <String>,
}

Name Type Description

allStats xsd:boolean For query param info, refer to: allStats

consistency

xsd:list[xsd:string]

**Query Param Info:**
Param Name:	consistency
Description:	Can contain one or more of (CRASH_CONSISTENT, VM_CONSISTENT, APP_CONSISTENT). The consistency type. Crash consistency is a VMstore snapshot that can be used to recover from a VM crash. VM consistency is a hypervisor snapshot that is hypervisor consistent and can be used to recover from a VM crash. App consistency is not used at this time.
Multivalued:	Yes
Usage:	?consistency=value1[,value2,value3..] OR ?consistency=value1[&consistency=value2&consistency=value3...]

contain

xsd:string

**Query Param Info:**
Param Name:	contain
Description:	keyword to be searched in Snapshot name or Snapshot's VM name.
Multivalued:	No
Usage:	?contain=value

deleted

BOTH | TRUE | FALSE | NOT_FOUND

BOTH
TRUE
FALSE
NOT_FOUND

**Query Param Info:**
Param Name:	deleted
Description:	Applicable values (True/False/Both)
Multivalued:	No
Usage:	?deleted=value

filterAttributeList xsd: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.

filterParams MultivaluedMap

fromDate

xsd:datetime

**Query Param Info:**
Param Name:	fromDate
Description:	Date in ISO8601 format - 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'
Multivalued:	No
Usage:	?fromDate=value

fromVmstore

xsd:list[xsd:string]

**Query Param Info:**
Param Name:	fromVmstore
Description:	<Serial Number> - TIN - <Generated local sequence number>
Multivalued:	Yes
Usage:	?fromVmstore=value1[,value2,value3..] OR ?fromVmstore=value1[&fromVmstore=value2&fromVmstore=value3...]

hasClone

xsd:list[xsd:string]

**Query Param Info:**
Param Name:	hasClone
Description:	Filter by if snapshot has a clone associated with it. Either 'Both', 'Yes', or 'No'.Default is 'Both'.
Multivalued:	No
Usage:	?hasClone=value

limit xsd:int For query param info, refer to: limit

metric xsd:string For query param info, refer to: metric

name xsd:string For query param info, refer to: name

offset xsd:int For query param info, refer to: offset

offsetType

POSITION | NAME | UUID | INVALID

The offset type of 'offsetValue'.

POSITION	offsetType is a position in the page
NAME	offterType is a name string
UUID	offtestType is a name UUID
INVALID	offtestType is invalid

offsetValue xsd:any The offset value in the terms of 'offsetType'.

orphaned

xsd:list[xsd:string]

**Query Param Info:**
Param Name:	orphaned
Description:	Filter by orphan snapshot. Either 'Both', 'Yes', or 'No'. Default is 'Both'.
Multivalued:	No
Usage:	?orphaned=value

page xsd:int For query param info, refer to: page

qParams MultivaluedMap

QUERY_JOB_COMPLETION_TIMEOUT_IN_MINUTES_MAX xsd:int Max job completion timeout (in minutes)

QUERY_TIMEOUT_IN_SEC_DEFAULT xsd:int Default search timeout (in seconds)

QUERY_TIMEOUT_IN_SEC_MAX xsd:int Max search timeout (in seconds)

queryType

TOP_DOCS_BY_TIME | TOP_DOCS_BY_LATEST_TIME | OFFSET_BY_TIME | OFFSET_BY_SEQUENCE

TOP_DOCS_BY_TIME	sort top contributors by time based on since and until values
TOP_DOCS_BY_LATEST_TIME	sort top contributors by time based on latest update time
OFFSET_BY_TIME	sort by time starting with a time offset
OFFSET_BY_SEQUENCE	sort by offset starting with a page offset

For query param info, refer to: queryType

refresh xsd:boolean For query param info, refer to: refresh

removeReplica

xsd:boolean

**Query Param Info:**
Param Name:	removeReplica
Description:	[True/False] represents java.lang.Boolean. Currently not supported.
Multivalued:	No
Usage:	?removeReplica=value

replica

xsd:list[xsd:string]

**Query Param Info:**
Param Name:	replica
Description:	Filter by replica snapshots. Either 'Both', 'Yes', or 'No'. Default is 'Both'.
Multivalued:	No
Usage:	?replica=value

replicaTintriUuids

xsd:list[xsd:string]

**Query Param Info:**
Param Name:	replicaTintriUuids
Description:	Specifies one or more Snapshots by Tintri UUID. Currently not supported.
Multivalued:	Yes
Usage:	?replicaTintriUuids=value1[,value2,value3..] OR ?replicaTintriUuids=value1[&replicaTintriUuids=value2&replicaTintriUuids=value3...]

replLinkId Uuid For query param info, refer to: replLinkId

since xsd:datetime For query param info, refer to: since

sortedBy xsd:string For query param info, refer to: sortedBy

sortOrder xsd:string For query param info, refer to: sortOrder

syslogForwarding xsd:string For query param info, refer to: syslogForwarding

target

VM	Virtual machine
VDISK	Virtual disk
SNAPSHOT	Snapshot
JOB	Job
ALERTS	Alert
DATASTORE_STAT	Datastore statistics
VM_STAT	Virtual Machine statistics
VDISK_STAT	Virtual disk statistics
SERVICE_GROUP	Service group

For query param info, refer to: target

timeout xsd:long For query param info, refer to: timeout

toDate

xsd:datetime

**Query Param Info:**
Param Name:	toDate
Description:	Date in ISO8601 format - 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'
Multivalued:	No
Usage:	?toDate=value

type

xsd:list[xsd:string]

**Query Param Info:**
Param Name:	type
Description:	The snapshot type. Possible values are: (SCHEDULED_SNAPSHOT, USER_GENERATED_SNAPSHOT, AUTO_GENERATED_CLONING_SNAPSHOT, VAAI_GENERATED_SNAPSHOTODX_GENERATED_SNAPSHOTCINDER_GENERATED_SNAPSHOTSCHEDULED_HIGH_FREQUENCY_SNAPSHOTHYPERV_SHARE_SNAPSHOT)
Multivalued:	Yes
Usage:	?type=value1[,value2,value3..] OR ?type=value1[&type=value2&type=value3...]

until xsd:datetime For query param info, refer to: until

uuid xsd:string For query param info, refer to: uuid

vmUuid

xsd:string

**Query Param Info:**
Param Name:	vmUuid
Description:	Filter snapshots by VM UUID.
Multivalued:	No
Usage:	?vmUuid=value