Gateways

Get-XpGateways

Syntax

Get-XpGateways [[-GatewayNames] <string[]>] [[-Type] {Any | CTI | SIP}] [-LineCreateConfig] [-LineVarConfig] [-Enabled] [-State] [-StateDetail] [-Timeout <int>] [<CommonParameters>]

Beschreibung

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

Name
Type
PBXType

Parameter

-GatewayNames <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.
-Type {Any | CTI | SIP}
- Wird verwendet, um nach dem Typ des Gateways zu suchen (Alle, nur CIT Gateways oder nur SIP Gateways).
-LineCreateConfig
- Dieser Parameter gibt den Bereich einzurichtender Leitungen aus (FirstNumber, LastNumber, DialParam).
- Dieser Parameter akzeptiert als Eingabe nur ein Gateway.
-LineVarConfig
- Dieser Parameter gibt die erweiterten Einstellungen zur Leitungserzeugung aus.
-Enabled
- Dieser Parameter zeigt, ob ein Gateway aktiviert (Enabled = True) oder deaktiviert (Enabled = False) ist.
-State
- Gibt den aktuellen Status zurück (Name, State, Description).
-StateDetail
- Gibt den aktuellen Status zurück (Name, State, Description).
-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-XpGateways gibt Objekte vom Typ ATTPBXObjectSerial zurück.

Type	GatewayType Type=CTI
Changed	bool Changed {get;set;}
Description	string Description {get;set;}
DialParamGuid	C4B.Atlas.ATGuid DialParamGuid {get;set;}
Enabled	bool Enabled {get;set;}
Guid	C4B.Atlas.ATGuid Guid {get;}
HostIPAddress	string HostIPAddress {get;set;}
LineAddressTrk	string LineAddressTrk {get;}
LogMode	C4B.Atlas.Telephony.Config.ATTPBXLogMode LogMode {get;set;}
LogPath	string LogPath {get;set;}
ModifyTimeStamp	datetime ModifyTimeStamp {get;set;}
Name	string Name {get;set;}
PBXLineCreateInfo	C4B.Atlas.ATArrayList PBXLineCreateInfo {get;}
PBXLineVarConfig	C4B.Atlas.ATArrayList PBXLineVarConfig {get;}
PBXType	C4B.Atlas.Telephony.Config.ATTPBXType PBXType {get;set;}
Port	int Port {get;set;}
VarConfig	C4B.Atlas.ATStringDictionary VarConfig {get;}

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

Get-XpGateways | Get-Member

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

Get-XpGateways | Select-Object -Property *

Beispiele

Zeige alle Gateways (CTI / SIP) an
Get-XpGateways
Zeige das Gateway „OSBiz CSTA“ an
Get-XpGateways "OSBiz CSTA"
Zeige alle Gateways beginnend mit OSBiz
Get-XpGateways OSBiz*

Zeige alle SIP Gateways (vom Typ SIP)

Get-XpGateways | Where{$_.Type -eq "SIP"}

oder

Get-XpGateways | Where-Object -Property Type -eq "SIP"

Set-XpGateways

Syntax

Set-XpGateways [-Objects] <Object[]> [[-GatewayName] <string>] [-LineCreateConfig] [-Timeout <int>]  [<CommonParameters>]

Beschreibung

Set-XpGateways kann ausschließlich das Property PBXLineCreateInfo setzen. Der GatewayName ist obligatorisch.

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 <ATTPBXObjectSerial[]>
- Spezifiziert die auf dem XPhone Connect Server zu speichernden Gateway-Objekte.
-GatewayName <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.
- Kann mit Get-XpGateways ermittelt werden.
-LineCreateConfig
- Dieser Parameter ist erforderlich, wenn das Property PBXLineCreateInfo geändert werden soll (siehe Beispiel).
-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-XpGateways übergeben werden können:

ATTPBXObjectSerial

Ausgaben

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

Beispiel

In diesem Beispiel soll der Rufnummernbereich für die Massenerstellung von Leitungen angepasst werden. Diese Konfiguration finden Sie in der Web Administration unter Systemeinstellungen > Telefonie & Meetings > Telefonie > CTI > CTI Gateway > Leitungen erstellen.

Hier wird keine Pipeline verwendet, was aber prinzipiell möglich wäre.

Zuerst wird ein CTI Gateway Objekt in die Variable $gw gespeichert. Danach wird die Variable ausgegeben:

PS C:\Windows\system32> $gw = Get-XpGateways OSBizCSTA
PS C:\Windows\system32> $gw

Name      Type           PBXType
----      ----           -------
OSBizCSTA  CTI OpenScapeBusiness

Hier wird der Inhalt des Properties PBXLineCreateInfo ausgegeben. Das Feld LastNumber soll verändert werden:

PS C:\Windows\system32> $gw.PBXLineCreateInfo


