Get-HypPvsSite¶
Gets instances of PvsSites.
Syntax¶
Get-HypPvsSite [-SiteId <Guid>] [-SiteName <String>] [-FarmId <Guid>] [-FarmName <String>] [-ResourceLocation <Guid>] [-Property <String[]>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Retrieve PvsSite whose properties match the given filter criteria. If no parameters are specified, this cmdlet retrieves all PvsSite objects.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| SiteId | Specifies a filter for the SiteId. | false | true (ByPropertyName) | |
| SiteName | Specifies a filter for the SiteName. | false | true (ByPropertyName) | |
| FarmId | Specifies a filter for the FarmId. | false | true (ByPropertyName) | |
| FarmName | Specifies a filter for the FarmName. | false | true (ByPropertyName) | |
| ResourceLocation | Specifies a filter for the ResourceLocation. | false | true (ByPropertyName) | |
| Property | Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server. | false | false | |
| ReturnTotalRecordCount | When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Hyp_Filtering for details. | false | false | False |
| MaxRecordCount | Specifies the maximum number of records to return. | false | false | 250 |
| Skip | Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. | false | false | 0 |
| SortBy | Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. | false | false | The default sort order is by name or unique identifier. |
| Filter | Gets records that match a PowerShell-style filter expression. See about_Hyp_Filtering for details. | false | false | |
| FilterScope | Gets only results allowed by the specified scope id. | false | false | |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| AdminClientIP | Specifies the client IP of the calling user | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false | |
| AdminAddress | Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
Input Type¶
Guid¶
The GUID of a site to retrieve.
Return Values¶
Citrix.Host.Sdk.Pvssite¶
This cmdlet returns matching PvsSite objects.
Examples¶
Example 1¶
C:\PS>Get-HypPvsSite -SiteId 00000000-0000-0000-0000-000000000000 -SiteName "exampleSite" -FarmId 00000000-0000-0000-0000-000000000000 -FarmName "exampleFarm" -ResourceLocation 00000000-0000-0000-0000-000000000000
Description¶
This command lists the PVS sites that match the corresponding filters.