Befehle zur Verwaltung des Projekt-Servers - TIA Portal

Manager

Lesen

Schreiben

Löschen

Benutzerverwaltung

Contributor

Lesen

Schreiben

Löschen: Nur Serverprojekte, Server-Bibliotheken und lokale Sessions

Member

Nur Lesen

"Show projects"

Listet Projekte und Gruppen des ausgewählten Projekt-Servers auf.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -a, --all: Gibt eine Liste aus mit der vollständigen Hierarchie aller Gruppen und Serverprojekte auf dem Server.

• -p, --project: (Optional) Name des Serverprojekts.

  Der Parameter wird nur ausgewertet, wenn Revisionen zu einem Projekt angezeigt werden können.

  Wenn der Befehl den Parameter "all" enthält, wird der Parameter "project" ignoriert.

• -v, --revisions: (Optional) Listet zusätzlich alle Revisionen zum Projekt auf.

  Wenn der Befehl den Parameter "all" enthält, wird der Parameter "revisions" ignoriert.

• -l, --page: (Optional) Ergebnisanzeige Seite für Seite

• -d, --display: (Optional) Ergebnisanzeige in unterschiedlicher Darstellung:

  • cascade: Zeigt die Ergebnisse als Kaskade an.

  • tabular: Zeigt die Ergebnisse als Tabelle an.

  • short: Zeigt die Ergebnisse als Kurzfassung an.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

  Wenn der Befehl den Parameter "all" enthält, wird der Parameter "groupName" ignoriert.

Beispiele:

Vollständige Liste der Gruppen und Projekte:

%InstallDirectory% > pspt project show --server https://localhost:8735 -a

Serverprojekte der Gruppe "MyGroup":

%InstallDirectory% > pspt project show --server https://localhost:8735 -g MyGroup

Hilfeaufruf:

• pspt project show -?

"Delete project"

Löscht spezifizierte Projekte auf dem Projekt-Server.

Voraussetzung:

Die Projekte dürfen keine lokalen Sessions mehr enthalten.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, das gelöscht werden soll.

• -f --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt project remove --server https://localhost:8735 --project project155 -g MyGroup

Hilfeaufruf:

• pspt project remove -?

"Create group"

Erstellt eine Gruppe auf dem Projekt-Server.

Voraussetzung:

Benutzer benötigen für den Projekt-Server die Rolle "Manager".

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -g, --groupName: Name der zu erstellenden Gruppe

• -c, --comment: Kommentar mit Informationen z. B. zum Zweck der Gruppe

Beispiel:

%InstallDirectory% > pspt group create --server https://localhost:8735 --g MyGroup --c GroupComment

Hilfeaufruf:

• pspt group create -?

"Get group"

Listet alle Gruppen des ausgewählten Projekt-Servers auf.

Um neben den Gruppen auch die enthaltenen Serverprojekte aufzulisten, verwenden Sie den Befehl "project show" mit dem Parameter "all".

Parameter:

• -s, --server: Projekt-Server URI-Adresse

Beispiel:

%InstallDirectory% > pspt group get --server https://localhost:8735

Hilfeaufruf:

• pspt group get -?

"Delete group"

Löscht eine Gruppe auf dem Projekt-Server.

Voraussetzung:

Die Gruppe darf keine Serverprojekte mehr enthalten.

Benutzer benötigen für den Projekt-Server die Rolle "Manager".

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -g, --groupName: Name der zu löschenden Gruppe

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage.

  Ohne den Parameter im Befehl wird ein Dialog zur Bestätigung angezeigt.

Beispiel:

%InstallDirectory% > pspt group delete --server https://localhost:8735 -n MyGroup

Hilfeaufruf:

• pspt group delete -?

"Display sessions"

Listet alle lokalen Sessions des gewählten Serverprojekts auf.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, dessen Sessions aufgelistet werden.

• -l, --page: (Optional) Ergebnisanzeige Seite für Seite

• -d, --display: (Optional) Ergebnisanzeige in unterschiedlicher Darstellung:

  • cascade: Zeigt die Ergebnisse als Kaskade an.

  • tabular: Zeigt die Ergebnisse als Tabelle an.

  • short: Zeigt die Ergebnisse als Kurzfassung an.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt session show --server https://localhost:8735 --project project155 -g MyGroup

Hilfeaufruf:

• pspt session show -?

"Move session"

Aktualisiert den Ablagepfad einer lokalen Session, die in einen anderen Pfad verschoben wurde.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, zu dem die lokale Session gehört.

• -i, --id: ID der lokalen Session, die verschoben wird.

• -t, --path: Auswahl des Zielordners, in den die lokale Session verschoben werden soll.

