public/Update-VSAInfoMsg.ps1
|
function Update-VSAInfoMsg { <# .Synopsis Sets the IsRead field on messages. .DESCRIPTION Switches if the specified messages are read. 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 Reason Optional parameter which specifies reason why alarm has been closed .EXAMPLE Update-VSAInfoMsg -ID 1, 2, 3 -IsRead .EXAMPLE Update-VSAInfoMsg -ID 1, 2, 3 -VSAConnection $connection .INPUTS Accepts piped non-persistent VSAConnection .OUTPUTS True if update was successful #> [CmdletBinding()] param ( [parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [VSAConnection] $VSAConnection, [parameter(DontShow, Mandatory=$false, ValueFromPipelineByPropertyName=$true)] [ValidateNotNullOrEmpty()] [string] $URISuffix = "api/v1.0/infocenter/messages/{0}", [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName=$true)] [ValidateScript({ foreach ($item in $_) { if ( -not [decimal]::TryParse($item, [ref]$null) ) { throw "All elements must be numeric. '$item' is not a valid number." } } return $true })] [decimal[]] $ID, [switch] $IsRead ) [hashtable]$Params =@{ URISuffix = $( $URISuffix -f $IsRead.ToString().ToLower() ) Method = 'PUT' Body = $( $ID | ConvertTo-Json -Compress ) } if($VSAConnection) {$Params.Add('VSAConnection', $VSAConnection)} return Invoke-VSARestMethod @Params } Export-ModuleMember -Function Update-VSAInfoMsg |