NetboxPS/Functions/DCIM/Devices/Remove-NetboxDCIMDevice.ps1

68 lines
1.6 KiB
PowerShell
Raw Normal View History

<#
2020-03-23 12:18:01 -04:00
.NOTES
===========================================================================
Created with: SAPIEN Technologies, Inc., PowerShell Studio 2020 v5.7.172
Created on: 3/23/2020 12:08
Created by: Claussen
Organization: NEOnet
Filename: Remove-NetboxDCIMDevice.ps1
===========================================================================
.DESCRIPTION
A description of the file.
#>
function Remove-NetboxDCIMDevice {
<#
.SYNOPSIS
Delete a device
2020-03-23 12:18:01 -04:00
.DESCRIPTION
Deletes a device from Netbox by ID
2020-03-23 12:18:01 -04:00
.PARAMETER Id
Database ID of the device
2020-03-23 12:18:01 -04:00
.PARAMETER Force
Force deletion without any prompts
2020-03-23 12:18:01 -04:00
.EXAMPLE
PS C:\> Remove-NetboxDCIMDevice -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)]
param
(
[Parameter(Mandatory = $true,
ValueFromPipelineByPropertyName = $true)]
[uint16[]]$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 ($DeviceID in $Id) {
$CurrentDevice = Get-NetboxDCIMDevice -Id $DeviceID -ErrorAction Stop
2020-03-23 12:18:01 -04:00
if ($Force -or $pscmdlet.ShouldProcess("Name: $($CurrentDevice.Name) | ID: $($CurrentDevice.Id)", "Remove")) {
$Segments = [System.Collections.ArrayList]::new(@('dcim', 'devices', $CurrentDevice.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
}
}