Search-TssDistributedEngine
SYNOPSIS
Search Distributed Engines
SYNTAX
Search-TssDistributedEngine [-TssSession] <Session> [-SiteId <Int32>]
[-ActivationStatus <EngineActivationStatus>] [-ConnectionStatus <EngineConnectionStatus>]
[-SearchText <String>] [-RequireActivation] [-SortBy <String>] [<CommonParameters>]
DESCRIPTION
Search Distributed Engines
EXAMPLES
EXAMPLE 1
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssDistributedEngine -TssSession $session -SiteId 1
Return list of engines assigned to Site ID 1
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: True (ByPropertyName)
Accept wildcard characters: False
-ActivationStatus
Only return engines with this activation status
Type: EngineActivationStatus
Parameter Sets: (All)
Aliases:
Accepted values: Pending, Activated, Inactive, Deleted
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ConnectionStatus
Only return engines with this connection status
Type: EngineConnectionStatus
Parameter Sets: (All)
Aliases:
Accepted values: Offline, Online, Invalid, OldVersion
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SearchText
Only return engines with a friendly name that contains this text
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequireActivation
Only include engines that require action. For example, pending but not deleted or no site assigned.
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 EngineId
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: EngineId
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.EngineSummary
NOTES
Requires TssSession object returned by New-TssSession