Skip to content

Remove-NBDCIMModuleBayType

Since

v4.7.0.1

SYNOPSIS

Removes a Module Bay Type from Netbox DCIM module.

SYNTAX

Remove-NBDCIMModuleBayType [-Id] <UInt64> [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes a Module Bay Type from Netbox DCIM module (NetBox 4.7+). Supports pipeline input for Id parameter.

EXAMPLES

EXAMPLE 1

Remove-NBDCIMModuleBayType -Id 4

Deletes module bay type 4.

EXAMPLE 2

Get-NBDCIMModuleBayType -Name 'SFP Cage' | Remove-NBDCIMModuleBayType -Confirm:$false

Deletes the module bay type named 'SFP Cage' via the pipeline.

PARAMETERS

-Id

Database ID of the object 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 instead of the results array.

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.7.0.1 Requires NetBox 4.7.0 or later.

Common parameters

common request params

https://netbox.readthedocs.io/en/stable/rest-api/overview/