XML element ServiceGroupPageFilterSpec

Name: ServiceGroupPageFilterSpec

Service group query parameter filter

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.ServiceGroupPageFilterSpec",
   "allStats": <Boolean>,
   "capabilities": [<String>],
   "deleted": 'BOTH' | 'TRUE' | 'FALSE' | 'NOT_FOUND',
   "limit": <Number>,
   "membershipType": 'STATIC' | 'DIRECTORY' | 'ALL' | 'NOT_FOUND',
   "metric": <String>,
   "name": <String>,
   "offset": <Number>,
   "page": <Number>,
   "primaryVmstoreTintriUuids": [<String>],
   "queryType": 'TOP_DOCS_BY_TIME' | 'TOP_DOCS_BY_LATEST_TIME' | 'OFFSET_BY_TIME' | 'OFFSET_BY_SEQUENCE',
   "quorumServerId": <String>,
   "quorumServerStates": [<String>],
   "refresh": <Boolean>,
   "replLinkId": Uuid,
   "secondaryVmstoreTintriUuids": [<String>],
   "since": <Date>,
   "sortedBy": <String>,
   "sortOrder": <String>,
   "syncReplStates": [<String>],
   "syncReplVmstoreTintriUuids": [<String>],
   "target": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP' | 'GENERIC_INTERFACE' | 'APPLIANCE' | 'VIRTUAL_VMSTORE',
   "timeout": <Number>,
   "until": <Date>,
   "uuid": <String>,
}

Name Type Description

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

capabilities

xsd:list[xsd:string]

Capabilities supported for a service group:

Capability Description

REPLICATION Replication capability for the service group.

SNAPSHOT Snapshot capability for the service group.

SRM VMware Site Recovery Manager (SRM) capability for the service group.

SYNC_REPL Synchronous replication capability for the service group

QOS Quality of Services (QoS) capability for the service group.

QUOTA Quota capability for the service group.

Query Param Info:
Param Name: capabilities
Description: Service group capabilities
Multivalued: Yes
Usage:
?capabilities=value1[,value2,value3..] OR
?capabilities=value1[&capabilities=value2&capabilities=value3...]

deleted

BOTH | TRUE | FALSE | NOT_FOUND

BOTH
TRUE
FALSE
NOT_FOUND

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

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

membershipType

STATIC | DIRECTORY | ALL | NOT_FOUND

STATIC	Membership in statically assigned.
DIRECTORY	Membership is based on directory/submount.
ALL	All membership type.
NOT_FOUND

**Query Param Info:**
Param Name:	membershipType
Description:	Return service groups based on membership type. Applicable values (directory)
Multivalued:	No
Usage:	?membershipType=value

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

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

primaryVmstoreTintriUuids

xsd:list[xsd:string]

**Query Param Info:** (TgcOnly)
Param Name:	primaryVmstoreTintriUuids
Description:	Tintri UUIDs of the primary VMstores participating in synchronously replicated service group
Multivalued:	Yes
Usage:	?primaryVmstoreTintriUuids=value1[,value2,value3..] OR ?primaryVmstoreTintriUuids=value1[&primaryVmstoreTintriUuids=value2&primaryVmstoreTintriUuids=value3...]

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

quorumServerId

xsd:string

**Query Param Info:** (TgcOnly)
Param Name:	quorumServerId
Description:	Quorum server uuid configured for the service group
Multivalued:	No
Usage:	?quorumServerId=value

quorumServerStates

xsd:list[xsd:string]

Quorum server states supported for a synchronously replicated service group:

Quorum server state Description

NOT_CONFIGURED Synchronous replication has not been configured for Automatic Failover.

CONNECTED Both VMstores are connected to the Quorum Server.

DISCONNECTED Both VMstores are disconnected from the Quorum Server.

PRIMARY_DISCONNECTED The current primary VMstore is disconnected from the Quorum Server.

SECONDARY_DISCONNECTED The current secondary VMstore is disconnected from the Quorum Server.

Query Param Info: (TgcOnly)
Param Name: quorumServerStates
Description: Quorum server states
Multivalued: Yes
Usage:
?quorumServerStates=value1[,value2,value3..] OR
?quorumServerStates=value1[&quorumServerStates=value2&quorumServerStates=value3...]

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

replLinkId Uuid For query param info, refer to: replLinkId

secondaryVmstoreTintriUuids

xsd:list[xsd:string]

**Query Param Info:** (TgcOnly)
Param Name:	secondaryVmstoreTintriUuids
Description:	Tintri UUIDs of the secondary VMstores participating in synchronously replicated service group
Multivalued:	Yes
Usage:	?secondaryVmstoreTintriUuids=value1[,value2,value3..] OR ?secondaryVmstoreTintriUuids=value1[&secondaryVmstoreTintriUuids=value2&secondaryVmstoreTintriUuids=value3...]

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

syncReplStates

xsd:list[xsd:string]

Sync Repl states supported for a service group:

Sync Repl State Description

INITIALIZING TGC is in the process of pushing the Configuration to participating VMstores or TGC pushed config to VMstores and VMstores are initiating the connections.

IN_SYNC SyncRepl configuration is up and running well.

RESYNCING SyncRepl configuration is set up and both primary and secondary are connected, and they are in the process of resyncing.

ERROR SyncRepl configuration is in error, which means primary and secondary lost connection to each other.

PAUSED SyncRepl configuration has been paused by the user.

UNKNOWN Represents transition states.

OUT_OF_SERVICE The cluster IP (datastore) defined by the service group is not serving data.

DELETION_IN_PROGRESS Set to this state when TGC is processing a request to delete the ServiceGroup.

Query Param Info: (TgcOnly)
Param Name: syncReplStates
Description: Current states of synchronously replicated service group
Multivalued: Yes
Usage:
?syncReplStates=value1[,value2,value3..] OR
?syncReplStates=value1[&syncReplStates=value2&syncReplStates=value3...]

syncReplVmstoreTintriUuids

xsd:list[xsd:string]

**Query Param Info:** (TgcOnly)
Param Name:	syncReplVmstoreTintriUuids
Description:	Tintri UUIDs of the VMstores participating in the synchronously replicated service group.
Multivalued:	Yes
Usage:	?syncReplVmstoreTintriUuids=value1[,value2,value3..] OR ?syncReplVmstoreTintriUuids=value1[&syncReplVmstoreTintriUuids=value2&syncReplVmstoreTintriUuids=value3...]

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
GENERIC_INTERFACE	Generic Interface
APPLIANCE	Appliance
VIRTUAL_VMSTORE	Virtual VMstore

For query param info, refer to: target

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

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

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