09 February 2013 Modules, Powershell, Snapins robert.muehsig Edit

Die Powershell hat zwei Varianten wie man CmdLet´s oder Provider nachrüsten kann: SnapIns und Modules. Aber was ist der Unterschied?

TL;DR:

Snapins Modules
PS 1.0 Variante – alt. Mit PS 2.0 eingeführt
Definiert in Assemblies Definiert in Assemblies oder in Scripts
Komplexes Deployment via installutil Module im Dateisystem

 

Snapins: Die alte Variante

Snapins (wie z.B. in Windows Server 2008 Zeiten das WebAdministration PSSnapin) sind die alte Variante, welche in der ersten Version der Powershell genutzt werden konnte. Nachteil an dieser Variante war:

-  die PsSnapins müssen in einer .NET Sprache geschrieben sein und als Assembly vorliegen
    (in der MSDN gibt es auch Sample Code zum Erstellen von PSSnapIns)
- diese Assemblies mussten über installutil.exe installiert werden

Welche PSSnapins sind auf meinem System installiert?

Über das CmdLet “Get-PSSnapin –registered” bekommt man alle registrierten Snapins:

image

Wo werden die PSSnapins gespeichert? Natürlich in der Registry!

Die Registrierung der PSSnapins erfolgte in der Registry:

Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\PowerShell\1\PowerShellSnapIns\

image

Welche CmdLets sind für das Verwalten der PSSnapins da?

Get-PSSnapIn –registered: Liefert alle verfügbaren PSSnapIns
Add-PSSnapIn [name]: Fügt das PSSnapIn der PowerShell Session an
Get-Command –pssnapin [name]: Gibt CmdLets zum PSSnapin aus (muss vorher über Add in die Session geholt werden)

Alles in allem sollte man keine Snapins mehr erstellen – jedoch gibt es sie noch, daher die erklärenden Worte.

PowerShell Module – die neue Welt.

 

Die Module wurden mit der zweiten Version der PowerShell eingeführt und sind um einiges reicher an Möglichkeiten und verlangen auch keine Registrierung in der Registry.

Wo sind die Module gespeichert?

Wenn über Import-Module einfach nur ein Modul über den Modulnamen importiert werden soll, wird im Standardfall in den Ordnern geschaut, welche in der Umgebungsvariable “$env:psmodulepath” definiert sind:

image

Ansonsten kann man bei Import-Module auch direkte Pfade zu Powershell Modulen angeben.

Anmerkung: In Powershell 3.0 sind alle verfügbaren Module automatisch in der Session aktiviert und müssen nicht über Import-Module in die Session geladen werden.

Welche Module sind denn “installiert”?

Über “Get-Module –ListAvailable” bekommt man die Auflistung:

image

Was ist denn der “ModuleType”?

Anders als bei PSSnapIns können Module entweder aus simplen Scripts bestehen, einem Workflow, einer Assembly oder einem Manifest. Dazu ist der ModuleType definiert:

Binary
A module whose members are defined within an assembly (.dll extension), such as a snap-in or a class library that contains cmdlet classes. This field is introduced in Windows PowerShell 2.0.

Cim
A cmdlets-over-objects module (.cdxml extension).

Manifest
A module that is defined by a module manifest file (.psd1 extension) whose ModulesToProcess key is empty. This field is introduced in Windows PowerShell 2.0.

Script
A module whose members are defined within a script module file (.psm1 extension). This field is introduced in Windows PowerShell 2.0.

Workflow
A workflow module (.xaml extension).

Aus diesem MSDN Arikel.

Wie sieht so ein Modul aus? Schauen wir uns mal das “WebAdministration” Modul an

Das “WebAdministration”-Modul (um den IIS zu verwalten) findet sich im normalen “WindowsPowershell” Ordner und enthält ein paar Dateien:

image

Die .psd1 Datei ist das Modul Manifest und eigentlich das wichtigste:

@{
GUID='{13c15630-959c-49e4-a977-758c5cc93408}'
Author='Microsoft Corporation'
CompanyName='Microsoft Corporation'
Copyright='© Microsoft Corporation. All rights reserved.'
ModuleVersion='1.0.0.0'
PowerShellVersion='3.0'
CLRVersion='4.0'
TypesToProcess='iisprovider.types.ps1xml'
FormatsToProcess='iisprovider.format.ps1xml'
NestedModules='Microsoft.IIS.PowerShell.Provider.dll'
RequiredAssemblies='Microsoft.IIS.PowerShell.Framework.dll'
AliasesToExport='Begin-WebCommitDelay','End-WebCommitDelay'
HelpInfoUri="http://go.microsoft.com/fwlink/?LinkID=216903"
}

Die eigentliche Funktionalität des Powershell Moduls liegt in der Microsoft.IIS.PowerShell.Provider.dll im CLR 4.0 GAC.

Wie schreibe ich ein Windows Powershell Modul?

Grundsätzlich ist Entwicklung von .NET basierten Powershell Modulen ganz ähnlich von alten Snapins: How to Create a Powershell 2.0 Module and Cmdlet with Visual Studio 2010 (Screencast included)

Eine gute Referenz sind auch die Windows Azure CmdLets.

Wie bekomme ich neue Module registriert?

Die CmdLets zum Registrieren eines Modules sind ähnlich wie bei den Snapins:

Get-Module -ListAvailable
Import-Module name
Get-Command -module name

blog comments powered by Disqus