Public/Set-LMDevice.ps1
|
Function Set-LMDevice { [CmdletBinding(SupportsShouldProcess,ConfirmImpact='None')] Param ( [Parameter(Mandatory, ParameterSetName = 'Id', ValueFromPipelineByPropertyName)] [String]$Id, [Parameter(Mandatory, ParameterSetName = 'Name')] [String]$Name, [String]$NewName, [String]$DisplayName, [String]$Description, [String]$PreferredCollectorId, [String]$PreferredCollectorGroupId, [Hashtable]$Properties, [String[]]$HostGroupIds, #Dynamic group ids will be ignored, operation will replace all existing groups [ValidateSet("Add", "Replace", "Refresh")] # Add will append to existing prop, Replace will update existing props if specified and add new props, refresh will replace existing props with new [String]$PropertiesMethod = "Replace", [String]$Link, [Nullable[boolean]]$DisableAlerting, [Nullable[boolean]]$EnableNetFlow, [String]$NetflowCollectorGroupId, [String]$NetflowCollectorId ) #Check if we are logged in and have valid api creds Begin {} Process { If ($Script:LMAuth.Valid) { #Lookup ParentGroupName If ($Name) { $LookupResult = (Get-LMDevice -Name $Name).Id If (Test-LookupResult -Result $LookupResult -LookupString $Name) { return } $Id = $LookupResult } #Build custom props hashtable $customProperties = @() If ($Properties) { Foreach ($Key in $Properties.Keys) { $customProperties += @{name = $Key; value = $Properties[$Key] } } } #Build header and uri $ResourcePath = "/device/devices/$Id" If($PSItem){ $Message = "Id: $Id | Name: $($PSItem.name) | DisplayName: $($PSItem.displayName)" } ElseIf($Name){ $Message = "Id: $Id | Name: $Name" } Else{ $Message = "Id: $Id" } Try { $Data = @{ name = $NewName displayName = $DisplayName description = $Description disableAlerting = $DisableAlerting enableNetflow = $EnableNetFlow customProperties = $customProperties preferredCollectorId = $PreferredCollectorId preferredCollectorGroupId = $PreferredCollectorGroupId link = $Link netflowCollectorGroupId = $NetflowCollectorGroupId netflowCollectorId = $NetflowCollectorId hostGroupIds = $HostGroupIds -join "," } #Remove empty keys so we dont overwrite them @($Data.keys) | ForEach-Object { if ([string]::IsNullOrEmpty($Data[$_]) -and ($_ -notin @($MyInvocation.BoundParameters.Keys))) { $Data.Remove($_) } } $Data = ($Data | ConvertTo-Json) If ($PSCmdlet.ShouldProcess($Message, "Set Device")) { $Headers = New-LMHeader -Auth $Script:LMAuth -Method "PATCH" -ResourcePath $ResourcePath -Data $Data $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath + "?opType=$($PropertiesMethod.ToLower())" Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation -Payload $Data #Issue request $Response = Invoke-RestMethod -Uri $Uri -Method "PATCH" -Headers $Headers[0] -WebSession $Headers[1] -Body $Data Return (Add-ObjectTypeInfo -InputObject $Response -TypeName "LogicMonitor.Device" ) } } Catch [Exception] { $Proceed = Resolve-LMException -LMException $PSItem If (!$Proceed) { Return } } } Else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } End {} } |