- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Coded
- UIP-Kontextgrundlage
- UIP-Dokumentation
- UIP-Funktion
- UIP-Leitplanken
- uip llm-configuration
- uip llm-gateway
- UIP-Modellhub
- Add-Test-Data-Entität
- Add-Test-Data-Queue
- Add-Test-Data-Variation
- Analysieren
- Erstellen
- Ein Projekt erstellen
- Diff
- Suchaktivitäten
- Get-Analyse-Regeln
- get-standard-aktivität-xaml
- Fehler abrufen
- Manuelle-Testfälle erhalten
- Manuelle-Testschritte erhalten
- Get-Library-Object-Repository
- Get-Object-Repository
- Get-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Listeninstanzen
- Beispiele für Listenworkflows
- Packen
- Veröffentlichen
- Remote
- restore
- Ausführen, Debuggen & Ausführung enthält
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- TM
- UIA
- UIP-Aufgaben
- UIP-Ablaufverfolgungen
- Feedback zu UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
Syntax und Optionen für „UIP Solution Deploy“, das Lösungsbereitstellungen im Orchestrator installiert, aktualisiert, aktiviert und deinstalliert.
uip solution deploy nimmt ein veröffentlichtes Lösungspaket (siehe uip solution publish) und installiert es in Orchestrator: Erstellt einen Ordner, stellt Ressourcen (Warteschlangen, Assets, Prozesse, Buckets, Verbindungen) bereit und aktiviert die Bereitstellung.
Diese Seite deckt jeden Unterbefehl unter deploy ab.
| Unterbefehl | Zweck |
|---|---|
run | Installieren Sie eine neue Bereitstellung aus einem veröffentlichten Paket. |
upgrade | Aktualisieren Sie eine vorhandene Bereitstellung auf eine neuere Paketversion. |
status | Überprüfen Sie den Status einer Pipelinebereitstellung. |
list | Listen Sie Vorhandene Bereitstellungen auf. |
activate | Aktivieren Sie eine Bereitstellung, die ohne automatische Aktivierung installiert wurde. |
uninstall | Eine Bereitstellung und ihre bereitgestellten Ressourcen entfernen. |
config get | Rufen Sie die Standardbereitstellungskonfiguration für ein Paket ab. |
config set | Legen Sie eine Ressourceneigenschaft in einer Bereitstellungskonfigurationsdatei fest. |
config link | Verknüpfen Sie eine Lösungsressource mit einer vorhandenen Orchestrator-Ressource. |
config unlink | Entfernen Sie einen Ressourcenlink aus einer Bereitstellungskonfigurationsdatei. |
Außerdem auf dieser Seite dokumentiert:
Jeder Unterbefehl ist authentifiziert. Führen Sie zuerst uip login aus.
Typischer Workflow
deploy config get → deploy config set / link → deploy run → deploy status
│
├─→ deploy activate (if not auto-activated)
├─→ deploy upgrade (new package version, same deployment)
└─→ deploy uninstall (tear down)
deploy config get → deploy config set / link → deploy run → deploy status
│
├─→ deploy activate (if not auto-activated)
├─→ deploy upgrade (new package version, same deployment)
└─→ deploy uninstall (tear down)
deploy run erstellt immer eine neue Bereitstellung in einem neuen Ordner – eine vorhandene wird nie aktualisiert. Wenn ein Paket bereits unter einem bestimmten --name bereitgestellt wird, verwenden Sie deploy upgrade um diese Bereitstellung in eine neue Version zu verschieben, oder übergeben Sie -y, --yes an deploy run um stattdessen eine zweite, unabhängige Kopie zu installieren.
Ausführung der Bereitstellung der UIP-Lösung
Installieren Sie eine neue Lösungsbereitstellung im Orchestrator aus einem veröffentlichten Paket. Erstellt einen neuen Ordner (unter --parent-folder-path oder --parent-folder-key oder dem persönlichen Arbeitsbereich des aktuellen Benutzers), stellt jede Ressource bereit, die im Paket (oder in --config-file) beschrieben ist, und aktiviert sie – es sei denn, --skip-activate ist festgelegt.
Da dadurch immer eine neue Bereitstellung erstellt wird, überprüft der Befehl zunächst, ob das Paket bereits eine unter derselben --name enthält; In diesem Fall wird es angehalten und auf deploy upgrade verwiesen, anstatt eine im Hintergrund neu zu installieren. Diese Prüfung ist nach bestem Wissen und Gewissen, keine Garantie: Es liest die Lösungssuche, für die eine Benutzersitzung erforderlich ist, sodass eine Anwendung (Client-Anmeldeinformationen) sie überspringt und ein Suchfehler warnt nur.
Zusammenfassung
uip solution deploy run \
--name <deployment-name> \
--package-name <name> \
--package-version <version> \
--folder-name <name> \
[--parent-folder-path <path> | --parent-folder-key <guid> | --personal-workspace] \
[--feed <name-or-key>] \
[--config-file <path>] \
[--skip-activate] \
[--wait] \
[-y, --yes] \
[--timeout <seconds>] \
[--poll-interval <ms>] \
[--login-validity <minutes>]
uip solution deploy run \
--name <deployment-name> \
--package-name <name> \
--package-version <version> \
--folder-name <name> \
[--parent-folder-path <path> | --parent-folder-key <guid> | --personal-workspace] \
[--feed <name-or-key>] \
[--config-file <path>] \
[--skip-activate] \
[--wait] \
[-y, --yes] \
[--timeout <seconds>] \
[--poll-interval <ms>] \
[--login-validity <minutes>]
Optionen
| Long | Wert | Standard | Beschreibung |
|---|---|---|---|
-n, --name <deployment-name> | text | – | Erforderlich. Name für die Bereitstellung. Wird von deploy status, deploy upgrade, deploy activate und deploy uninstall verwendet, um diese Installation zu identifizieren. |
--package-name <name> | text | – | Erforderlich. Name des Lösungspakets. Verwenden Sie packages list , um verfügbare Namen zu finden. |
--package-version <version> | text | – | Erforderlich. Version des Lösungspakets. |
--folder-name <name> | text | – | Erforderlich. Name des neuen Orchestrator-Ordners, der für diese Bereitstellung erstellt wurde. |
--parent-folder-path <path> | Pfad | – | Übergeordneter Ordnerpfad (z. B. Shared). Der Bereitstellungsordner wird darunter erstellt. Sich gegenseitig mit --parent-folder-key und --personal-workspace ausschließen. |
--parent-folder-key <key> | GUID | – | Schlüssel für übergeordneten Ordner. Alternative zu --parent-folder-path. |
--personal-workspace | Markieren | aus | Bereitstellen im persönlichen Arbeitsbereich des aktuellen Benutzers. Der Arbeitsbereichsname wird automatisch von Orchestrator aufgelöst. Sich gegenseitig mit --parent-folder-path, --parent-folder-key und --feed ausschließen. |
--feed <name-or-key> | text | Mandanten-Feed | Stellen Sie ein Paket bereit, das in diesem Feed (Name oder Ordnerschlüssel von solution feeds list) anstelle des Mandantenfeeds veröffentlicht wurde. Dieser Scope , aus dem das Paket Feed stammt – die Flags --parent-folder-path/--parent-folder-key/--personal-workspace steuern immer noch, wo der Orchestrator-Ordner erstellt wird. Sich gegenseitig mit --personal-workspace ausschließen. |
--config-file <path> | Pfad | – | JSON- oder YAML-Konfigurationsdatei. Generieren mit deploy config get, bearbeiten mit config set / config link und übergeben Sie es dann hier. |
--skip-activate | Markieren | aus | Automatische Aktivierung überspringen; Lassen Sie die Bereitstellung im Status Inactive (Ready to activate). Aktivieren Sie sie später mit deploy activate. |
--wait | Markieren | aus | Warten Sie bei einer --personal-workspace - oder --feed -Bereitstellung, bis sie fertig gestellt ist, anstatt zurückzukehren, sobald sie gestartet wurde (begrenzt durch --timeout). Der Mandantenfeedpfad wartet immer, sodass dieses Flag dort nichts ändert. |
-y, --yes | Markieren | aus | Bereitstellung auch dann, wenn dieses Paket bereits eine Bereitstellung unter --name hat, Installation einer zweiten, unabhängigen Kopie mit einem eigenen Ordner. |
--timeout <seconds> | Sekunden | 360 | Abruf-Timeout pro Phase angewendet – bereitstellen und aktivieren (wenn nicht übersprungen). |
--poll-interval <ms> | ms | 5000 | Millisekunden zwischen Statusabfragen während der Bereitstellungs- und Aktivierungsphase. |
--login-validity <minutes> | Minuten | 10 | Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen. |
Beispiele
Allgemein
uip solution deploy run \
--name my-deployment \
--package-name my-package \
--package-version 1.0.0 \
--folder-name MySolution \
--parent-folder-path "Shared"
uip solution deploy run \
--name my-deployment \
--package-name my-package \
--package-version 1.0.0 \
--folder-name MySolution \
--parent-folder-path "Shared"
Automatische Aktivierung überspringen
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --parent-folder-path "Shared" \
--skip-activate
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --parent-folder-path "Shared" \
--skip-activate
In den persönlichen Arbeitsbereich, auf Abschluss warten
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --personal-workspace --wait
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --personal-workspace --wait
Eine zweite, unabhängige Kopie eines bereits bereitgestellten Pakets
uip solution deploy run \
--name my-deployment-2 \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolutionCopy --parent-folder-path "Shared" --yes
uip solution deploy run \
--name my-deployment-2 \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolutionCopy --parent-folder-path "Shared" --yes
Aus einem Ordnerfeed
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --feed Finance
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --feed Finance
Mit einer benutzerdefinierten Konfiguration
uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --parent-folder-path "Shared" \
--config-file ./deploy-config.json
uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --parent-folder-path "Shared" \
--config-file ./deploy-config.json
Skripting – Erfassen Sie die Bereitstellungs-ID für Folgeaufrufe
PIPELINE_ID=$(uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --parent-folder-path "Shared" \
--output-filter "Data.PipelineDeploymentId" --output plain)
uip solution deploy status "$PIPELINE_ID"
PIPELINE_ID=$(uip solution deploy run \
--name my-deployment \
--package-name my-package --package-version 1.0.0 \
--folder-name MySolution --parent-folder-path "Shared" \
--output-filter "Data.PipelineDeploymentId" --output plain)
uip solution deploy status "$PIPELINE_ID"
Datenform (--output json)
Mandantenfeed-Bereitstellung (wartet immer):
{
"Code": "SolutionDeployRun",
"Data": {
"Status": "DeploymentSucceeded",
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
"PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
"InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"FolderName": "MySolution",
"FolderPath": "Shared/MySolution",
"ActivationStatus": "SuccessfulActivate"
}
}
{
"Code": "SolutionDeployRun",
"Data": {
"Status": "DeploymentSucceeded",
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
"PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
"InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"FolderName": "MySolution",
"FolderPath": "Shared/MySolution",
"ActivationStatus": "SuccessfulActivate"
}
}
Bereitstellung des persönlichen Arbeitsbereichs/Ordnerfeeds ohne --wait:
{
"Code": "SolutionDeployRun",
"Data": {
"Status": "DeploymentStarted",
"DeploymentName": "my-deployment",
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"FolderName": "MySolution",
"FolderPath": "alice@uipath.com/MySolution",
"ActivationStatus": "Auto",
"NextSteps": "Deployment created in your Personal Workspace and will auto-activate. Check status with: uip solution deploy list."
}
}
{
"Code": "SolutionDeployRun",
"Data": {
"Status": "DeploymentStarted",
"DeploymentName": "my-deployment",
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"FolderName": "MySolution",
"FolderPath": "alice@uipath.com/MySolution",
"ActivationStatus": "Auto",
"NextSteps": "Deployment created in your Personal Workspace and will auto-activate. Check status with: uip solution deploy list."
}
}
RequestedFolderName und FolderNote werden nur angezeigt, wenn das angeforderte --folder-name bereits vergeben wurde: Der Orchestrator benennen den Ordner um, anstatt ihn wiederzuverwenden, sodass die tatsächlichen FolderName/FolderPath von den angeforderten Anforderungen abweichen und FolderNote erklärt die Umbenennung mit einem Hinweis darauf, dass entweder der umbenannte Ordner verwendet oder mit einem freien Namen erneut ausgeführt wird.
Terminalbereitstellungsstatus: DeploymentSucceeded, DeploymentFailed, ValidationFailed, ConflictFixingError, DeploymentScheduleError. Nicht erfolgreiche Endzustände werden mit 1 beendet und fassen die Validierungs-/Konflikt-/Zeitplan-/Workflow-Fehler im Feld Instructions zusammen.
Timeout-Verhalten
Wenn die Bereitstellung keinen Endstatus erreicht, bevor --timeout abläuft, wird der Befehl ungleich Null mit einem Verweis auf deploy status <pipeline-deployment-id> beendet, sodass Sie die Überwachung fortsetzen können.
Fehlermodi
- Bereitstellung ist bereits unter
--namevorhanden. Wird abgelehnt, es sei denn,-y, --yeswird übergeben (installiert eine zweite, unabhängige Kopie) – Verwenden Sie stattdessendeploy upgradewenn die Absicht besteht, die vorhandene Bereitstellung in eine neue Version zu verschieben. --nameist vorhanden, an eine andere--package-namegebunden. Schlägt direkt fehl – ein Bereitstellungsname kann die Pakete nicht überdeploy runwechseln.- Eine Bereitstellung für
--namewird bereits ausgeführt. Schlägt fehl – der vorherige Vorgang muss zuerst fertig gestellt werden.
Upgrade der UIP-Lösung bereitstellen
Aktualisieren einer vorhandenen Bereitstellung auf eine neuere Paketversion – das CLI-Äquivalent der Schaltfläche „Upgrade“ der Orchestrator-Benutzeroberfläche. Verwenden Sie diese Option, wenn deploy run blockiert ist, da bereits eine Bereitstellung unter dem Zielnamen vorhanden ist. Die vorhandene Konfiguration der Bereitstellung bleibt erhalten, sodass bereits festgelegte Werte (z. B. das Geheimnis eines Anmeldeinformations-Assets) nicht auf die Paketstandardeinstellungen zurückgesetzt werden. Wartet auf den Abschluss des Upgrades, es sei denn, --no-wait wird übergeben.
Argumente
<deployment-key>(erforderlich) – Schlüssel der zu aktualisierenden Bereitstellung. Verwenden Siedeploy list, um es zu finden (das FeldKey).
Optionen
| Long | Wert | Standard | Beschreibung |
|---|---|---|---|
--version <version> | text | neueste verfügbare | Zielpaketversion. Nur die letzte veröffentlichte Version wird heute unterstützt. |
--personal-workspace | Markieren | aus | Aktualisieren Sie eine Bereitstellung in Ihrem Feed für den persönlichen Arbeitsbereich anstelle des Mandanten. |
--no-wait | Markieren | aus | Kehren Sie zurück, sobald das Upgrade akzeptiert wurde, anstatt auf dessen Abschluss zu warten. |
--timeout <seconds> | Sekunden | 300 | Sekunden, die bis zum Abschluss des Upgrades gewartet werden müssen. |
--poll-interval <ms> | ms | 5000 | Millisekunden zwischen Statusabfragen. |
--login-validity <minutes> | Minuten | 10 | Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen. |
Beispiele
# Upgrade to the newest published version, waiting for completion
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001
# Start the upgrade without waiting
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001 --no-wait
# Upgrade to the newest published version, waiting for completion
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001
# Start the upgrade without waiting
uip solution deploy upgrade a1b2c3d4-0000-0000-0000-000000000001 --no-wait
Datenform (--output json)
{
"Code": "SolutionDeployUpgrade",
"Data": {
"Status": "Successful",
"DeploymentName": "billing-solution",
"FromVersion": "1.0.0",
"ToVersion": "2.0.0",
"VersionChangeKey": "b2c3d4e5-0000-0000-0000-000000000002"
}
}
{
"Code": "SolutionDeployUpgrade",
"Data": {
"Status": "Successful",
"DeploymentName": "billing-solution",
"FromVersion": "1.0.0",
"ToVersion": "2.0.0",
"VersionChangeKey": "b2c3d4e5-0000-0000-0000-000000000002"
}
}
Mit --no-wait ist Status "Draft" und das Upgrade wurde nur akzeptiert, nicht abgeschlossen – Abfragen Sie deploy list (die Felder Actions/TargetPackageVersion ), um es nachzuverfolgen.
Bereitstellungsstatus der UIP-Lösung
Überprüfen Sie den aktuellen Status einer Pipelinebereitstellung. Gibt den Bereitstellungsstatus und, falls verfügbar, den Namen/das Paket/die Version der Bereitstellung sowie eine verkettete Fehlerzusammenfassung zurück.
Argumente
<pipeline-deployment-id>(erforderlich) – Der vonPipelineDeploymentIdzurückgegebenedeploy run.
Optionen
--login-validity <minutes>– Standardmäßig auf10.
Beispiel
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001
Datenform (--output json)
{
"Code": "SolutionDeployStatus",
"Data": {
"PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
"Status": "DeploymentSucceeded",
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
"ConfigurationKey": "...",
"InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"DeploymentResult": {
"Name": "my-deployment",
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"Status": "Successful",
"StartDate": "2026-04-15T10:30:00Z",
"EndDate": "2026-04-15T10:31:12Z",
"Errors": null
}
}
}
{
"Code": "SolutionDeployStatus",
"Data": {
"PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
"Status": "DeploymentSucceeded",
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
"ConfigurationKey": "...",
"InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"DeploymentResult": {
"Name": "my-deployment",
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"Status": "Successful",
"StartDate": "2026-04-15T10:30:00Z",
"EndDate": "2026-04-15T10:31:12Z",
"Errors": null
}
}
}
Bereitstellungsliste der UIP-Lösung
Listen Sie Lösungsbereitstellungen auf. Zeigt den Bereitstellungsnamen, die aktuelle/Zielpaketversion, den ausstehenden Vorgang, den Aktivierungsstatus und den Ordnerpfad an.
Optionen
| Long | Wert | Standard | Beschreibung |
|---|---|---|---|
--folder-path <path> | Pfad | – | Filtern Sie nach dem Pfad des übergeordneten Ordners. Die Filterung wird nach dem Abrufen angewendet; Erhöhen Sie --limit wenn die Ergebnisse bei Verwendung dieses Filters unvollständig erscheinen. |
--folder-key <key> | GUID | – | Filtern Sie nach dem Schlüssel des übergeordneten Ordners. Alternative zu --folder-path. |
-l, --limit <number> | Nummer | 50 | Max. abzurufende Bereitstellungen. |
--offset <number> | Nummer | 0 | Anzahl der zu überspringenden Bereitstellungen (angewendet vor der Filterung --folder-path/--folder-key). |
--sort-by <column> | text | startTime | Spalte, nach der sortiert werden soll. |
--sort-order <direction> | Ascending | Descending | Descending | Sortierrichtung. |
--operation-status <statuses> | durch Kommas getrennt sind | – | Serverseitiger Filter nach Vorgangsstatus (z. B. Successful, InProgress, Failed). |
--activation-status <statuses> | durch Kommas getrennt sind | – | Serverseitiger Filter nach Aktivierungsstatus (z. B. Active, Inactive). |
--personal-workspace | Markieren | aus | Listen Sie nur Bereitstellungen aus dem Feed des persönlichen Arbeitsbereichs des aktuellen Benutzers auf. Sich gegenseitig mit --feed ausschließen. |
--feed <name-or-key> | text | – | Listen Sie nur Bereitstellungen aus diesem Feed auf. Sich gegenseitig mit --personal-workspace ausschließen. |
--login-validity <minutes> | Minuten | 10 | Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen. |
Sowohl --operation-status als auch --activation-status lehnen Werte außerhalb der bekannten Statuslisten des SDK ab – die Fehlermeldung listet die gültigen Werte auf.
Beispiele
uip solution deploy list --limit 20 --folder-path "Shared/Production"
# Spot a pending in-place upgrade
uip solution deploy list --operation-status InProgress
uip solution deploy list --limit 20 --folder-path "Shared/Production"
# Spot a pending in-place upgrade
uip solution deploy list --operation-status InProgress
Datenform (--output json)
{
"Code": "SolutionDeployList",
"Data": [
{
"Key": "a1b2c3d4-0000-0000-0000-000000000002",
"InstallDeploymentKey": "b2c3d4e5-0000-0000-0000-000000000002",
"Name": "billing-solution",
"PackageName": "billing-solution",
"PackageVersion": "1.0.0",
"CurrentPackageVersion": "1.0.0",
"TargetPackageVersion": "2.0.0",
"NewPackageVersionAvailable": "2.0.0",
"Operation": "VersionChange",
"OperationStatus": "InProgress",
"ActivationStatus": "Active",
"FolderPath": "Shared/Billing",
"FolderKey": "c3d4e5f6-0000-0000-0000-000000000002",
"CreatedAt": "2026-04-15T10:30:00Z",
"Actions": ["Upgrade"]
}
],
"Pagination": { "Returned": 1, "Limit": 10, "Offset": 0, "Total": 1 }
}
{
"Code": "SolutionDeployList",
"Data": [
{
"Key": "a1b2c3d4-0000-0000-0000-000000000002",
"InstallDeploymentKey": "b2c3d4e5-0000-0000-0000-000000000002",
"Name": "billing-solution",
"PackageName": "billing-solution",
"PackageVersion": "1.0.0",
"CurrentPackageVersion": "1.0.0",
"TargetPackageVersion": "2.0.0",
"NewPackageVersionAvailable": "2.0.0",
"Operation": "VersionChange",
"OperationStatus": "InProgress",
"ActivationStatus": "Active",
"FolderPath": "Shared/Billing",
"FolderKey": "c3d4e5f6-0000-0000-0000-000000000002",
"CreatedAt": "2026-04-15T10:30:00Z",
"Actions": ["Upgrade"]
}
],
"Pagination": { "Returned": 1, "Limit": 10, "Offset": 0, "Total": 1 }
}
Key ist der Wert, deploy upgrade als <deployment-key> erwartet. NewPackageVersionAvailable ist nicht NULL, wenn eine neuere veröffentlichte Version als die derzeit bereitgestellte vorhanden ist. Actions listet die derzeit für die Bereitstellung verfügbaren Vorgänge auf (z. B. ["Upgrade"]).
Aktivierung der Bereitstellung der UIP-Lösung
Aktivieren Sie eine Bereitstellung, die ohne automatische Aktivierung installiert wurde. Die Aktivierung stellt alle Lösungskomponenten bereit. activate gibt zuerst die von Orchestrator gemeldeten Voraktivierungsschritte aus (an ständigrr, über --log-level info), dann aktiviert es und ruft bis zu einem Endstatus (SuccessfulActivate oder FailedActivate) auf.
Argumente
<deployment-name>(erforderlich) – Name der zu aktivierenden Bereitstellung. Verwenden Siedeploy listum Bereitstellungsnamen zu finden.
Optionen
--timeout <seconds>– Timeout bei Aktivierungsabfrage. Die Standardeinstellung ist360.--poll-interval <ms>– Millisekunden zwischen Statusabfragen. Die Standardeinstellung ist5000.--login-validity <minutes>– Standardmäßig auf10.
Beispiel
uip solution deploy activate my-deployment
uip solution deploy activate my-deployment
Datenform (--output json)
{
"Code": "SolutionDeployActivate",
"Data": {
"Status": "SuccessfulActivate",
"DeploymentName": "my-deployment",
"InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
}
}
{
"Code": "SolutionDeployActivate",
"Data": {
"Status": "SuccessfulActivate",
"DeploymentName": "my-deployment",
"InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
}
}
Wenn der Orchestrator kein instanceId (nichts abzurufen) meldet, wird InstanceId weggelassen und der Befehl wird erfolgreich zurückgegeben.
Deinstallation der UIP-Lösung – Bereitstellung
Deinstallieren Sie eine bereitgestellte Lösung. Entfernt alle bereitgestellten Ressourcen und den Lösungsordner. Dies ist ein endgültiger Vorgang – es gibt nichts rückgängig zu machen.
Argumente
<deployment-name>(erforderlich) – Name der zu deinstallierenden Bereitstellung.
Optionen
-y, --yes– Erforderlich. Bestätigt diesen nicht rückgängig zu machenden Vorgang – die CLI fordert Sie nie auf.--timeout <seconds>– Deinstallieren des Timeouts für Abrufe. Die Standardeinstellung ist360.--poll-interval <ms>– Millisekunden zwischen Statusabfragen. Die Standardeinstellung ist5000.--login-validity <minutes>– Standardmäßig auf10.
Beispiel
uip solution deploy uninstall my-deployment --yes
uip solution deploy uninstall my-deployment --yes
Datenform (--output json)
{
"Code": "SolutionDeployUninstall",
"Data": {
"Status": "SuccessfulUninstall",
"DeploymentName": "my-deployment",
"InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
}
}
{
"Code": "SolutionDeployUninstall",
"Data": {
"Status": "SuccessfulUninstall",
"DeploymentName": "my-deployment",
"InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
}
}
Es sind drei mögliche Erfolgs Formen, die sich dadurch unterscheiden, welche Felder angezeigt werden:
- Sofort – Der Orchestrator meldet
complete: truebeim ersten Aufruf; Es finden keine Abrufe. NurStatus/DeploymentNamewerden angezeigt. - Geplant – Der Orchestrator plant die Arbeit, ohne eine Instanz-ID zurückzugeben; ein Feld
Scheduledwird hinzugefügt. - Abgerufen – Ein
InstanceIdwird zurückgegeben und der Befehl ruft ihn wie oben gezeigt ab.
Fehlermodi
-
-y, --yesfehlt. Der Befehl wird ohne Bestätigung abgelehnt.
Abrufen der Konfigurationsbereitstellung für die UIP-Lösung
Rufen Sie die Standardbereitstellungskonfiguration für ein veröffentlichtes Lösungspaket ab. Die Konfiguration listet jede Ressource auf, die die Lösung erstellt (Warteschlangen, Assets, Prozesse, Buckets, Verbindungen, …) mit ihren Standardeinstellungen. Speichern Sie es in einer Datei (-d), passen Sie mit config set / config link an und übergeben Sie es dann an deploy run --config-file.
Argumente
<package-name>(erforderlich) – Name des Lösungspakets. Verwenden Siepackages list.
Optionen
| Long | Wert | Standard | Beschreibung |
|---|---|---|---|
--package-version <version> | text | Neuestes | Paketversion |
-d, --destination <path> | Pfad | standardout | Schreiben Sie die Konfiguration in diese Datei anstelle von „stdout“. |
--format <format> | json | yaml | json | Konfigurationsformat. |
--login-validity <minutes> | Minuten | 10 | Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen. |
Beispiel
uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json
# YAML format
uip solution deploy config get my-package -d ./deploy-config.yaml --format yaml
uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json
# YAML format
uip solution deploy config get my-package -d ./deploy-config.yaml --format yaml
Datenform (--output json)
Wenn -d angegeben ist:
{
"Code": "SolutionDeployConfig",
"Data": {
"Status": "Configuration written",
"OutputPath": "/workspace/deploy-config.json",
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"State": "Ready",
"Format": "json"
}
}
{
"Code": "SolutionDeployConfig",
"Data": {
"Status": "Configuration written",
"OutputPath": "/workspace/deploy-config.json",
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"State": "Ready",
"Format": "json"
}
}
Wenn -d weggelassen wird, ist die Konfiguration in die Antwort eingebettet:
{
"Code": "SolutionDeployConfig",
"Data": {
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"State": "Ready",
"Format": "json",
"Configuration": { "resources": [ "..." ] }
}
}
{
"Code": "SolutionDeployConfig",
"Data": {
"PackageName": "my-package",
"PackageVersion": "1.0.0",
"State": "Ready",
"Format": "json",
"Configuration": { "resources": [ "..." ] }
}
}
Konfigurationssatz für die Bereitstellung der UIP-Lösung
Bearbeiten Sie eine Ressourceneigenschaft in einer Bereitstellungskonfigurationsdatei. Die Datei bleibt lokal, bis Sie sie an deploy run --config-file übergeben.
Argumente
<file>(erforderlich) – Der Pfad zur JSON-Datei zur Bereitstellungskonfiguration (erstellt vonconfig get).<args...>(erforderlich) – Hängt von--allab:- Ohne
--all:<resource> <property> <value>– z. BMyQueue maxNumberOfRetries 5. - Mit
--all:<property> <value>– gilt für jede Ressource in der Datei. Nur für die EigenschaftconflictFixingActionder obersten Ebene gültig.
- Ohne
Optionen
--all– Wenden Sie die Eigenschaft auf alle Ressourcen in der Datei an. Nur mitconflictFixingActionzulässig (z. BUseExisting).
Beispiele
Ändern Sie Wiederholungen für eine einzelne Warteschlange
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5
Legen Sie für jede Ressource eine Richtlinie zur Konfliktbehebung fest
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting
uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting
Datenform (--output json)
Aktualisierung einer einzigen Ressource:
{
"Code": "DeployConfigSet",
"Data": {
"Resource": "MyQueue",
"Property": "maxNumberOfRetries",
"OldValue": 1,
"NewValue": 5
}
}
{
"Code": "DeployConfigSet",
"Data": {
"Resource": "MyQueue",
"Property": "maxNumberOfRetries",
"OldValue": 1,
"NewValue": 5
}
}
Massenaktualisierung (--all):
{
"Code": "DeployConfigSet",
"Data": {
"Resource": "all",
"Property": "conflictFixingAction",
"NewValue": "UseExisting",
"ResourceCount": 12
}
}
{
"Code": "DeployConfigSet",
"Data": {
"Resource": "all",
"Property": "conflictFixingAction",
"NewValue": "UseExisting",
"ResourceCount": 12
}
}
Konfigurationslink zur Bereitstellung der UIP-Lösung
Verknüpfen Sie eine Lösungsressource mit einer vorhandenen Orchestrator-Ressource, sodass die Bereitstellung sie wiederverwendet, anstatt eine neue zu erstellen. Änderungen sind lokal – wenden Sie sie an, indem Sie die Datei an deploy run --config-file übergeben.
Argumente
<file>(erforderlich) – Der Pfad zur JSON-Datei zur Bereitstellungskonfiguration.<resource>(erforderlich) – Ressourcenname oderresourceKeyaus der Konfigurationsdatei.
Optionen
-n, --name <name>(erforderlich) – Name der vorhandenen Orchestrator-Ressource, mit der verknüpft werden soll.--folder-path <path>– Orchestrator-Ordnerpfad, in dem sich die vorhandene Ressource befindet.
Beispiel
uip solution deploy config link ./deploy-config.json MyQueue \
--name ProductionQueue \
--folder-path "Shared/Production"
uip solution deploy config link ./deploy-config.json MyQueue \
--name ProductionQueue \
--folder-path "Shared/Production"
Datenform (--output json)
{
"Code": "DeployConfigLink",
"Data": {
"Resource": "MyQueue",
"LinkedTo": {
"name": "ProductionQueue",
"folderPath": "Shared/Production"
}
}
}
{
"Code": "DeployConfigLink",
"Data": {
"Resource": "MyQueue",
"LinkedTo": {
"name": "ProductionQueue",
"folderPath": "Shared/Production"
}
}
}
Link zur Bereitstellung der UIP-Lösungsbereitstellung aufheben
Entfernen Sie einen Link, der zuvor mit config link festgelegt wurde. Beim nächsten deploy run --config-file wird die Ressource neu erstellt anstatt wiederverwendet.
Argumente
<file>(erforderlich) – Der Pfad zur JSON-Datei zur Bereitstellungskonfiguration.<resource>(erforderlich) – Ressourcenname oderresourceKeyzum Aufheben der Verknüpfung.
Beispiel
uip solution deploy config unlink ./deploy-config.json MyQueue
uip solution deploy config unlink ./deploy-config.json MyQueue
Datenform (--output json)
{
"Code": "DeployConfigUnlink",
"Data": {
"Resource": "MyQueue",
"UnlinkedFrom": "ProductionQueue"
}
}
{
"Code": "DeployConfigUnlink",
"Data": {
"Resource": "MyQueue",
"UnlinkedFrom": "ProductionQueue"
}
}
Fehlermodi
- Ressource ist derzeit nicht verknüpft. Der Befehl abgelehnt das Aufheben der Verknüpfung und verweist auf
config link.
Zugehörige Befehle
uip solution publish– erforderlicher Schritt vordeploy run.uip solution packages list– Paketnamen und -versionen erkennen.uip or– Überprüfen oder erstellen Sie die Orchestrator-Ressourcen, auf diedeploy config linkverweist.
Siehe auch
- Ihre erste Pipeline – Packen → Veröffentlichen → Bereitstellen.
- Authentifizierung und Konfiguration – Sitzungseinrichtung und Standardeinstellungen pro Mandant.
uip solutionÜbersicht.
- Typischer Workflow
- Ausführung der Bereitstellung der UIP-Lösung
- Zusammenfassung
- Optionen
- Beispiele
- Datenform (--output json)
- Timeout-Verhalten
- Fehlermodi
- Upgrade der UIP-Lösung bereitstellen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- Bereitstellungsstatus der UIP-Lösung
- Argumente
- Optionen
- Beispiel
- Datenform (--output json)
- Bereitstellungsliste der UIP-Lösung
- Optionen
- Beispiele
- Datenform (--output json)
- Aktivierung der Bereitstellung der UIP-Lösung
- Argumente
- Optionen
- Beispiel
- Datenform (--output json)
- Deinstallation der UIP-Lösung – Bereitstellung
- Argumente
- Optionen
- Beispiel
- Datenform (--output json)
- Fehlermodi
- Abrufen der Konfigurationsbereitstellung für die UIP-Lösung
- Argumente
- Optionen
- Beispiel
- Datenform (--output json)
- Konfigurationssatz für die Bereitstellung der UIP-Lösung
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- Konfigurationslink zur Bereitstellung der UIP-Lösung
- Argumente
- Optionen
- Beispiel
- Datenform (--output json)
- Link zur Bereitstellung der UIP-Lösungsbereitstellung aufheben
- Argumente
- Beispiel
- Datenform (--output json)
- Fehlermodi
- Zugehörige Befehle
- Siehe auch