FirstNumber          : 11
LastNumber           : 19
DialParamGuid        : 00000000-0000-0000-0000-000000000000
PBXLineVarConfigGuid : 00000000-0000-0000-0000-000000000000
IsValid              : True

Hier wird der Typ ermittelt und Sie können sehen, dass das Property PBXLineCreateInfo ein Array ist:

PS C:\Windows\system32> $gw.PBXLineCreateInfo.GetType()

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     ATArrayList                              System.Collections.ArrayList

Wählt man das Array Objekt [0] aus, so erhält man diese Information:

PS C:\Windows\system32> $gw.PBXLineCreateInfo[0].GetType()

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     ATTPBXLineCreateInfo                     System.Object

Hier wird das Feld LastNumber des Array Objektes PBXLineCreateInfo[0] mit 20 überschrieben:
PS C:\Windows\system32> $gw.PBXLineCreateInfo[0].LastNumber = 20

Mit diesem Kommando wird die Konfiguration in das Gateway geschrieben:

PS C:\Windows\system32> Set-XpGateways $gw -GatewayName OSBizCSTA -LineCreateConfig

Disable-XpGateways

Syntax

Disable-XpGateways [[-GatewayNames] <string[]>] [[-Type] {Any | CTI | SIP}] [-Timeout <int>] [<CommonParameters>]

Beschreibung

Der Befehl deaktiviert die PBX-Gateways (Any | CTI | SIP) auf dem XPhone Connect Server und gibt eine Liste der betroffenen Gateways einschließlich ihrer GUIDs und Status zurück.

Parameter

-GatewayNames <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.
- Die Namen der Gateways können mit dem Befehl Get-XpGateways ermittelt werden.
-Type {Any | CTI | SIP}
- Sucht nach den SIP Gateways (SIP) oder nach CTI Gateways (CTI) oder allen (ANY).
-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.

Beispiel

Deaktivieren aller Gateways:
Disable-XpGateways
Deaktivieren aller SIP Gateways:
Disable-XpGateways -Type SIP
Deaktivieren aller Gateways mit OSBiz beginnen:
Disable-XpGateways OSBiz*
Deaktivieren aller Gateways mit dem Namen OSBizCSTA:
Disable-XpGateways -GatewayNames "OSBizCSTA"

Enable-XpGateways

Syntax

Enable-XpGateways [[-GatewayNames] <string[]>] [[-Type] {Any | CTI | SIP}] [-Timeout <int>] [<CommonParameters>]

Beschreibung

Der Befehl aktiviert die PBX-Gateways (Any | CTI | SIP) auf dem XPhone Connect Server und gibt eine Liste der betroffenen Gateways einschließlich ihrer GUIDs und Status zurück.

Parameter

-GatewayNames <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 der Gateways können mit dem Befehl Get-XpGateways ermittelt werden.
-Type {Any | CTI | SIP}
- Sucht nach den SIP Gateways (SIP) oder nach CTI Gateways (CTI) oder allen (ANY).
-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.

Beispiele

Aktivieren aller Gateways:
Enable-XpGateways
Aktivieren aller SIP Gateways:
Enable-XpGateways -Type SIP
Aktivieren aller Gateways mit OSBiz beginnen:
Enable-XpGateways OSBiz*
Aktivieren aller Gateways mit dem Namen OSBizCSTA:
Enable-XpGateways -GatewayNames "OSBizCSTA"

Restart-XpGateways

Syntax

Restart-XpGateways [[-GatewayNames] <string[]>] [[-Type] {Any | CTI | SIP}] [-Timeout <int>]  [<CommonParameters>]

Beschreibung

Der Befehl restartet die PBX-Gateways (Any | CTI | SIP) auf dem XPhone Connect Server und gibt eine Liste der betroffenen Gateways einschließlich ihrer GUIDs und Status zurück.

Parameter

-GatewayNames <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.
- Die Namen der Gateways können mit dem Befehl Get-XpGateways ermittelt werden.
-Type {Any | CTI | SIP}
- Sucht nach den SIP Gateways (SIP) oder nach CTI Gateways (CTI) oder allen (ANY).
-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.

Beispiele

Neustarten aller Gateways
Restart-XpGateways
Neustarten aller SIP Gateways
Restart-XpGateways -Type SIP
Neustarten aller Gateways mit OSBiz beginnen
Restart-XpGateways OSBiz*

Neustarten aller Gateways mit dem Namen OSBizCSTA

Restart-XpGateways -GatewayNames "OSBizCSTA"

Haben Sie einen Fehler auf dieser Seite gefunden?

Oder ist etwas nicht gut oder zu ungenau formuliert? Dann freuen wir uns über eine E-Mail, am besten mit einem Verbesserungsvorschlag, an doku@c4b.de. Vielen Dank!