Skip to content

Remove-B1CustomList

SYNOPSIS

Removes a Custom List from BloxOne Threat Defense

SYNTAX

Default (Default)

Remove-B1CustomList [-Name <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Pipeline

Remove-B1CustomList -Object <Object> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This function is used to remove named lists from BloxOne Threat Defense. These are referred to and displayed as Custom Lists within the CSP.

EXAMPLES

EXAMPLE 1

Get-B1CustomList | Where-Object {$_.name -eq "My Custom List"} | Remove-B1CustomList

PARAMETERS

-Name

The name of the Custom List to remove.

Whilst this is here, the API does not currently support filtering by name. (01/04/24)

For now, you should instead use pipeline to remove objects as shown in the examples.

Type: String
Parameter Sets: Default
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Object

The Custom List Object. This accepts pipeline input from Get-B1CustomList

Type: Object
Parameter Sets: Pipeline
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Perform the operation without prompting for confirmation. By default, this function will always prompt for confirmation unless -Confirm:$false or -Force is specified, or $ConfirmPreference is set to None.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
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

NOTES