Public/Remove-Building.ps1
|
<#
.SYNOPSIS Removes a building. .DESCRIPTION Removes a building. If the result returns null, try the parameter "-Verbose" to get more details. .EXAMPLE .LINK https://github.com/erwindevreugd/PSDataConduIT .EXTERNALHELP PSDataConduIT-help.xml #> function Remove-Building { [CmdletBinding( SupportsShouldProcess, ConfirmImpact = "High" )] param ( [Parameter( Position = 0, Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'The name of the server where the DataConduIT service is running or localhost.')] [string] $Server = $Script:Server, [Parameter( Position = 1, Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'The credentials used to authenticate the user to the DataConduIT service.')] [PSCredential] $Credential = $Script:Credential, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Specifies the id of the building to remove.')] [int] $BuildingID, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $true, HelpMessage = 'Specifies the segment id parameter.')] [int] $SegmentID = -1, [Parameter( Mandatory = $false, ValueFromPipelineByPropertyName = $false, HelpMessage = 'Forces the removal of the building with out displaying a should process.')] [switch] $Force ) process { $query = "SELECT * FROM Lnl_Building WHERE __CLASS='Lnl_Building' AND ID!=0" if ($BuildingID) { $query += " AND ID=$BuildingID" } if ($SegmentID -ne -1) { $query += " AND SEGMENTID=$SegmentID" } LogQuery $query $parameters = @{ ComputerName = $Server; Namespace = $Script:OnGuardNamespace; Query = $query } if ($Credential -ne $null) { $parameters.Add("Credential", $Credential) } $items = Get-WmiObject @parameters foreach ($item in $items) { if ($Force -or $PSCmdlet.ShouldProcess("$Server", "Removing BuildingID: $($item.ID), $($item.Name)")) { $item | Remove-WmiObject } } } } |