Public/Remove-UnityNasServer.ps1
|
Function Remove-UnityNASServer { <# .SYNOPSIS Delete a Nas Server. .DESCRIPTION Delete a Nas Server. Before you can delete a NAS server, you must first delete all storage resources associated with it. Deleting a NAS server removes everything configured on the NAS server, but does not delete the storage resources that use it. You cannot delete a NAS server while it has any associated storage resources. After the storage resources are deleted, the files and folders inside them cannot be restored from snapshots. Back up the data from the storage resources before deleting them from the system. You need to have an active session with the array. .NOTES Written by Erwan Quelin under MIT licence - https://github.com/equelin/Unity-Powershell/blob/master/LICENSE .LINK https://github.com/equelin/Unity-Powershell .PARAMETER Session Specifies an UnitySession Object. .PARAMETER ID Specifies the NAS server ID or Object. .PARAMETER Confirm If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. .PARAMETER WhatIf Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified. .EXAMPLE Remove-UnityNasServer -ID 'nas_6' Delete the Nas Server with ID 'nas_6' .EXAMPLE Get-UnityNasServer -Name 'NAS01' | Remove-UnityNasServer Delete the Nas Server named 'NAS01'. The NAS server's informations are provided by the Get-UnityNasServer through the pipeline. #> [CmdletBinding(SupportsShouldProcess = $True,ConfirmImpact = 'High')] Param ( #Default Parameters [Parameter(Mandatory = $false,HelpMessage = 'EMC Unity Session')] $session = ($global:DefaultUnitySession | where-object {$_.IsConnected -eq $true}), #NasServer [Parameter(Mandatory = $true,Position = 0,ValueFromPipeline=$True,ValueFromPipelinebyPropertyName=$True,HelpMessage = 'Nas server ID or Object')] $ID ) Begin { Write-Verbose "Executing function: $($MyInvocation.MyCommand)" # Variables $URI = '/api/instances/nasServer/<id>' $Type = 'NAS Server' $TypeName = 'UnityNasServer' $StatusCode = 204 } Process { Foreach ($sess in $session) { Write-Verbose "Processing Session: $($sess.Server) with SessionId: $($sess.SessionId)" If ($Sess.TestConnection()) { Foreach ($i in $ID) { # Determine input and convert to object if necessary Switch ($i.GetType().Name) { "String" { $Object = get-UnityNASServer -Session $Sess -ID $i $ObjectID = $Object.id If ($Object.Name) { $ObjectName = $Object.Name } else { $ObjectName = $ObjectID } } "$TypeName" { Write-Verbose "Input object type is $($i.GetType().Name)" $ObjectID = $i.id If ($Object = Get-UnityNASServer -Session $Sess -ID $ObjectID) { If ($Object.Name) { $ObjectName = $Object.Name } else { $ObjectName = $ObjectID } } } } # End Switch If ($ObjectID) { #Building the URL $FinalURI = $URI -replace '<id>',$ObjectID $URL = 'https://'+$sess.Server+$FinalURI Write-Verbose "URL: $URL" if ($pscmdlet.ShouldProcess($Sess.Name,"Delete $Type $ObjectName")) { #Sending the request $request = Send-UnityRequest -uri $URL -Session $Sess -Method 'DELETE' } If ($request.StatusCode -eq $StatusCode) { Write-Verbose "$Type with ID $ObjectID has been deleted" } # End If ($request.StatusCode -eq $StatusCode) } else { Write-Warning -Message "$Type with ID $i does not exist on the array $($sess.Name)" } # End If ($ObjectID) } # End Foreach ($i in $ID) } # End If ($Sess.TestConnection()) } # End Foreach ($sess in $session) } # End Process } # End Function |