• -m, --machine: (Optional) Rechnername, wenn der Zielordner auf einem anderen PC liegt.

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt session move --server https://localhost:8735 -id 1 --project Project1 --path C:\LocalPathForMoving -g MyGroup

Hilfeaufruf:

• pspt session move -?

"Delete session"

Löscht die ausgewählte lokale Session auf dem Projekt-Server

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, dessen Session gelöscht werden soll.

• -i, --id: Identifikationsnummer der Session, die gelöscht werden soll.

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt session remove --server https://localhost:8735 --project project155 --id 5 -g MyGroup

Hilfeaufruf:

• pspt session remove -?

"Remove project lock"

Entfernt die Sperre für das Serverprojekt.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, das entsperrt werden soll.

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt project unlock --server https://localhost:8735 --project project155 -g MyGroup

Hilfeaufruf:

• pspt project unlock -?

"Show check-in history"

Zeigt die Eincheck-Historie für den ausgewählten Server und die ausgewählte lokale Session an.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, für dessen Sessions die Eincheck-Historie aufgelistet wird.

  Wenn kein Projektname angegeben ist, wird die Historie aller Projekte auf dem Projekt-Server aufgelistet.

• -f, --from: (Optional) Revisionsnummer, ab der die Historie der Session aufgelistet werden soll.

  Die angegebene Revisionsnummer ist in der Auflistung enthalten.

  Ohne den Parameter im Befehl wird die Eincheck-Historie seit dem Anlegen der Session angezeigt.

• -t, --to: (Optional) Revisionsnummer, bis zu der die Historie der Session aufgelistet werden soll.

  Die angegebene Revisionsnummer ist in der Auflistung enthalten.

  Ohne den Parameter im Befehl wird die Eincheck-Historie bis zum aktuellen Zeitpunkt angezeigt.

• -i, --id: (Optional) Identifikationsnummer der Session, deren Eincheck-Historie aufgelistet werden soll.

  Wenn keine Session-Identifikationsnummer angegeben ist, wird die Historie für alle Sessions des Serverprojekts aufgelistet.

• -l, --page: (Optional) Ergebnisanzeige Seite für Seite

• -d, --display: (Optional) Ergebnisanzeige in unterschiedlicher Darstellung:

  • cascade: Zeigt die Ergebnisse als Kaskade an.

  • tabular: Zeigt die Ergebnisse als Tabelle an.

  • short: Zeigt die Ergebnisse als Kurzfassung an.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt checkin show --server https://localhost:8735 --project project155 --from 5 --to 20 --id 5 -g MyGroup

Hilfeaufruf:

• pspt checkin show -?

"Show server access rights"

Zeigt die definierten Benutzerrechte für die Benutzer eines Servers, einer Gruppe oder eines Serverprojekts.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, für das die Zugriffsrechte aufgelistet werden.

  Wenn kein Projektname angegeben ist, werden die Zugriffsrechte aller Projekte auf dem Projekt-Server aufgelistet.

• -l, --page: Ergebnisanzeige im Seitenformat

• -d, --display: (Optional) Ergebnisanzeige in unterschiedlicher Darstellung:

  • cascade: Zeigt die Ergebnisse als Kaskade an.

  • tabular: Zeigt die Ergebnisse als Tabelle an.

  • short: Zeigt die Ergebnisse als Kurzfassung an.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt user show --server https://localhost:8735/ -p MYProject -g MyGroup

Hilfeaufruf:

• pspt user show -?

"Modify server access rights"

Ändert die Zugriffsrechte für den Server, eine Gruppe oder ein Serverprojekt.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, für das der Benutzer Zugriffsrechte bekommen soll.

  Wenn kein Projektname angegeben ist, werden dem Benutzer die Zugriffsrechte auf den Projekt-Server erteilt.

• -u, --users: Benutzernamen, nach denen gefiltert werden soll, mit Kommata getrennt.

• -r, --role: Auswahl der Rolle

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt user add --server https://localhost:8735 --project Project1 --users user1,user2 --role Manager -g MyGroup

Hilfeaufruf:

• pspt user add -?

"Remove server access rights"

Entfernt die Zugriffsrechte für den Server, eine Gruppe oder ein Serverprojekt.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, aus dessen Benutzerverwaltung der Benutzer entfernt werden soll.

  Wenn kein Projektname angegeben ist, wird der Benutzer aus der Benutzerverwaltung des Servers entfernt.

• -u, --user: Benutzernamen, nach denen gefiltert werden soll, mit Kommata getrennt.

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt user remove --server https://localhost:8735 --users user1,user2 -g MyGroup

