Clear-TssListOption
SYNOPSIS
Clear a List option from a list
SYNTAX
Clear-TssListOption [-TssSession] <Session> -Id <String> -OptionId <String[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Clear a List option from a list
EXAMPLES
EXAMPLE 1
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
$options = Get-TssListOption -TssSession $session -Id 2d92c585-a3e1-4706-96b8-23ad2edda6b0
$options | Where-Object Option -eq 'Option 2' | Clear-TssListOption -TssSession $session
Clear the “Option 1” from the List, will prompt to confirm the action since it is not reversible
EXAMPLE 2
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
$options = Get-TssListOption -TssSession $session -Id 2d92c585-a3e1-4706-96b8-23ad2edda6b0
$options | Where-Object Option -eq 'Option 2' | Clear-TssListOption -TssSession $session -Confirm:$false
Clear the “Option 1” from the List, will not prompt to confirm the action since it is not reversible
EXAMPLE 3
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
$options = Get-TssListOption -TssSession $session -Id 2d92c585-a3e1-4706-96b8-23ad2edda6b0
$options | Where-Object Option -match '^TBSERV' | Clear-TssListOption -TssSession $session -Confirm:$false
Clear all options that start with “TBSERV” from the List, will not prompt to confirm the action since it is not reversible
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
-Id
Categorized List ID
Type: String
Parameter Sets: (All)
Aliases: CategorizedListId
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-OptionId
The List’s Option Id to clear
Type: String[]
Parameter Sets: (All)
Aliases: CategorizedListItemId
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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.Common.Delete
NOTES
Requires TssSession object returned by New-TssSession
RELATED LINKS
https://thycotic-ps.github.io/thycotic.secretserver/commands/lists/Clear-TssListOption