TechDocs › Powershell-Erweiterung › Konfiguration

Konnektoren

Get-XpConnectors

Syntax

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

Beschreibung

Der Befehl führt eine Suche nach Konnektoren auf dem XPhone Connect Server und gibt das Ergebnis als Liste von CFGConnectorParam Objekten aus. Standardmäßig werden nur folgende Properties angezeigt:

Name
Guid
ConnectorType
Active
Description

Parameter

• -ConnectorNames <String[]>

  • Gibt den String an, nach dem auf dem XPhone Connect Server gesucht wird.

  • Mehrere Namen können angegeben werden, getrennt durch Kommas.

  • Es wird dringend empfohlen, umschließende Anführungszeichen zu verwenden, da in den Strings häufig Sonderzeichen (z.B. Leerzeichen) vorkommen.

• -Timeout <int>

  • Zeitüberschreitung in Minuten.

  • Wenn ein Kommando (z.B. aufgrund zu vieler Datensätze o.ä.) zu lange benötigt, kann dieses Kommando mit diesem Parameter nach der angegebenen Zeit abgebrochen werden.

• <CommonParameters>

  • Beschreibt die Parameter, die mit jedem Cmdlet verwendet werden können. Siehe Microsoft Dokumentation.

Eingaben

Dieser Befehl unterstützt keine Eingabe über die Pipeline und steht daher meist am Anfang einer Befehlskette.

Ausgaben

Der Befehl Get-XpConnectors gibt Objekte vom Typ CFGConnectorParam zurück.

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;}

Eine Liste ähnlich dieser können Sie sich mit folgendem Befehl ausgeben lassen:

Get-XpConnectors | Get-Member

Eine Ausgabe aller Konnektoren mit allen Properties (und deren Werten) kann mit folgendem Befehl erzeugt werden:

Get-XpConnectors | Select-Object -Property *

Beispiele

1. Zeige alle Konnektoren an:

   Get-XpConnectors
   

2. Zeige den Konnektor „MyADConnector“ an:

   Get-XpConnectors "MyADConnector"
   

3. Zeige alle Konnektoren beginnend mit My und AD:

   Get-XpConnectors My* , AD*
   

4. Zeige alle Konnektoren, die vom Typ Active Directory sind (AD):

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

oder:

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

Set-XpConnectors

Syntax

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

Beschreibung

Set-XpConnectors speichert die übergebenen CFGConnectorParam Objekte im XPhone Connect Server.

Alle Änderungen am Objekt werden sofort und ohne Rückfrage an den XPhone Connect Server übertragen und dort gespeichert.

Warnung

Die Änderungen sind anschließend nicht mehr rückgängig zu machen, eine gründliche Überprüfung der geänderten Daten ist deshalb unumgänglich.

Parameter

• -Objects <CFGConnectorParam[]>

  • Spezifiziert die auf dem XPhone Connect Server zu speichernden Konnektor-Objekte.

• -Timeout <int>

  • Zeitüberschreitung in Minuten.

  • Wenn ein Kommando (z.B. aufgrund zu vieler Datensätze o.ä.) zu lange benötigt, kann dieses Kommando mit diesem Parameter nach der angegebenen Zeit abgebrochen werden.

• <CommonParameters>

  • Beschreibt die Parameter, die mit jedem Cmdlet verwendet werden können. Siehe Microsoft Dokumentation.

Eingaben

Der Eingabetyp ist der Typ der Objekte, die per Pipelining an Set-XpConnectors übergeben werden können:

• CFGConnectorParam

Ausgaben

Der Befehl Set-XpConnectors gibt keine Objekte zurück.

Beispiele

1. Deaktivieren der Checkbox Das Verschieben von Benutzern erlauben, die der Konnektor selbst angelegt hat bei allen Konnektoren

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

**Erläuterung der Pipeline:**

#. Der erste Schritt holt alle Konnektoren vom XPhone Connect Server (``Get-XpConnectors``).
#. Anschließend wird bei allen gefundenen Konnektoren, die Ckeckbox ``Das Verschieben von Benutzern erlauben, die der Konnektor selbst angelegt hat`` deaktiviert (``foreach{$_.Options.MoveUsers = $False;$_}``).
#. Schließlich werden die Änderungen an den XPhone Connect Server übertragen und gespeichert (``Set-XpConnectors``).

1. In allen AD Konnektoren die Beschreibung in Dies ist ein AD Konnektor umbenennen

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


**Erläuterung der Pipeline:**

#. Der erste Schritt holt alle Konnektoren vom XPhone Connect Server (``Get-XpConnectors``).
#. Mit ``Where{$_.ConnectorType -eq "AD"``) wird die Ergebnismenge nach dem String ``AD`` gefiltert.
#. Anschließend wird bei all denjenigen Konnektoren, die nach der Filterung noch übrig sind, die Beschreibung zu "Dies ist ein AD Konnektor" geändert (``foreach{$_.Description = "Dies ist ein AD Konnektor";$_}``).
#. Schließlich werden die Änderungen an den XPhone Connect Server übertragen und gespeichert (``Set-XpConnectors``).

Start-XpConnectors

Syntax

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

Beschreibung

Der Befehl führt eine Suche nach Konnektoren auf dem XPhone Connect Server aus. Danach wird eine Tabelle mit Name und aktueller Status ausgegeben (Fortschrittsanzeige, aber nur Momentaufnahme):

Name
State

Parameter

