Functions/Public/New-AMAgentGroup.ps1
|
function New-AMAgentGroup { <# .SYNOPSIS Creates a new Automate agent group. .DESCRIPTION New-AMAgentGroup creates an agent group object. .PARAMETER Name The name of the new object. .PARAMETER Notes The new notes to set on the object. .PARAMETER Folder The folder to place the object in. .PARAMETER Connection The server to create the object on. .EXAMPLE # Create an agent group New-AMAgentGroup -Name "All Agents" -Notes "Group containing all agents" .LINK https://github.com/AutomatePS/AutomatePS/blob/master/Docs/New-AMAgentGroup.md #> [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact="Low")] param ( [Parameter(Mandatory = $true, Position = 0)] [ValidateNotNullOrEmpty()] [string]$Name, [string]$Notes = "", [ValidateScript({$_.Type -eq "Folder"})] $Folder, [ValidateNotNullOrEmpty()] [ArgumentCompleter([AMConnectionCompleter])] $Connection ) if ($PSBoundParameters.ContainsKey("Connection")) { $Connection = Get-AMConnection -Connection $Connection } else { $Connection = Get-AMConnection } switch (($Connection | Measure-Object).Count) { 1 { $user = Get-AMUser -Connection $Connection | Where-Object {$_.Name -ieq $Connection.Credential.UserName} if (-not $Folder) { $Folder = Get-AMFolder -Path "\" -Name "AGENTGROUPS" -Connection $Connection } # Place the agent group in the root agent groups folder switch ($Connection.Version.Major) { 10 { $newObject = [AMAgentGroupv10]::new($Name, $Folder, $Connection.Alias) } 11 { $newObject = [AMAgentGroupv11]::new($Name, $Folder, $Connection.Alias) } default { throw "Unsupported server major version: $_!" } } $newObject.CreatedBy = $user.ID $newObject.Notes = $Notes $newObject | New-AMObject -Connection $Connection } 0 { throw "No servers are currently connected!" } default { throw "Multiple Automate servers are connected, please specify which server to create the new agent group on!" } } } |