Connectors

Get-XpConnectors

Syntax

Get-XpConnectors [[-ConnectorNames] <string[]>] [-Timeout <int>] [<CommonParameters>]

Description

The command performs a search for connectors on the XPhone Connect Server and displays the result as a list of CFGConnectorParam objects. By default, only the following properties are displayed:

Name
Guid
ConnectorType
Active
Description

Parameter

• -ConnectorNames <String[]>

  • Specifies the string to be searched for on the XPhone Connect Server.

  • Several names can be entered, separated by commas.

  • It is strongly recommended to use enclosing quotation marks, as special characters (e.g. spaces) often occur in the strings.

• -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.

• <CommonParameters>

  • Describes the parameters that can be used with each Cmdlet. See Microsoft documentation.

Inputs

This command does not support input via the pipeline and is therefore usually at the beginning of a command chain.

Outputs

The command Get-XpConnectors returns objects of the type CFGConnectorParam.

Account	C4B.Atlas.Visualization.Config.Connector.CFGConnectorParam_Account Account {get;}
ActivationAtDaysOfWeek	System.Data.DataSet ActivationAtDaysOfWeek {get;set;}
ActivationEndTime	string ActivationEndTime {get;set;}
ActivationInterval	string ActivationInterval {get;set;}
ActivationIntervals	System.Data.DataSet ActivationIntervals {get;set;}
ActivationStartTime	string ActivationStartTime {get;set;}
Active	bool Active {get;set;}
AD	C4B.Atlas.Visualization.Config.Connector.CFGConnectorParam_AD AD {get;}
ADAccess	C4B.Atlas.Visualization.Config.Connector.CFGConnectorParam_ADAccess ADAccess {get;}
ConnectorType	string ConnectorType {get;set;}
ConnectorTypeDisplayName	string ConnectorTypeDisplayName {get;set;}
Description	string Description {get;set;}
Destination	C4B.Atlas.Visualization.Config.Connector.CFGConnectorParam_Destination Destination {get;}
ExtensionData	System.Runtime.Serialization.ExtensionDataObject ExtensionData {get;set;}
File	C4B.Atlas.Visualization.Config.Connector.CFGConnectorParam_File File {get;}
Guid	C4B.Atlas.ATGuid Guid {get;set;}
Name	string Name {get;set;}
Options	C4B.Atlas.Visualization.Config.Connector.CFGConnectorParam_Options Options {get;}
OptionsLineCreation	C4B.Atlas.Visualization.Config.Connector.CFGConnectorParam_OptionsLineCreation OptionsLineCreation {get;}
UtcOffset	timespan UtcOffset {get;set;}

You can display a list similar to this with the following command:

Get-XpConnectors | Get-Member

An output of all connectors with all properties (and their values) can be generated with the following command:

Get-XpConnectors | Select-Object -Property *

Examples

1. Show all connectors:

   Get-XpConnectors
   

2. Show the connector “MyADConnector”:

   Get-XpConnectors "MyADConnector"
   

3. Show all connectors starting with My and AD:

   Get-XpConnectors My* , AD*
   

4. Show all connectors that are of type Active Directory (AD):

   Get-XpConnectors | Where-Object {$_.ConnectorType -eq "AD"}
   

or:

Get-XpConnectors | Where-Object -Property ConnectorType -eq "AD"

Set-XpConnectors

Syntax

Set-XpConnectors [[-Objects] <CFGConnectorParam[]>] [-Timeout <int>] [<CommonParameters>]

Description

Set-XpConnectors saves the transferred CFGConnectorParam objects 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 changes can then no longer be reversed, so a thorough review of the changed data is essential.

Parameter

• -Objects <CFGConnectorParam[]>

  • Specifies the connector objects to be stored on the XPhone Connect Server.

• -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.

• <CommonParameters>

  • Describes the parameters that can be used with each Cmdlet. See Microsoft documentation.

Inputs

The input type is the type of objects that can be passed to Set-XpConnectors via pipelining:

• CFGConnectorParam

Outputs

The command Set-XpConnectors does not return any objects.

Examples

1. Deactivate the checkbox Allow moving of users created by the connector itself for all connectors

   Get-XpConnectors | foreach{$_.Options.MoveUsers = $False;$_} | Set-XpConnectors
   

   Explanation of the pipeline:

   1. The first step fetches all connectors from the XPhone Connect Server (Get-XpConnectors).

   2. Then, for all connectors found, the checkbox Allow moving of users created by the connector itself is deactivated (foreach{$_.Options.MoveUsers = $False;$_}).

   3. Finally, the changes are transferred to the XPhone Connect Server and saved (Set-XpConnectors).

