Remove-PASDirectory
Remove-PASDirectory
SYNOPSIS
Removes an LDAP directory configured in the Vault
SYNTAX
Remove-PASDirectory [-id] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Removes an LDAP directory configuration from the vault.
Membership of the Vault Admins group required.
EXAMPLES
EXAMPLE 1
Remove-PASDirectory -id LDAPDirectory
Removes LDAP directory configured in the Vault
EXAMPLE 2
Remove-PASDirectory -DomainName cyberark.local
Removes the LDAP directory named “cyberark.local” from the Vault, using the DomainName alias for the id parameter.
EXAMPLE 3
Get-PASDirectory -id cyberark.local | Remove-PASDirectory
Retrieves the “cyberark.local” directory and removes it via the pipeline.
EXAMPLE 4
Remove-PASDirectory -id cyberark.local -WhatIf
Shows what would happen if the LDAP directory was removed, without actually removing it.
PARAMETERS
-id
The ID or Name of the directory to return information on.
Type: String
Parameter Sets: (All)
Aliases: DomainName
Required: True
Position: 1
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.