Configuration groups

Get-XpConfigGroups

Syntax

Parameter set string:

Get-XpConfigGroups -LocationNames <String[]> [-ConfigGroupNames <String[]>] [-Timeout <int>] [<CommonParameters>]

Parameter set object:

Get-XpConfigGroups [-Locations] <LocationObjects[]> [-ConfigGroupNames <String[]>] [<CommonParameters>]

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.

    • If a command takes too long (e.g. due to too many data records or similar), this command can be aborted with this parameter after the specified time.

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

  1. Output of the standard configuration group of the Main location

    >Get-XpLocations Hauptstandort | Get-XpConfigGroups

  2. Output of all configuration groups of the Main location:

    >Get-XpLocations Hauptstandort | Get-XpConfigGroups -ConfigGroupNames *

    • Please note that in this case the parameter -ConfigGroupNames must be explicitly named.

    • >Get-XpLocations Hauptstandort | Get-XpConfigGroups * would lead to an error message!

  3. Output of the KGruppe1 and KGruppe2 configuration groups of the Main location and 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 to the object are transferred to the XPhone Connect Server immediately and without further inquiry and stored there.

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 normally passed through the pipeline.

  • -Timeout <int>

    • Timeout in minutes.

    • If a command takes too long (e.g. due to too many data records or similar), this command can be aborted with this parameter after the specified time.

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 a mistake on this page?

Or is something not formulated well or too vague? Then we look forward to receiving an e-mail, preferably with a suggestion for improvement, to doku@c4b.de. Thank you very much!