2. Rename the description in all AD connectors to This is an AD connector

   Get-XpConnectors | Where{$_.ConnectorType -eq "AD"} | foreach{$_.Description = "Dies ist ein AD Konnektor";$_} | Set-XpConnectors
   

   Explanation of the pipeline:

   1. The first step fetches all connectors from the XPhone Connect Server (Get-XpConnectors).

   2. With Where{$_.ConnectorType -eq "AD") the result set is filtered according to the string AD.

   3. The description is then changed to “This is an AD connector” for all those connectors that remain after filtering (foreach{$_.Description = "This is an AD connector";$_}).

   4. Finally, the changes are transferred to the XPhone Connect Server and saved (Set-XpConnectors).

Start-XpConnectors

Syntax

Start-XpConnectors [[-ConnectorNames] <string[]>] [-Timeout <int>] [<CommonParameters>]

Description

The command performs a search for connectors on the XPhone Connect Server. A table is then output with the name and current status (progress indicator, but only a snapshot):

Name
State

Parameter

• -ConnectorNames <string[]>

  • Specifies the string to be searched for on the XPhone Connect Server.

  • Several names can be entered, separated by commas.

  • It is strongly recommended to use enclosing quotation marks, as special characters (e.g. spaces) often occur in the strings.

  • The name can be determined via Get-XpConnectors.

• -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.

• <CommonParameters>

  • Describes the parameters that can be used with each Cmdlet. See Microsoft documentation.

Inputs

The input type is the type of objects that can be passed to Set-XpConnectors via pipelining:

• CFGConnectorParam

Examples

1. Start all connectors

   Start-XpConnectors
   

2. Start all connectors that begin with My

   Start-XpConnectors My*
   

3. Start all Active Directory connectors

   Get-XpConnectors | Where-Object {$_.ConnectorType -eq "AD"} | Start-XpConnectors
   

   Explanation of the pipeline:

   1. The first step fetches all connectors from the XPhone Connect Server (Get-XpConnectors).

   2. With Where{$_.ConnectorType -eq "AD") the result set is filtered according to the string AD.

   3. Finally, the connectors are started (Start-XpConnectors).

Disable-XpConnectors

Syntax

Disable-XpConnectors [[-ConnectorNames] <string[]>] [-Timeout <int>] [<CommonParameters>]

Description

The command performs a search for connectors on the XPhone Connect Server and deactivates the time control. No output appears.

Parameter

• -ConnectorNames <string[]>

  • Specifies the string to be searched for on the XPhone Connect Server.

  • Several names can be entered, separated by commas.

  • It is strongly recommended to use enclosing quotation marks, as special characters (e.g. spaces) often occur in the strings.

  • The name can be determined via Get-XpConnectors.

• -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.

• <CommonParameters>

  • Describes the parameters that can be used with each Cmdlet. See Microsoft documentation.

Inputs

The input type is the type of objects that can be passed to Disable-XpConnectors via pipelining:

• CFGConnectorParam

Examples

1. Switch off the time control for all connectors

   Disable-XpConnectors *
   

2. Switch off the time control for all connectors that start with My

   Disable-XpConnectors My*
   

3. Switch off time control for all Active Directory connectors

   Get-XpConnectors | Where-Object {$_.ConnectorType -eq "AD"} | Disable-XpConnectors
   

   Explanation of the pipeline:

   1. The first step fetches all connectors from the XPhone Connect Server (Get-XpConnectors).

   2. With Where{$_.ConnectorType -eq "AD") the result set is filtered according to the string AD.

   3. Finally, the time control for the selected connectors is deactivated (Disable-XpConnectors).

Enable-XpConnectors

Syntax

Enable-XpConnectors [[-ConnectorNames] <string[]>] [-Timeout <int>] [<CommonParameters>]

Description

The command performs a search for connectors on the XPhone Connect Server and activates time control. No output appears.

Parameter

• -ConnectorNames <string[]>

  • Specifies the string to be searched for on the XPhone Connect Server.

  • Several names can be entered, separated by commas.

  • It is strongly recommended to use enclosing quotation marks, as special characters (e.g. spaces) often occur in the strings.

  • The name can be determined via Get-XpConnectors.

• -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.

• <CommonParameters>

  • Describes the parameters that can be used with each Cmdlet. See Microsoft documentation.

Inputs

The input type is the type of objects that can be passed to Enable-XpConnectors via pipelining:

• CFGConnectorParam

Examples

1. Switch on the time control for all connectors:

   Enable-XpConnectors *
   

2. Switch on the time control for all connectors starting with My:

   Enable-XpConnectors My*
   

3. Switch on time control for all Active Directory connectors:

   Get-XpConnectors | Where-Object {$_.ConnectorType -eq "AD"} | Enable-XpConnectors
   

   Explanation of the pipeline:

   1. The first step fetches all connectors from the XPhone Connect Server (Get-XpConnectors).

   2. With Where{$_.ConnectorType -eq "AD") the result set is filtered according to the string AD.

   3. Finally, the time control for the selected connectors is activated (Disable-XpConnectors).

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!