HaloAPI

1.8.0

Public/Set/Set-HaloAgent.ps1

Function Set-HaloAgent {
    <#
        .SYNOPSIS
            Updates one or more agents via the Halo API.
        .DESCRIPTION
            Function to send an agent update request to the Halo API
        .OUTPUTS
            Outputs an object containing the response from the web request.
    #>
    [CmdletBinding( SupportsShouldProcess = $True )]
    [OutputType([Object[]])]
    Param (
        # Object or array of objects containing properties and values used to update one or more existing agents.
        [Parameter( Mandatory = $True, ValueFromPipeline )]
        [Object[]]$Agent
    )
    Invoke-HaloPreFlightCheck
    try {
        $ObjectToUpdate = $Agent | ForEach-Object {
            $HaloAgentParams = @{
                AgentId = ($_.id)
                IncludeDisabled = $True
            }
            $AgentExists = Get-HaloAgent @HaloAgentParams
            if ($AgentExists) {
                Return $True
            } else {
                Return $False
            }
        }
        if ($False -notin $ObjectToUpdate) {
            if ($PSCmdlet.ShouldProcess($Agent -is [Array] ? 'Agents' : 'Agent', 'Update')) {
                New-HaloPOSTRequest -Object $Agent -Endpoint 'agent' -Update
            }
        } else {
            Throw 'One or more agents was not found in Halo to update.'
        }
    } catch {
        New-HaloError -ErrorRecord $_
    }
}