Hilfeaufruf:

• pspt user remove -?

"Show certificates"

Zeigt alle vorhandenen Multiuser-Zertifikate an.

Parameter:

• -l, --page: (Optional) Möglichkeit zur Seiteneinteilung für die Anzeige der Ergebnisse.

  -d, --display: (Optional) Ergebnisanzeige in unterschiedlicher Darstellung:

  • cascade: Zeigt die Ergebnisse als Kaskade an.

  • tabular: Zeigt die Ergebnisse als Tabelle an.

  • short: Zeigt die Ergebnisse als Kurzfassung an.

Beispiel:

%InstallDirectory% > pspt certificate show

Hilfeaufruf:

• pspt certificate show -?

"Remove certificates"

Entfernt alle Zertifikate vom ausgewählten Server.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

Beispiel:

%InstallDirectory% > pspt certificate remove --server https://localhost:8735

Hilfeaufruf:

• pspt certificate remove -?

"Confirm certificate"

Speichert das Zertifikat zum ausgewählten Server in der Liste der gültigen Zertifikate.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

Beispiel:

%InstallDirectory% > pspt certificate confirm --server https://localhost:8735

Hilfeaufruf:

• pspt certificate confirm -?

"Show alerts"

Zeigt die Alerts für den ausgewählten Server.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

Beispiel:

%InstallDirectory% > pspt alert show --server https://localhost:8735

Hilfeaufruf:

• pspt alert show -?

"Remove alerts"

Entfernt alle Alerts für den ausgewählten Server.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -a, --alert: Name des Alerts

Beispiel:

%InstallDirectory% > pspt alert remove --server https://localhost:8735 --alert alert1

Hilfeaufruf:

• pspt alert remove -?

"Export of server project"

Exportiert ein vorhandenes Serverprojekt zu dem Zielordner im angegebenen Pfad.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, das exportiert werden soll.

  Wenn kein Projektname angegeben ist, werden alle im angegebenen Server-Repository vorhandenen Projekte exportiert.

• -t, --path: Auswahl des Zielordners, in den das Projekt exportiert werden soll.

  Der Ordner muss leer sein.

• -m, --metadata: (Optional) Das Serverprojekt wird vollständig mit der gesamten Historie und allen vorhandenen Revisionen exportiert.

  Voreinstellung: Ohne den Parameter im Befehl wird die letzte Revisionsversion oder die mit "revision" spezifizierte Version exportiert.

• -v, --revision: (Optional) Definiert die Revisionsnummer, die exportiert werden soll.

  Voreinstellung: Ohne Angabe einer Version wird die letzte Revision exportiert.

  Wenn eine spezifische Revision angegeben ist, wird das Serverprojekt als Single-User-Projekt exportiert.

  Wenn der Befehl den Parameter "metadata" enthält, wird der Parameter "revision" ignoriert.

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt project export --server net.tcp://localhost:8637 --project Project55 --path "E:\Exp1" -m -g MyGroup

Hilfeaufruf:

• pspt project export -?

"Import of server project"

Importiert ein Serverprojekt vom angegebenen Pfad zum angegebenen Projekt-Server-Repository.

Voraussetzung:

Nur Benutzer mit der Rolle "Contributor" oder "Manager" dürfen diese Aktion durchführen.

Regeln:

• Sie können immer nur ein Serverprojekt gleichzeitig importieren.

• Der Name des zu importierenden Serverprojekts wird auch als Name des Zielordners verwendet.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -t, --path: Auswahl des Ablagepfades, von dem das Projekt importiert werden soll.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt project import --server https://localhost:8735 --path "E:\Exp1" -g MyGroup

Hilfeaufruf:

• pspt project import -?

"Export of server project sessions"

Exportiert die lokalen Sessions eines Serverprojekts zum angegebenen Pfad.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, dessen zugehörige lokale Sessions exportiert werden sollen.

  Wenn kein Projektname angegeben ist, werden alle im angegebenen Server-Repository vorhandenen Projekte exportiert.

• -t, --path: Auswahl des Zielordners, in den die lokalen Sessions des Serverprojekts exportiert werden sollen.

  Der Ordner muss leer sein.

• -i--id: (Optional) ID der lokalen Session, die exportiert werden soll.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt session export --server net.tcp://localhost:8637 --project Project55 --path "E:\Exp1\Sessions" [--id] 1 -g MyGroup

Hilfeaufruf:

• pspt session export -?

"Import of server project sessions"

Importiert die exportierten lokalen Sessions zu einem ausgewählten Serverprojekt.

Voraussetzung:

Nur Benutzer mit der Rolle "Contributor" oder "Manager" dürfen diese Aktion durchführen.

