AutoMatePS

5.1.0

Functions/Public/Set-AMConstant.ps1

function Set-AMConstant {
    <#
        .SYNOPSIS
            Sets constants on an Automate agent property.
 
        .DESCRIPTION
            Set-AMConstant sets constants for an agent.
 
        .PARAMETER InputObject
            The agent property to modify.
 
        .PARAMETER Name
            The name of the constant to modify.
 
        .PARAMETER Value
            The value to set for the constant.
 
        .PARAMETER Comment
            The comment to set for the constant.
 
        .INPUTS
            The following Automate object types can be modified by this function:
            AgentProperty
 
        .OUTPUTS
            None
 
        .EXAMPLE
            Get-AMAgent "agent01" | Get-AMObjectProperty | Set-AMConstant -Name test -Value 123 -Comment "Test modifying a constant"
 
        .LINK
            https://github.com/AutomatePS/AutomatePS/blob/master/Docs/Set-AMConstant.md
    #>
    [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact="Medium")]
    param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        $InputObject,

        [Parameter(Mandatory = $true, Position = 0)]
        [ValidateNotNullOrEmpty()]
        [string]$Name,

        [Parameter(Mandatory = $true, Position = 1)]
        [ValidateNotNullOrEmpty()]
        [string]$Value,

        [AllowEmptyString()]
        [string]$Comment
    )

    PROCESS {
        foreach ($obj in $InputObject) {
            switch ($obj.Type) {
                "Agent" {
                    $parent = Get-AMAgent -ID $obj.ID -Connection $obj.ConnectionAlias
                }
                "AgentProperty" {
                    $parent = Get-AMAgent -ID $obj.ParentID -Connection $obj.ConnectionAlias
                }
                default {
                    Write-Error -Message "Unsupported input type '$($obj.Type)' encountered!" -TargetObject $obj
                }
            }
            $updateObject = $parent | Get-AMObjectProperty
            if (($updateObject | Measure-Object).Count -eq 1) {
                $shouldUpdate = $false
                $constant = $updateObject.Constants | Where-Object {$_.Name -eq $Name}
                if ($PSBoundParameters.ContainsKey("Value") -and $constant.Value -ne $Value) {
                    $constant.Value = $Value
                    $constant.ClearTextValue = $Value
                    $shouldUpdate = $true
                }
                if ($PSBoundParameters.ContainsKey("Comment") -and $constant.Comment -ne $Comment) {
                    $constant.Comment = $Comment
                    $shouldUpdate = $true
                }
                if ($shouldUpdate) {
                    if ($PSCmdlet.ShouldProcess($obj.ConnectionAlias, "Modifying $($obj.Type) for $($parent.Type): $(Join-Path -Path $parent.Path -ChildPath $parent.Name).")) {
                        $splat = @{
                            Resource = "agents/$($obj.ParentID)/properties/update"
                            RestMethod = "Post"
                            Body = $updateObject.ToJson()
                            Connection = $updateObject.ConnectionAlias
                        }
                        Invoke-AMRestMethod @splat | Out-Null
                        Write-Verbose "Modified $($obj.Type) for $($parent.Type): $(Join-Path -Path $parent.Path -ChildPath $parent.Name)."
                    }
                } else {
                    Write-Verbose "$($obj.Type) for $($parent.Type) '$($parent.Name)' already contains the specified values."
                }
            } else {
                Write-Error -Message "AgentProperty not specified!" -TargetObject $obj
            }
        }
    }
}