Output/HaloAPI/Public/New/New-HaloAgent.ps1
|
Function New-HaloAgent { <# .SYNOPSIS Creates an agent via the Halo API. .DESCRIPTION Function to send an agent creation request to the Halo API .OUTPUTS Outputs an object containing the response from the web request. #> [CmdletBinding( SupportsShouldProcess = $True )] [OutputType([Object])] Param ( # Object containing properties and values used to create a new agent. [Parameter( Mandatory = $True )] [Object]$Agent ) Invoke-HaloPreFlightChecks $CommandName = $MyInvocation.InvocationName try { if ($PSCmdlet.ShouldProcess("Agent '$($Agent.name)'", 'Create')) { New-HaloPOSTRequest -Object $Agent -Endpoint 'agent' } } catch { $Command = $CommandName -Replace '-', '' $ErrorRecord = @{ ExceptionType = 'System.Exception' ErrorMessage = "$($CommandName) failed." InnerException = $_.Exception ErrorID = "Halo$($Command)CommandFailed" ErrorCategory = 'ReadError' TargetObject = $_.TargetObject ErrorDetails = $_.ErrorDetails BubbleUpDetails = $False } $CommandError = New-HaloErrorRecord @ErrorRecord $PSCmdlet.ThrowTerminatingError($CommandError) } } |