Regel:

Nur die lokalen Sessions werden importiert, die dem zugehörigen Serverprojekt bekannt sind.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, dessen zugehörige lokale Sessions importiert werden sollen.

• -t, --path: Auswahl des Ablagepfades, von dem die lokalen Sessions importiert werden sollen.

• -a, --alias: (Optional) Alias-Name des Zielservers, falls verfügbar.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt session import --server https://localhost:8735 --project Project55 --path "E:\Exp1\Sessions" -g MyGroup

Hilfeaufruf:

• pspt session import -?

"Export project history as xml"

Exportiert die vorhandene Projekthistorie in eine bestehende Datei im Format ".xml".

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, dessen zugehörige Historie exportiert werden soll.

• -t, --file: Zieldatei und Ablagepfad für das Exportieren der Historie.

• -v, --revision: (Optional) Revisionsnummer, für welche die Historie exportiert werden soll.

  Wenn keine Revisionsnummer angegeben ist, wird die Historie für alle Revisionen des Serverprojekts exportiert.

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt project exportHistory -s http://server.com -p Project1 -t "C:\fileName.xml" -v 1,2,3,4 -f -g MyGroup

Hilfeaufruf:

• pspt project exportHistory -?

"Add note to a revision in server project"

Fügt einen Hinweis zu einer ausgewählten Revision eines Serverprojekts hinzu.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts.

• -v, --revision: Revision, zu der ein Hinweis hinzugefügt werden soll.

  Wenn keine Revision angegeben ist, wird der Hinweis bei allen Revisionen des Serverprojekts ergänzt.

• -n--note: Hinweis, der zur Revision hinzugefügt werden soll

  Um einen Zeilenumbruch zu ergänzen, verwenden Sie den Parameter "\n" im Text.

  Escape-Sequenz: Wenn der Text Funktionszeichen enthält, verwenden Sie das Zeichen "\" als Maskierungszeichen.

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt revisionnote add -s http://server.com -p Project1 -v 1 -n "MyNoteLine1\nLine2Note" -g MyGroup

Hilfeaufruf:

• pspt revisionnote add -?

"Project Commissioning"

Aktiviert oder deaktiviert den Commissioning-Modus für das gewählte Serverprojekt.

Für Server-Bibliotheken steht dieser Befehl nicht zur Verfügung.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, für das der Commissioning-Modus aktiviert oder deaktiviert werden soll.

• -m, --mode: Aktiviert oder deaktiviert den Commissioning-Modus.

  • true: Aktiviert den Commissioning-Modus.

  • false: Deaktiviert den Commissioning-Modus.

  Um den Commissioning-Modus zu aktivieren, ergänzen Sie den Parameter "mode" im Befehl.

  Ohne den Parameter im Befehl wird der Commissioning-Modus deaktiviert.

  Ob der synchrone oder asynchrone Commissioning-Modus verwendet wird, bestimmen Sie bei der Commissioning-Konfiguration im TIA Portal.

• -d, --divergent: Aktiviert oder deaktiviert die Option "Vor dem Laden auf unterschiedliche Daten überprüfen".

  • true: Aktiviert die Konsistenz-Prüfung.

  • false: Deaktiviert die Konsistenz-Prüfung.

  Um die Konsistenzprüfung zu aktivieren, ergänzen Sie den Parameter "divergent" im Befehl.

  Ohne den Parameter im Befehl bleibt die Konsistenzprüfung deaktiviert.

• -n, --groupName: Name der zu erstellenden Gruppe

Beispiel:

%InstallDirectory% > pspt project commissioning --server https://localhost:8735 -p Project1 -m true -d true -g MyGroup

Hilfeaufruf:

• pspt project commissioning -?

"Project rollback"

Setzt den Server auf eine vorhandene ältere Revision zurück.

Voraussetzung:

Der Befehl kann nur ausgeführt werden, wenn der Server nicht gesperrt ist.

Parameter:

• -s, --server: Projekt-Server URI-Adresse

• -p, --project: Name des Serverprojekts, das auf eine vorhergehende Revision zurückgesetzt werden soll.

• -v, --revision: Revisionsnummer, auf die das Projekt zurückgesetzt werden soll.

• -f, --force: (Optional) Aktiviert den Befehl ohne weitere Rückfrage

• -g, --groupName: Name der Gruppe, wenn das Serverprojekt in einer Gruppe enthalten ist.

Beispiel:

%InstallDirectory% > pspt project rollback --server https://localhost:8735 --project projectName --revision 2 --group MyGroup

Hilfeaufruf:

• pspt project rollback -?