Public/Update-MacmonEndpointProperty.ps1
|
function Update-MacmonEndpointProperty { <# .SYNOPSIS Update Endpoint Property from the macmon NAC via RESTAPI. .DESCRIPTION Update Endpoint Property from the macmon NAC via RESTAPI. Not all properties configurable per RESTAPI are available in this function. .PARAMETER HostName IP-Address or Hostname of the macmon NAC .PARAMETER TCPPort TCP Port API (Default: 443) .PARAMETER ApiVersion API Version to use (Default: 1.0) .PARAMETER Credential Credentials for the macmon NAC .PARAMETER MACAddress MAC address of the endpoint .PARAMETER Comment Comments about the endpoint .PARAMETER Active String, True or False. An inactive (deactivated) corporate device is evaluated as unauthorized. .PARAMETER IPAddress Preset IP address(es) of the endpoint .PARAMETER Inventory Inventory number of the endpoint. .PARAMETER AuthorizedVlans Blank space separated list of permitted VLAN IDs or VLAN names .PARAMETER EndpointGroupId ID of the Group of the endpoint .EXAMPLE $Credential = Get-Credential -Message 'Enter your credentials' Update-MacmonEndpointProperty -Hostname 'MACMONSERVER' -Credential $Credential -MACAddress '8C-73-6E-0B-33-6E' -Comment 'New Comment' #Ask for credential then update comment of endpoint with MACAddress '8C-73-6E-0B-33-6E' .EXAMPLE $Properties = @{ Hostname = 'MACMONSERVER' MACAddress = '8C-73-6E-0B-33-6E' Comment = 'New Comment' Active = 'False' IPAddress = '192.168.1.1', '10.10.10.11' Inventory = '012345' AuthorizedVlans = '10', '20', '30' #API bug EndpointGroupId = 11 } Update-MacmonEndpointProperty @Properties #update endpoint with MACAddress '8C-73-6E-0B-33-6E' (all provided properties) .OUTPUTS none .LINK https://github.com/falkheiland/PSmacmon .LINK https://<MACMONSERVER>/man/index.php?controller=ApiDocuController #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory)] [string] $HostName, [ValidateSet(0, 65535)] [Int] $TCPPort = 443, [ValidateSet('1.0')] [string] $ApiVersion = '1.0', [ValidateNotNull()] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential = (Get-Credential -Message 'Enter your credentials'), [Parameter(Mandatory)] [ValidatePattern('(([0-9A-Fa-f]{2}[-:]){5}[0-9A-Fa-f]{2})|(([0-9A-Fa-f]{4}\.){2}[0-9A-Fa-f]{4})')] [string] $MACAddress, [string] $Comment, [string] [ValidateSet('True', 'False')] $Active, [ValidateScript( {$_ -match [IPAddress]$_})] [Alias('StaticIps')] [string[]] $IPAddress, [string] $Inventory, [string[]] $AuthorizedVlans, [int] $EndpointGroupId ) begin { Invoke-MacmonTrustSelfSignedCertificate $UriArray = @($HostName, $TCPPort, $ApiVersion) $BaseURL = ('https://{0}:{1}/api/v{2}/endpoints' -f $UriArray) $Params = @{ Credential = $Credential Method = 'Patch' } $Body = @() $Op = 'replace' } process { if ($Comment) { $Body += @{ op = $Op path = '/comment' value = $Comment } } if ($Active) { $Body += @{ op = $Op path = '/active' value = $Active } } if ($IPAddress) { $Body += @{ op = $Op path = '/staticIps' value = $IPAddress } } if ($Inventory) { $Body += @{ op = $Op path = '/inventory' value = $Inventory } } if ($AuthorizedVlans) { $Body += @{ op = $Op path = '/authorizedVlans' value = @($AuthorizedVlans) } } if ($EndpointGroupId) { $Body += @{ op = $Op path = '/endpointGroupId' value = $EndpointGroupId } } $Params.Add('Body', (ConvertTo-Json $Body)) $Params.Add('Uri', ('{0}/{1}' -f $BaseURL, $MACAddress)) if ($PSCmdlet.ShouldProcess('EndpointGroup: {0}' -f $MACAddress)) { Invoke-MacmonRestMethod @Params } } end { } } |