TechDocs › Powershell-Erweiterung › Konfiguration

Logging#

Get-XpLogging#

Syntax#

Get-XpLogging [[-LoggerNames] <string[]>] [-GatewayNames <string[]>] [-GatewayType {Any | CTI | SIP}] [-Timeout <int>]  [<CommonParameters>]

Beschreibung#

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

Path
Level

Parameter#

  • -LoggerNames <String[]> oder [-GatewayNames <string[]>] oder [-GatewayType {Any | CTI | SIP}]
    • 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.

    • GatewayNames und GatewayType können mit Get-XpGateways 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>

Eingaben#

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

Ausgaben#

Der Befehl Get-XpLogging gibt Objekte vom Typ LogLevel zurück.

Level

C4B.Atlas.Log.ATLogLevel Level {get;set;}

Module

string Module {get;}

Name

string Name {get;}

Path

string Path {get;}

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

Get-XpLogging | Get-Member

Beispiel#

  1. Zeige alle Logger an:

    Get-XpLogging
    
  2. Zeige den Logger für alle CTI Gateways an:

    Get-XpLogging -GatewayType CTI
    
  3. Zeige alle Logger dessen GatewayName mit OSBiz und OSV beginnt:

    Get-XpLogging -GatewayNames OSBiz*, OSV*
    
  4. Zeige alle Logger, die im Status Debug sind:

    Get-XpLogging | Where-Object {$_.Level -eq "Debug"}
    

Set-XpLogging#

Syntax#

Set-XpLogging [[-Objects] <Object[]>] [-Timeout <int>] [<CommonParameters>]

Beschreibung#

Set-XpLogging speichert die übergebenen LogLevel 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 <LogLevel[]>
    • Spezifiziert die auf dem XPhone Connect Server zu speichernden Logger-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>

Eingaben#

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

  • LogLevel

Ausgaben#

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

Beispiel#

  1. Setzt das Log-Level für alle Logger, die momentan auf Debug stehen, auf Off, wodurch das Logging für diese Logger deaktiviert wird:

     Get-XpLogging | Where-Object {$_.Level -eq "Debug"} | foreach{$_.Level = "Off";$_} | Set-XpLogging

Erläuterung der Pipeline:

#. Der erste Schritt holt alle Logger vom XPhone Connect Server (``Get-XpLogging``).
#. Dann wird nach Loggern gefiltert, die auf ``Debug`` stehen (``Where-Object {$_.Level -eq "Debug"}``).
#. Anschließend werden alle gefundenen Logger ausgeschaltet (``foreach{$_.Level = "Off";$_}``).
#. Schließlich werden die Änderungen an den XPhone Connect Server übertragen und gespeichert (``Set-XpLogging``).
  1. Für alle SIP Gateways das Logging einschalten (Stufe DebugHigh):

     Get-XpLogging -GatewayType SIP | foreach{$_.Level = "DebugHigh";$_} | Set-XpLogging


Erläuterung der Pipeline:

#. Der erste Schritt holt alle SIP Gateway Logger vom XPhone Connect Server (``Get-XpLogging -GatewayType SIP``).
#. Anschließend wird bei all denjenigen Loggern, die nach der Filterung noch übrig sind, das Debuglevel gesetzt (``foreach{$_.Level = "DebugHigh";$_}``).
#. Schließlich werden die Änderungen an den XPhone Connect Server übertragen und gespeichert (``Set-XpLogging``).

Ihre Meinung zählt!

Ob Lob, hilfreiche Ideen oder ein Hinweis auf einen Fehler - wir freuen uns über jede Nachricht.
Schreiben Sie uns einfach an doku@c4b.de und helfen Sie mit, diese Dokumentation noch besser zu machen.
Vielen Dank für Ihre Unterstützung!