• -ConnectorNames <string[]>

  • Gibt den String an, nach dem auf dem XPhone Connect Server gesucht wird.

  • Mehrere Namen können angegeben werden, getrennt durch Kommas.

  • Es wird dringend empfohlen, umschließende Anführungszeichen zu verwenden, da in den Strings häufig Sonderzeichen (z.B. Leerzeichen) vorkommen.

  • Der Name kann über Get-XpConnectors ermittelt werden.

• -Timeout <int>

  • Zeitüberschreitung in Minuten.

  • Wenn ein Kommando (z.B. aufgrund zu vieler Datensätze o.ä.) zu lange benötigt, kann dieses Kommando mit diesem Parameter nach der angegebenen Zeit abgebrochen werden.

• <CommonParameters>

  • Beschreibt die Parameter, die mit jedem Cmdlet verwendet werden können. Siehe Microsoft Dokumentation.

Eingaben

Der Eingabetyp ist der Typ der Objekte, die per Pipelining an Set-XpConnectors übergeben werden können:

• CFGConnectorParam

Beispiele

1. Starte alle Konnektoren

Start-XpConnectors

1. Starte alle Konnektoren die mit My beginnen

Start-XpConnectors My*

1. Starte alle Active Directory Konnektoren

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

**Erläuterung der Pipeline:**

#. Der erste Schritt holt alle Konnektoren vom XPhone Connect Server (``Get-XpConnectors``).
#. Mit ``Where{$_.ConnectorType -eq "AD"``) wird die Ergebnismenge nach dem String ``AD`` gefiltert.
#. Schließlich werden die Konnektoren gestartet (``Start-XpConnectors``).

Disable-XpConnectors

Syntax

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

Beschreibung

Der Befehl führt eine Suche nach Konnektoren auf dem XPhone Connect Server aus und deaktiviert die Zeitsteuerung. Eine Ausgabe erscheint nicht.

Parameter

• -ConnectorNames <string[]>

  • Gibt den String an, nach dem auf dem XPhone Connect Server gesucht wird.

  • Mehrere Namen können angegeben werden, getrennt durch Kommas.

  • Es wird dringend empfohlen, umschließende Anführungszeichen zu verwenden, da in den Strings häufig Sonderzeichen (z.B. Leerzeichen) vorkommen.

  • Der Name kann über Get-XpConnectors ermittelt werden.

• -Timeout <int>

  • Zeitüberschreitung in Minuten.

  • Wenn ein Kommando (z.B. aufgrund zu vieler Datensätze o.ä.) zu lange benötigt, kann dieses Kommando mit diesem Parameter nach der angegebenen Zeit abgebrochen werden.

• <CommonParameters>

  • Beschreibt die Parameter, die mit jedem Cmdlet verwendet werden können. Siehe Microsoft Dokumentation.

Eingaben

Der Eingabetyp ist der Typ der Objekte, die per Pipelining an Disable-XpConnectors übergeben werden können:

• CFGConnectorParam

Beispiele

1. Schalte die Zeitsteuerung für alle Konnektoren aus

Disable-XpConnectors *

1. Schalte die Zeitsteuerung für alle Konnektoren die mit My beginnen aus

Disable-XpConnectors My*

1. Schalte die Zeitsteuerung für alle Active Directory Konnektoren aus

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

**Erläuterung der Pipeline:**

#. Der erste Schritt holt alle Konnektoren vom XPhone Connect Server (``Get-XpConnectors``).
#. Mit ``Where{$_.ConnectorType -eq "AD"``) wird die Ergebnismenge nach dem String ``AD`` gefiltert.
#. Schließlich wird die Zeitsteuerung für die ausgewählten Konnektoren deaktiviert (``Disable-XpConnectors``).

Enable-XpConnectors

Syntax

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

Beschreibung

Der Befehl führt eine Suche nach Konnektoren auf dem XPhone Connect Server aus aktiviert die Zeitsteuerung. Eine Ausgabe erscheint nicht.

Parameter

• -ConnectorNames <string[]>

  • Gibt den String an, nach dem auf dem XPhone Connect Server gesucht wird.

  • Mehrere Namen können angegeben werden, getrennt durch Kommas.

  • Es wird dringend empfohlen, umschließende Anführungszeichen zu verwenden, da in den Strings häufig Sonderzeichen (z.B. Leerzeichen) vorkommen.

  • Der Name kann über Get-XpConnectors ermittelt werden.

• -Timeout <int>

  • Zeitüberschreitung in Minuten.

  • Wenn ein Kommando (z.B. aufgrund zu vieler Datensätze o.ä.) zu lange benötigt, kann dieses Kommando mit diesem Parameter nach der angegebenen Zeit abgebrochen werden.

• <CommonParameters>

  • Beschreibt die Parameter, die mit jedem Cmdlet verwendet werden können. Siehe Microsoft Dokumentation.

Eingaben

Der Eingabetyp ist der Typ der Objekte, die per Pipelining an Enable-XpConnectors übergeben werden können:

• CFGConnectorParam

Beispiele

1. Schalte die Zeitsteuerung für alle Konnektoren ein:

Enable-XpConnectors *

1. Schalte die Zeitsteuerung für alle Konnektoren die mit My beginnen ein:

Enable-XpConnectors My*

1. Schalte die Zeitsteuerung für alle Active Directory Konnektoren ein:

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

**Erläuterung der Pipeline:**

#. Der erste Schritt holt alle Konnektoren vom XPhone Connect Server (``Get-XpConnectors``).
#. Mit ``Where{$_.ConnectorType -eq "AD"``) wird die Ergebnismenge nach dem String ``AD`` gefiltert.
#. Schließlich wird die Zeitsteuerung für die ausgewählten Konnektoren aktiviert (``Disable-XpConnectors``).