Exchange - Nutzung der Cmdlet Extension Agents (Scripte automatisch bei Ereignissen ausführen lassen)

Einleitung

Viele von euch kennen vermutlich folgende Situation:
Wir müssen z.B. bei neu angelegten Mailboxen im Exchange bestimmte Berechtigungen setzen oder das ein oder andere Feature in der Mailbox deaktivieren, und und und. Dies lässt sich nun auf der einen Seite mit Scripten realisieren die wir dann aber ausschließlich für das Erstellen von Mailboxen benutzen können, da ansonsten eine Anlage über die EMC nachträgliche Arbeiten erfordern würde.

Eine interessante Alternative dazu ist ein Feature, dass viele aber nicht kennen, und ab Exchange Server 2010 verfügbar ist: Die Cmdlet Extension Agents springen bei bei jedem Aufruf eines Powershell-CMDLets (z.B. "new-mailbox" / "remove-mailbox" etc.) in die Bresche und können automatisch Scripte aufrufen welche die zusätzlich nötigen Aufgaben im Hintergrund erledigen. Die Admins können dann also die gewohnten Tools wie die EMC und EMS zur Useranlage nutzen, und im Hintergrund wird dann der Rest automatisch vorgenommen.

Wie man die Cmdlet Extension Agents aktiviert und wie man sie nutzt, erfahrt Ihr in dieser Anleitung.

1. Erstellen der Konfigurationsdatei

Wir erstellen folgende Konfigurationsdatei mit dem Namen ScriptingAgentConfig.xml. Dieser Name darf nicht verändert werden !
Die XML-Datei legen wir dann in folgendem Exchange-Ordner ab:
Dort befindet sich auch eine Beispiel-Konfigurationsdatei anhand derer man die weiteren Möglichkeiten abschauen kann.

Was macht die Konfigurationsdatei nun genau ?

Betrachten wir die folgende Zeile: <Feature Name="MeineMailboxAktionen" Cmdlets="new-mailbox">. Der Parameter "Cmdlets" gibt an welche Cmdlets unsere benutzerdefinierte Aktion auslösen. In diesem Fall, wenn eine neue Mailbox angelegt wird. Hier können wir auch mehrere CMDlets definieren, indem wir sie mit einem Komma voneinander trennen. Den Name-Parameter können wir frei wählen. In der XML-Datei können auch mehrere solcher Feature-Abschnitte für unterschiedliche CMDLets angelegt werden.

Die nächste Zeile <ApiCall Name="OnComplete"> legt fest wann unsere benutzerdefinierte Aktion ausgelöst wird. Im Beispiel ist es das OnComplete-Event welches ausgelöst wird, sobald der Befehl beendet wurde. Hier können wir auch das Validate-Event benutzen welches noch vor dem Eigentlichen CMDLet-Befehl ausgelöst wird. Dies kann z.B. dazu genutzt werden um eine Mailbox bevor sie entfernt wird, noch vorher via "New-MailboxExportRequest" als PST-Datei zu sichern.

Im obigen Beispiel wird bei jeder Neuanlage einer Mailbox, in dieser das IMAP-Feature deaktiviert. Um den Namen der betroffenen Mailbox zu erhalten, wird diese Zeile genutzt:
Hier kann man auch auf alle an das CMD-Let übergebenen Parameter zugreifen und entsprechend reagieren.

2. Aktivieren der Cmdlet Extension Agents

Um die Agents zu aktivieren müssen wir noch folgenden Befehl in einer Exchange Management Shell absetzen:
Wenn man nun in der EMC oder der EMS eine neue Mailbox angelegt (diese nutzen im Hintergrund auch die Powershell-CMDLets), wird in dieser Mailbox automatisch das IMAP-Feature deaktiviert. Praktisch oder !?

3. Nutzung von externen Scripten

Natürlich kann man in der obigen XML-Datei auch ein externes Script aufrufen das die entsprechenden Befehle enthält, und Ihm mit einem Parameter das entsprechend betroffene Objekt mit übergeben.
Ein kleiner Nachteil ist, das bei der Nutzung von mehreren Exchange-Servern die XML-Datei auf alle Server verteilt werden muss.

Aber im Großen und Ganzen ein sehr nützliches Feature, das es wert ist mal erwähnt zu werden

Grüße @colinardo

<?xml version="1.0" encoding="utf-8" ?>   

<Configuration version="1.0">   

 <Feature Name="OWAActiveSyncOff" Cmdlets="new-mailbox">   

  <ApiCall Name="OnComplete">   

   if($succeeded)    { 

    $newmailbox = $provisioningHandler.UserSpecifiedParameters["Name"]   

    set-casmailbox $newmailbox -OWAEnabled $false 
    set-casmailbox $newmailbox -ActiveSyncEnabled $false 

   } 

  </ApiCall> 

 </Feature> 

</Configuration>

Get-CmdletExtensionAgent | %{$_.Name}

Set-CmdletExtensionAgent "Scripting Agent" -Priority 3

if($succeeded){ 
    echo "Test, hat funktioniert" | out-file C:\test.txt  
} 

Get-CmdletExtensionAgent | ?{$_.Name -eq "Scripting Agent"}

Der Agent wird auch nicht auf Exchange-Servern ausgeführt, auf denen die Edge-Transport-Serverrolle ausgeführt wird, da diese Serverrolle keine Cmdlet-Erweiterungs-Agents unterstützt. 

RunspaceId        : 3e2d5bd7-dfcd-...
Assembly          : Microsoft.Exchange.ProvisioningAgent.dll
ClassFactory      : Microsoft.Exchange.ProvisioningAgent.ScriptingAgentClassFactory
Enabled           : True
Priority          : 1
IsSystem          : False
AdminDisplayName  : 
ExchangeVersion   : 4.0 (14.1.166.0)
Name              : Scripting Agent
DistinguishedName : CN=Scripting Agent,CN=CmdletExtensionAgent Settings,CN=Global Settings,CN=ABCD,CN=Mic
                    rosoft Exchange,CN=Services,CN=Configuration,DC=xxx,DC=local
Identity          : Scripting Agent
Guid              : 941284d0-4731-4e0c....
ObjectCategory    : xxx.local/Configuration/Schema/ms-Exch-Cmdlet-Extension-Agent
ObjectClass       : {top, configuration, msExchCmdletExtensionAgent}
WhenChanged       : 16.04.2014 14:06:24
WhenCreated       : 01.12.2011 16:50:53
WhenChangedUTC    : 16.04.2014 12:06:24
WhenCreatedUTC    : 01.12.2011 15:50:53
OrganizationId    : 
OriginatingServer : xxx.local
IsValid           : True

Get-ExchangeServer | select ServerRole

Set-ExecutionPolicy RemoteSigned