public/Close-VSAAlarm.ps1
|
function Close-VSAAlarm { <# .Synopsis Closes VSA alarm .DESCRIPTION Switches status of specific VSA alarm from Open to Closed Takes either persistent or non-persistent connection information. .PARAMETER VSAConnection Specifies existing non-persistent VSAConnection. .PARAMETER URISuffix Specifies URI suffix if it differs from the default.\ .PARAMETER AlarmId Specifies id of alarm .PARAMETER Reason Optional parameter which specifies reason why alarm has been closed .EXAMPLE Close-VSAAlarm -AlarmId 5 -Reason "Planned restart" .EXAMPLE Close-VSAAlarm -VSAConnection $connection .INPUTS Accepts piped non-persistent VSAConnection .OUTPUTS No output #> [CmdletBinding()] param ( [parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [VSAConnection] $VSAConnection, [parameter(DontShow, Mandatory=$false, ValueFromPipelineByPropertyName=$true)] [ValidateNotNullOrEmpty()] [string] $URISuffix = "api/v1.0/assetmgmt/alarms/{0}/close", [Alias('ID')] [Parameter(Mandatory = $true)] [ValidateScript({ if( $_ -notmatch "^\d+$" ) { throw "Non-numeric Id" } return $true })] [string] $AlarmId, [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)] [ValidateNotNullOrEmpty()] [string] $Reason ) $URISuffix = $URISuffix -f $AlarmId [hashtable]$Params =@{ URISuffix = $($URISuffix -f $AlarmId) Method = 'PUT' } if ($Reason) { $Body = ConvertTo-Json @(@{"key"="notes";"value"=$Reason }) -Compress $Params.Add('Body', $Body) } if($VSAConnection) {$Params.Add('VSAConnection', $VSAConnection)} return Invoke-VSARestMethod @Params } Export-ModuleMember -Function Close-VSAAlarm |