Configuration groups
Get-XpConfigGroups
Syntax
Parameterset string:
Get-XpConfigGroups -LocationNames <String[]> [-ConfigGroupNames <String[]>] [-Timeout <int>]
Parameterset object:
Get-XpConfigGroups [-Locations] <LocationObjects[]> [-ConfigGroupNames <String[]>]
Description
The Get-XpConfigGroups
command returns configuration group objects.
Without the -ConfigGroupNames
parameter, only the default configuration group of the location is displayed.
By default, only site name, configuration group name and configuration group description are output. However, using the command Select-Object
all available properties of the configuration groups can be displayed (See examples).
Parameter
-LocationNames <String[]>
Equivalent to a version of:
>Get-XpLocations -LocationNames <String[]> | Get-XpConfigGroups -LocationObjects <CFGBranch[]>
Is usually passed via the pipeline and is the same as the result of:
>Get-XpLocations
-ConfigGroupNames <String[]>
Optionally, a list of configuration group names (separated by commas) can be specified.
If this parameter is not specified, only the default configuration group of the corresponding locations is returned.
With the wildcard symbol
*
all configuration groups of a location are returned.
-Timeout <int>
Timeout in minutes.
Input
The input type is the type of object which can be transferred to Get-XpConfigGroups
via pipelining:
CFGBranch
Output
The command Get-XpConfigGroup
returns objects of type CFGConfigGroup
.
CFGConfigGroup |
|
---|---|
Property |
Supported values |
BranchName |
String |
GuidAnnouncement |
|
GuidClient |
|
GuidCollaboration |
|
GuidContactList |
|
GuidFax |
|
GuidInstantMessaging |
|
GuidLanguage |
|
GuidMobileControl |
|
GuidPasswordComplexity |
|
GuidPresence |
|
GuidSms |
|
GuidTelephony |
|
GuidTemplateContainer |
|
GuidVoicemail |
|
IsDefault |
Boolean |
Description |
String |
FunctionAnnouncement |
ConfigGroupInherit | ConfigGroupIndividual |
FunctionClient |
ConfigGroupInherit | ConfigGroupIndividual |
FunctionCollaboration |
ConfigGroupInherit | ConfigGroupIndividual | ConfigGroupInactive |
FunctionContactList |
ConfigGroupInherit | ConfigGroupIndividual |
FunctionFax |
ConfigGroupInherit | ConfigGroupIndividual | ConfigGroupInactive |
FunctionInstantMessaging |
ConfigGroupInherit | ConfigGroupIndividual | ConfigGroupInactive |
FunctionLanguage |
ConfigGroupInherit | ConfigGroupIndividual |
FunctionMailbox |
|
FunctionMobileControl |
|
FunctionPasswordComplexity |
ConfigGroupInherit | ConfigGroupIndividual |
FunctionPresence |
ConfigGroupInherit | ConfigGroupIndividual | ConfigGroupInactive |
FunctionSms |
ConfigGroupInherit | ConfigGroupIndividual | ConfigGroupInactive |
FunctionTelephony |
ConfigGroupInherit | ConfigGroupIndividual | ConfigGroupInactive |
FunctionVoicemail |
ConfigGroupInherit | ConfigGroupIndividual | ConfigGroupInactive |
Id |
|
Name |
String |
ExtensionData |
|
UtcOffset |
Example
Output of the standard configuration group of the Main location:
>Get-XpLocations Hauptstandort | Get-XpConfigGroups
Output of all configuration group of the Main location:
>Get-XpLocations Hauptstandort | Get-XpConfigGroups -ConfigGroupNames *
Please note that the
-ConfigGroupNames
parameter must be explicitly referred to.
>Get-XpLocations Hauptstandort | Get-XpConfigGroups *
would lead to an error message!
Output of the KGruppe1 and KGruppe2 configuration groups of the Main location und Secondary location:
>Get-XpLocations Hauptstandort,Nebenstandort | Get-XpConfigGroups -ConfigGroupNames KGruppe1,KGruppe2
Set-XpConfigGroups
Syntax
Set-XpConfigGroups -ConfigGroups <CFGConfigGroup[]> [-Timeout <int>]
Description
Set-XpConfigGroups
saves the transferred CFGConfigGroup objects from Get-XpConfigGroups
in the XPhone Connect Server.
All changes made to the object are immediately transferred to the XPhone Connect Server without query where they are saved.
Warning
The search basis saved is no longer valid and is deleted. Please select a new search basis.
Parameter
ConfigGroups <CFGConfigGroup[]>
Specifies the configuration group objects to be stored in XPhone Connect Server.
These objects are typically passed through the pipeline.
-Timeout <int>
Timeout in minutes.
Input
The input type is the type of objects that can be pipelined to Set-XpConfigGroups
:
CFGConfigGroup
Output
The command Set-XpConfigGroups
does not return any objects.
Example
Conversion of the client template for all configuration groups called Configuration group1 from Inherits from location to Individual:
> Get-XpLocations | Get-XpConfigGroups -ConfigGroupNames Konfigurationsgruppe1 | foreach{$_.FunctionClient = "ConfigGroupIndividual";$_} | Set-XpConfigGroups
Have you found an mistake on this page?
Please send us a hint about this error by mail to doku@c4b.de. Thank you very much!