Search-TssDistributedEngineSite
SYNOPSIS
Search Distributed Engine Sites in Secret Server
SYNTAX
Search-TssDistributedEngineSite [-TssSession] <Session> [-SiteId <Int32>] [-SearchText <String>]
[-IncludeSiteMetrics] [-IncludeSitesAddNewEngines] [-IncludeInactive] [-SortBy <String>] [<CommonParameters>]
DESCRIPTION
Search Distributed Engine Sites in Secret Server
EXAMPLES
EXAMPLE 1
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssDistributedEngineSite -TssSession $session
Return list of all active Sites
EXAMPLE 2
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssDistributedEngineSite -TssSession $session -IncludeInactive
Return list of all Sites
PARAMETERS
-TssSession
TssSession object created by New-TssSession for authentication
Type: Session
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-SiteId
Site Id
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-SearchText
Return sites that partially match this name
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeSiteMetrics
Include Site Metrics (e.g. how many inactive or active sites)
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeSitesAddNewEngines
Include Sites that can have new engines added
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeInactive
Include inactive sites
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-SortBy
Sort by specific property, default SiteName
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: SiteName
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
Thycotic.PowerShell.DistributedEngines.SiteSummary
NOTES
Requires TssSession object returned by New-TssSession