NetboxPS/Functions/DCIM/Interfaces/Remove-NetboxDCIMInterface.ps1

54 lines
1.2 KiB
PowerShell
Raw Normal View History

function Remove-NetboxDCIMInterface {
<#
2020-03-23 12:18:01 -04:00
.SYNOPSIS
Removes an interface
2020-03-23 12:18:01 -04:00
.DESCRIPTION
Removes an interface by ID from a device
2020-03-23 12:18:01 -04:00
.PARAMETER Id
A description of the Id parameter.
2020-03-23 12:18:01 -04:00
.PARAMETER Force
A description of the Force parameter.
2020-03-23 12:18:01 -04:00
.EXAMPLE
PS C:\> Remove-NetboxDCIMInterface -Id $value1
2020-03-23 12:18:01 -04:00
.NOTES
Additional information about the function.
#>
2020-03-23 12:18:01 -04:00
[CmdletBinding(ConfirmImpact = 'High',
SupportsShouldProcess = $true)]
2020-03-23 12:18:01 -04:00
param
(
[Parameter(Mandatory = $true,
ValueFromPipelineByPropertyName = $true)]
2023-07-28 16:17:23 -04:00
[uint64[]]$Id,
2020-03-23 12:18:01 -04:00
[switch]$Force
)
2020-03-23 12:18:01 -04:00
begin {
2020-03-23 12:18:01 -04:00
}
2020-03-23 12:18:01 -04:00
process {
foreach ($InterfaceId in $Id) {
$CurrentInterface = Get-NetboxDCIMInterface -Id $InterfaceId -ErrorAction Stop
2020-03-23 12:18:01 -04:00
if ($Force -or $pscmdlet.ShouldProcess("Name: $($CurrentInterface.Name) | ID: $($CurrentInterface.Id)", "Remove")) {
$Segments = [System.Collections.ArrayList]::new(@('dcim', 'interfaces', $CurrentInterface.Id))
2020-03-23 12:18:01 -04:00
$URI = BuildNewURI -Segments $Segments
2020-03-23 12:18:01 -04:00
InvokeNetboxRequest -URI $URI -Method DELETE
}
}
}
2020-03-23 12:18:01 -04:00
end {
2020-03-23 12:18:01 -04:00
}
}