Set-CTXZone.ps1

#Requires -Version 5.0

<#
    .SYNOPSIS
        Set the properties of the zone
    
    .DESCRIPTION  

    .NOTES
        This PowerShell script was developed and optimized for ScriptRunner. The use of the scripts requires ScriptRunner. 
        The customer or user is authorized to copy the script from the repository and use them in ScriptRunner. 
        The terms of use for ScriptRunner do not apply to this script. In particular, ScriptRunner Software GmbH assumes no liability for the function, 
        the use and the consequences of the use of this freely available script.
        PowerShell is a product of Microsoft Corporation. ScriptRunner is a product of ScriptRunner Software GmbH.
        © ScriptRunner Software GmbH

    .COMPONENT
        Requires the library script CitrixLibrary.ps1
        Requires PSSnapIn Citrix*

    .LINK
        https://github.com/scriptrunner/ActionPacks/blob/master/Citrix/Sites
        
    .Parameter SiteServer
        [sr-en] Specifies the address of a XenDesktop controller. 
        This can be provided as a host name or an IP address
        [sr-de] Name oder IP Adresse des XenDesktop Controllers

    .Parameter ZoneName
        [sr-en] Name of the zone
        [sr-de] Name der Zone

    .Parameter NewUid
        [sr-en] New uid of the Zone 
        [sr-de] Neue Uid der Zone

    .Parameter ExternalUid
        [sr-en] External Uid of the zone
        [sr-de] Externe Uid der Zone

    .Parameter Description 
        [sr-en] Description for the zone
        [sr-de] Beschreibung der Zone

    .Parameter TenantId	
        [sr-en] Identity of tenant associated with zone
        [sr-de] Mandant der Zone
#>

param( 
    [Parameter(Mandatory = $true)]
    [string]$ZoneName,
    [string]$SiteServer,
    [string]$NewUid,
    [string]$ExternalUid,
    [string]$Description,
    [string]$TenantId
)                                                            

$LogID = $null
[bool]$success = $false
try{ 
    StartCitrixSessionAdv -ServerName ([ref]$SiteServer)
    StartLogging -ServerAddress $SiteServer -LogText "Set Zone $($ZoneName)" -LoggingID ([ref]$LogID)
                      
    [hashtable]$cmdArgs = @{'ErrorAction' = 'Stop'
                            'AdminAddress' = $SiteServer
                            'LoggingId' = $LogID
                            'PassThru' = $null
                            'Name' = $ZoneName
                            }    
    
    if($PSBoundParameters.ContainsKey('NewUid') -eq $true){
        $cmdArgs.Add('NewUid',$NewUid)
    }
    if($PSBoundParameters.ContainsKey('Description') -eq $true){
        $cmdArgs.Add('Description',$Description)
    }
    if($PSBoundParameters.ContainsKey('ExternalUid') -eq $true){
        $cmdArgs.Add('ExternalUid',$ExternalUid)
    }
    if($PSBoundParameters.ContainsKey('TenantId') -eq $true){
        $cmdArgs.Add('TenantId',$TenantId)
    }

    $ret = Set-ConfigZone @cmdArgs | Select-Object *
    $success = $true
    if($SRXEnv) {
        $SRXEnv.ResultMessage = $ret
    }
    else{
        Write-Output $ret
    }
}
catch{
    throw 
}
finally{
    StopLogging -LoggingID $LogID -ServerAddress $SiteServer -IsSuccessful $success
    CloseCitrixSession
}