New-GroupParameters

NAME New-GroupParameters



SYNOPSIS

Creates a new set of group parameters for creating a brand new group under a group or probe.





SYNTAX

New-GroupParameters [-Name] <string> [<CommonParameters>]





DESCRIPTION

The New-GroupParameters cmdlet creates a set of parameters for adding a brand new group to PRTG. Group parameter

objects returned from New-GroupParameters allow specifying a variety of group specific configuration details

including auto-discovery settings at the time of object creation.



Note that not all group parameters (such as settings that can be inherited from the parent group or probe) can be

specified with PrtgAPI at the time of object creation. If you wish to modify such properties, this can be achieved

after the group has been created via the Set-ObjectProperty cmdlet.





PARAMETERS

-Name <string>

The name to give the new group.



Required? true

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



---------- EXAMPLE 1 ----------



C:\\> $params = New-GroupParameters Servers



C:\\> Get-Probe contoso | Add-Group $params



Add a new group called "Servers" to the Contoso probe.



---------- EXAMPLE 2 ----------



C:\\> $params = New-GroupParameters Servers

C:\\> $params.Tags = "awesomeGroup"



C:\\> Get-Probe Contoso | Add-Group $params



Add a new group called "Servers" to the Contoso probe with a custom tag "awesomeGroup".



RELATED LINKS

Online version: https://github.com/lordmilko/PrtgAPI/wi ... creation-1

Add-Group

Set-ObjectProperty

Get-Group

Get-Probe