Visual Planning & Benutzer und Lizenzzuordnungen per PowerShell exportieren

Mit unserem PowerShell-Skript können Benutzer, Gruppen und Lizenzzuordnungen einer Visual-Planning-Installation über die Visual Planning REST API v2 ausgelesen und als CSV-Datei exportiert werden.

Der Export eignet sich beispielsweise für die regelmäßige Kontrolle und Bereinigung von Benutzerkonten und Lizenzzuordnungen.

Voraussetzungen

• Zugriff auf die Visual Planning REST API v2
• ein gültiger Admin-API-Key (kein planungspezifischer API-Key)
• Windows PowerShell bzw. PowerShell
• Netzwerkzugriff auf den Visual-Planning-Server

Download: Get-VPUsers.ps1

Aufruf

Das Skript benötigt folgende Parameter:

Beispiel:

.\Get-VPUsers.ps1 `
    -Url "https://vp.example.de/vplanning/api/v2" `
    -ApiKey "DEIN-API-KEY" `
    -OutputFile "C:\Temp\VP_Benutzer.csv"

Inhalt des Exports

Die erzeugte CSV-Datei enthält für jeden Visual-Planning-Benutzer:

• Benutzerkennung
• Aktivstatus
• vollständigen Namen
• E-Mail-Adresse
• Mobil- und Telefonnummer
• zugeordnete Benutzergruppen
• zugeordnete Lizenzen

Die Spalte Licenses enthält eine Übersicht aller dem jeweiligen Benutzer zugeordneten Lizenzen.

Zusätzlich erzeugt das Skript für jeden in der Visual-Planning-Installation vorhandenen Lizenzschlüssel eine eigene Spalte. Ein X zeigt an, dass der Benutzer dem entsprechenden Lizenzschlüssel zugeordnet ist.

Dadurch lassen sich die Lizenzzuordnungen beispielsweise in Excel einfach filtern und auswerten.

Ausgabeformat

Die Datei wird als:

• CSV
• mit Semikolon als Trennzeichen
• in UTF-8-Codierung

erstellt.

Sie kann anschließend direkt in Microsoft Excel oder anderen Tabellenkalkulations- und Auswertungsprogrammen verwendet werden.

PowerShell blockiert die Ausführung

Bei einem heruntergeladenen PowerShell-Skript kann Windows die Ausführung zunächst blockieren.

Die heruntergeladene Datei kann in PowerShell freigegeben werden:

Unblock-File ".\Export-VPUsers.ps1"

Alternativ kann die Ausführungsrichtlinie ausschließlich für die aktuelle PowerShell-Sitzung geändert werden:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass

Unternehmensweit vorgegebene Sicherheitsrichtlinien sollten nicht verändert werden. Wenden Sie sich bei entsprechenden Einschränkungen an Ihre IT-Administration.

Sicherheitshinweis

Der API-Key ermöglicht den Zugriff auf die Visual Planning REST API und sollte entsprechend geschützt behandelt werden.

Der API-Key sollte insbesondere nicht direkt im Skript gespeichert oder gemeinsam mit dem Skript weitergegeben werden.

Benutzer und Gruppen automatisiert verwalten

Die Visual Planning REST API ermöglicht bei Benutzern und Gruppen nicht nur das Auslesen von Informationen, sondern auch den schreibenden Zugriff.

Damit können beispielsweise Benutzer automatisiert angelegt und aktualisiert sowie Gruppenzuordnungen synchronisiert werden. Ein typischer Anwendungsfall ist die Synchronisation der Visual-Planning-Benutzerverwaltung mit Microsoft Active Directory bzw. Microsoft Entra ID.

Wir verfügen über Erfahrung mit der Umsetzung solcher Synchronisationen und unterstützen Sie gerne bei der Anbindung Ihrer bestehenden Benutzerverwaltung an Visual Planning.

Download

Das benötigte PowerShell-Skript finden Sie als Anhang zu diesem Artikel:

Export-VPUsers.ps1