Invoke-VCAVPagedQuery

NAME Invoke-VCAVPagedQuery



SYNOPSIS

Query the vCloud Availability (VCAV) API





SYNTAX

Invoke-VCAVPagedQuery [-QueryPath] <String> [[-Headers] <Hashtable>] [[-Filter] <Hashtable>] [<CommonParameters>]





DESCRIPTION

Invoke-VCAVPagedQuery queries the vCloud Availability API for the specified

resource which is returned as a PSCustomObject. Queries which return more than

100 objects are split into 100 object chunks so that all returned values are

obtained. Parameters can be specified to limit the returned results by a filter

(see Examples).





PARAMETERS

-QueryPath <String>

A required parameter containing the API resource to retrieve.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Headers <Hashtable>

An optional parameter containing any additional HTML headers to pass to the API

note that the 'X-VCAV-Auth' token is populated automatically based on existing

sessions to the API and the 'Accept' token is automatically set to the value

'application/vnd.vmware.h4-v3+json;charset=UTF-8' if not specified. This is

appropriate for the majority of VCAV API queries.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Filter <Hashtable>

An optional parameter to restrict the results returned by encoding additional

filters in the query Uri. See https://code.vmware.com/apis/441/vcav for

details of the valid filter parameters for each method call.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

A PSCustomObject containing the resources from the API call or an error.





NOTES





The parameters used in the -Filter argument for each query type are specified

in the VCAV API documentation at https://code.vmware.com/apis/441/vcav



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get a list of VCAV vApp Replications:



Invoke-VCAVPagedQuery -QueryPath 'vapp-replications'









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Retrieve a list of vApp replications for the vCD Organization 'myorg':



Invoke-VCAVPagedQuery -QueryPath 'vapp-replications' -Filter @{ sourceSite='myorg' }











RELATED LINKS