Remove-NBBranch
Since
v4.4.10.0
SYNOPSIS
Deletes a branch from Netbox.
SYNTAX
Remove-NBBranch [-Id] <UInt64> [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Deletes a branch using the Netbox Branching plugin. This action cannot be undone and any unmerged changes will be lost.
EXAMPLES
EXAMPLE 1
Remove-NBBranch -Id 1
Delete branch with ID 1 (with confirmation).
EXAMPLE 2
Get-NBBranch -Name "old-branch" | Remove-NBBranch -Confirm:$false
Delete branch without confirmation using pipeline.
PARAMETERS
-Id
The ID of the branch to delete.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Raw
Return the raw API response.
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
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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
None, or raw response if -Raw is specified.
NOTES
AddedInVersion: v4.4.10.0