public/Rename-TNGroup.ps1
|
function Rename-TNGroup { <# .SYNOPSIS Renames a list of groups .DESCRIPTION Renames a list of groups .PARAMETER SessionObject Optional parameter to force using specific SessionObjects. By default, each command will connect to all connected servers that have been connected to using Connect-TNServer .PARAMETER GroupId The ID of the target group .PARAMETER Name The name of the target group .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with 'sea of red' exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this 'nice by default' feature off and enables you to catch exceptions with your own try/catch. .EXAMPLE PS C:\> Rename-TNGroup Renames a list of groups #> [CmdletBinding()] param ( [Parameter(ValueFromPipelineByPropertyName)] [object[]]$SessionObject = (Get-TNSession), [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Int32]$GroupId, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [string]$Name, [switch]$EnableException ) process { foreach ($session in $SessionObject) { $PSDefaultParameterValues["*:SessionObject"] = $session if ($session.MultiUser) { $groupparams = @{ SessionObject = $session Path = "/groups/$GroupId" Method = 'PUT' ContentType = "application/json" Parameter = (ConvertTo-Json -InputObject @{'name' = $Name } -Compress) } Invoke-TNRequest @groupparams } else { Stop-PSFFunction -EnableException:$EnableException -Message "Server ($($session.ComputerName)) for session $($session.sessionid) is not licenced for multiple users" -Continue } } } } |