Remove-NBOwnerGroup
Since
v4.4.10.0
SYNOPSIS
Removes an owner group from Netbox (Netbox 4.5+).
SYNTAX
Remove-NBOwnerGroup [-Id] <UInt64> [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Removes an owner group from Netbox Users module. Owner groups are used to organize owners for object ownership tracking. This endpoint is only available in Netbox 4.5 and later.
EXAMPLES
EXAMPLE 1
Remove-NBOwnerGroup -Id 5
EXAMPLE 2
Get-NBOwnerGroup -Name "Deprecated Team" | Remove-NBOwnerGroup
PARAMETERS
-Id
The database ID of the owner group to remove (required).
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
System.Void
NOTES
AddedInVersion: v4.4.10.0