Bereitstellung der UIP-Lösung

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.

Hinweis:

run, status, and list accept --feed <name-or-key> to work with a folder feed. Refer to uip solution feeds to list the feeds you can reach. For more information about folder feeds, refer to Solution feed in the Solutions Management documentation.

Unterbefehl	Zweck
run	Install a deployment from a published package.
upgrade	Move an existing deployment to another published version of its package, in place.
status	Check the state of a deployment, by name or key, or the progress of a pipeline deployment run.
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.
delete	Delete a deployment record that uninstall cannot remove.
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.

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 delete

deploy run is keyed on --name. A name that does not exist yet gets a new deployment in a new folder. If the package is already deployed, deploy run stops and points to deploy upgrade, which moves the existing deployment to another version in place. To install a second, separate copy, pass -y, --yes with a different --name.

---

Ausführung der Bereitstellung der UIP-Lösung

Install a solution deployment in Orchestrator from a published package. Creates a new folder (under --parent-folder-path or --parent-folder-key, or the current user's Personal Workspace), provisions every resource described in the package (or in --config-file), and, unless --skip-activate is set, activates it.

The deployment is keyed on --name. Before installing, the command checks whether the package already has a deployment; if so, it stops and points to deploy upgrade. The check is best-effort: a lookup failure only warns, and under an External Application (client-credentials) login an existing deployment is reported as a warning instead of stopping the deploy.

The package is validated against the target before anything is installed. A validation failure ends the run at ValidationFailed with the errors in Instructions, and nothing is installed. The rejected attempt is kept as a pending draft: fix the configuration and re-run the same command, and the server validates the draft again with the new file. Settings and resource links that the file does not name keep the values the draft was rejected with.

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] \
  [-y, --yes] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

Optionen

Long	Wert	Standard	Beschreibung
-n, --name <deployment-name>	text	–	Required. Name for the deployment. Used by deploy status, deploy upgrade, deploy activate, deploy uninstall, and deploy delete to identify this install.
--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	Deploy into the current user's Personal Workspace. The workspace name is resolved from Orchestrator automatically. Requires a user login; an External Application has no Personal Workspace. Mutually exclusive with --parent-folder-path, --parent-folder-key, and --feed.
--feed <name-or-key>	text	Mandanten-Feed	Deploy a package published to this feed (name or folder key, from solution feeds list) instead of the tenant feed. This scopes which feed the package comes from — the --parent-folder-path/--parent-folder-key/--personal-workspace flags still control where the Orchestrator folder is created. Requires a user login; an External Application login is refused instead of deploying to the tenant feed. Mutually exclusive with --personal-workspace.
--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.
-y, --yes	Markieren	aus	Deploy even when this package already has a deployment. Without it, the command looks the package up and stops if it is already deployed. The check is best-effort: a lookup failure only warns, and under an External Application (client-credentials) login an existing deployment is reported as a warning instead of stopping the deploy. --yes only skips the check. Re-using an existing deployment's --name updates that deployment in place; pass a different --name for a separate copy.
--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"

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

Into the Personal Workspace

uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --personal-workspace

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

Aus einem Ordnerfeed

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

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 "PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Datenform (--output json)

The command waits for the deployment to finish, bounded by --timeout:

{
  "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"
  }
}

A deployment that installed but needs Setup activation in Orchestrator before it can be activated returns Result: Success with ActivationStatus: NeedsSetupToActivate. Do not deploy it again; configure the listed resources and activate it:

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000003",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000003",
    "InstanceId": null,
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution",
    "ActivationStatus": "NeedsSetupToActivate",
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 1.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}

With --skip-activate, ActivationStatus is Skipped.

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

• The package already has a deployment. Refused unless -y, --yes is passed. Use deploy upgrade to move the existing deployment to a new version, or pass --yes with a different --name to install a second, separate copy.
• Validation failed. The run ends at ValidationFailed and nothing is installed. The rejected attempt is kept as a pending draft; fix the configuration and re-run the command. When the run was an update of an existing deployment, Instructions also names the deploy upgrade <deployment-key> --discard-draft --version <version> command that discards the draft and upgrades the live version instead.
• --name has a pending draft for another version. Refused. Re-run with the draft's --package-version to retry the draft, or discard it with deploy upgrade --discard-draft.
• --name ist vorhanden, an eine andere --package-name gebunden. Schlägt direkt fehl – ein Bereitstellungsname kann die Pakete nicht über deploy run wechseln.
• Eine Bereitstellung für --name wird bereits ausgeführt. Schlägt fehl – der vorherige Vorgang muss zuerst fertig gestellt werden.

---

Upgrade der UIP-Lösung bereitstellen

Upgrade an existing deployment to another published version of its package, in place. This is the CLI equivalent of the Upgrade button in Orchestrator. Use it when deploy run stops because the package is already deployed. The deployment's existing configuration is preserved, so values already set on it (for example a credential asset's secret) are not reset to the package defaults.

The package is validated against the target before anything is installed. A validation failure reports the errors and leaves the deployment on its current version. The command waits for the upgrade to finish unless --no-wait is passed; track a running upgrade with deploy status <pipeline-deployment-id>.

Zusammenfassung

uip solution deploy upgrade <deployment-key> [options]
uip solution deploy upgrade --name <deployment-name> --package-name <name> [options]

Address the deployment either by key or by --name with --package-name, not both.

Argumente

• [deployment-key] — Key of the deployment to upgrade, as deploy list reports it (Key), or a stored InstallDeploymentKey. The deployment's name, package, current version, and feed are read from the server, so --package-name and --personal-workspace are not needed. Use either this or --name with --package-name.

Optionen

Long	Wert	Standard	Beschreibung
-n, --name <deployment-name>	text	–	Name of the deployment to upgrade, as reported by deploy list. Goes with --package-name. The command checks that the name exists before installing, so a mistyped name is refused instead of creating a new deployment.
--package-name <name>	text	–	The deployment's package. Required with --name.
--version <version>	text	newest published	Target package version. Any published version of the same package is accepted, including an older one. An empty value is refused.
--personal-workspace	Markieren	aus	With --name: upgrade a deployment in your Personal Workspace feed instead of the tenant. With a key, the feed is read from the deployment and this flag is not needed.
--discard-draft	Markieren	aus	When the deployment has a pending draft (an earlier attempt that never completed, usually one rejected by validation), discard the draft first and upgrade the live version. Without it, such a deployment is refused, because the server would re-run the draft with the configuration it was rejected for. With --name, the draft is found only under a user login; under an External Application, pass the deployment key.
--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.

Both forms work under an External Application (client-credentials) login, so they can run from a CI/CD pipeline. A deployment in a Personal Workspace or folder feed requires a user login. The --name form has no --feed option; to upgrade a deployment in a folder feed, pass its key.

Beispiele

# By key, to the newest published version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003

# By name, to the newest published version
uip solution deploy upgrade --name my-deployment --package-name my-package

# To a specific published version (for example from a CI/CD pipeline)
uip solution deploy upgrade --name my-deployment --package-name my-package --version 1.5.0

# Start the upgrade without waiting
uip solution deploy upgrade --name my-deployment --package-name my-package --no-wait

# Discard the pending draft a rejected attempt left behind, then upgrade the live version
uip solution deploy upgrade c3d4e5f6-0000-0000-0000-000000000003 --version 2.0.0 --discard-draft

Datenform (--output json)

Upgrade by key:

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "DeploymentSucceeded",
    "Operation": "VersionChange",
    "DeploymentStatus": "SuccessfulActivate",
    "Actions": ["Uninstall", "Upgrade"],
    "DeploymentName": "my-deployment",
    "FromVersion": "1.5.0",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002",
    "DeploymentKey": "d4e5f6a7-0000-0000-0000-000000000004",
    "InstallDeploymentKey": "c3d4e5f6-0000-0000-0000-000000000003"
  }
}

Mit --no-wait:

{
  "Code": "SolutionDeployUpgrade",
  "Data": {
    "Status": "Accepted",
    "DeploymentName": "my-deployment",
    "ToVersion": "2.0.0",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000002"
  }
}

Feld	Beschreibung
Status	Terminal pipeline status (DeploymentSucceeded), or Accepted when --no-wait returned before the upgrade finished.
Operation	What the server did: VersionChange for a version move, or ConfigurationChange when the requested version was already deployed. Absent with --no-wait.
DeploymentStatus	SuccessfulActivate when the new version runs, or SuccessfulInstall when it is installed but waits for activation setup (the previous version keeps running). Absent with --no-wait.
Actions	Operations available on the deployment next (for example SetupActivation, Uninstall, Upgrade).
ActivationStatus, PendingResources, NextSteps	Present when the new version does not run yet, for example ActivationStatus: NeedsSetupToActivate with the resources that need configuration. Same shape as deploy run.
FromVersion	Version deployed before the upgrade. Key form only.
ToVersion	Version the upgrade targeted.
PipelineDeploymentId	ID of the pipeline run that performs the upgrade. Pass it to deploy status.
DeploymentKey	Key of the upgraded deployment record. Absent with --no-wait.
InstallDeploymentKey	Key of the original install. It stays the same across upgrades, so it is the key to store. Key form only.
DiscardedDraftKey	Key of the pending draft that --discard-draft deleted. Present only when one was discarded.

Fehlermodi

• Both a key and --name passed, or --name without --package-name. Refused.
• No deployment found for the key, or for the name in that feed. Refused.
• The deployment is uninstalled. Refused, because an install would create a new deployment. Use deploy run to deploy the package again.
• The deployment has a pending draft. Refused unless --discard-draft is passed.
• The deployment is in a Personal Workspace or folder feed and the login is an External Application. Refused; use a user login.
• The target version is not published in the feed. Refused.
• Validation, conflict fixing, scheduling, or the install failed. The command exits with 1 and reports the errors. The deployment stays on the version it was already running. When the failure left a pending draft, Instructions names the --discard-draft command to retry with.
• Timeout. The upgrade did not finish within --timeout. It may still be running; check it with deploy status <pipeline-deployment-id>.

---

Bereitstellungsstatus der UIP-Lösung

Check the state of a deployment by name, or by a deployment key from deploy list or deploy upgrade: operation, activation status, and what is left to do before it runs. The command also takes the pipeline deployment ID from deploy run and returns that run's progress and errors.

Argumente

• <deployment> (required) — Deployment name (preferred), a deployment key, or a pipeline deployment ID. A key is resolved across every feed, and a superseded key is answered with the deployment's current record.

Optionen

Long	Wert	Standard	Beschreibung
--feed <name-or-key>	text	–	For a deployment name: the feed to look it up in (name or folder key, from solution feeds list). Without --feed or --personal-workspace, a name is looked up across the feeds. Mutually exclusive with --personal-workspace.
--personal-workspace	Markieren	aus	For a deployment name: look it up in your Personal Workspace feed instead of the tenant.
--login-validity <minutes>	Minuten	10	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen.

--personal-workspace, and --feed with a deployment name, require a user login; an External Application login is refused.

Beispiele

# By deployment name
uip solution deploy status my-deployment

# By deployment key
uip solution deploy status a1b2c3d4-0000-0000-0000-000000000001

# By name, in your Personal Workspace feed
uip solution deploy status my-deployment --personal-workspace

# The pipeline deployment run that deploy run started
uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

Datenform (--output json)

A deployment addressed by name or key returns Code: SolutionDeployment. This example is a deployment that is upgraded but not live yet:

{
  "Code": "SolutionDeployment",
  "Data": {
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "Superseded": false,
    "CurrentDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000002",
    "InstallDeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "my-deployment",
    "PackageName": "my-package",
    "PackageVersion": "2.0.0",
    "NewPackageVersionAvailable": null,
    "Operation": "VersionChange",
    "OperationStatus": "Successful",
    "DeploymentStatus": "SuccessfulInstall",
    "ActivationStatus": "NeedsSetupToActivate",
    "Actions": ["SetupActivation", "Uninstall", "Upgrade"],
    "PendingResources": [
      {
        "Kind": "connection",
        "Name": "Outlook",
        "Type": "uipath-microsoft-outlook365",
        "Reason": "[CNS1072] You will need to authenticate this connection before proceeding further"
      }
    ],
    "NextSteps": [
      "Deployment 'my-deployment' is installed at version 2.0.0 but not live: it needs 'Setup activation' before it can be activated.",
      "Resources that need configuration: connection 'Outlook' (uipath-microsoft-outlook365): [CNS1072] You will need to authenticate this connection before proceeding further."
    ]
  }
}

Feld	Beschreibung
DeploymentKey	The key that was requested.
Superseded	true when a later operation replaced the requested record. The state fields then describe the current record, and NextSteps names the key to use. null when the chain of records could not be read.
CurrentDeploymentKey	Key of the deployment's current record.
InstallDeploymentKey	Key of the original install, stable across upgrades.
DeploymentStatus	SuccessfulActivate when the version runs, SuccessfulInstall when it waits for activation or its setup.
ActivationStatus	Activation state, for example Active, ReadyToActivate, or NeedsSetupToActivate. null when it could not be read.
Actions	Operations available on the deployment. null when they could not be read.
PendingResources	Resources that need configuration before activation. Present only when the deployment waits for setup.
NextSteps	What is left before the deployment runs. Absent when it runs.

A pipeline deployment ID returns Code: SolutionDeployStatus with the run's progress:

{
  "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
    }
  }
}

The pipeline service tracks a run only while it is active. After the run ends, check the deployment by name or key instead.

---

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	–	Filter by the full path of the folder the deployment was installed into (for example Shared or Shared/Finance). Exact match, not case-sensitive; subfolders are not included. Applied server-side.
--folder-key <key>	GUID	–	Filter by the key of the folder the deployment was installed into. Alternative to --folder-path. Applied server-side.
-l, --limit <number>	Nummer	50	Max. abzurufende Bereitstellungen.
--offset <number>	Nummer	0	Number of deployments to skip.
--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	–	Server-side filter by operation status. One or more of Draft, Successful, Failed, InProgress, FailedRollback.
--activation-status <statuses>	durch Kommas getrennt sind	–	Server-side filter by activation status. One or more of None, Active, Inactive, ActivationFailed, DeactivationFailed, ReadyToActivate, NeedsSetupToActivate.
--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	–	Only list deployments from this feed (name or folder key, from solution feeds list). Mutually exclusive with --personal-workspace.
--login-validity <minutes>	Minuten	10	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen.

Both --operation-status and --activation-status reject values outside these lists, and the error message lists the valid values.

Beispiele

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 }
}

Key is the value deploy upgrade and deploy status accept as a deployment key. NewPackageVersionAvailable is non-null when a newer published version exists than the one currently deployed. Actions lists operations currently available on the deployment (for example ["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 Sie deploy list um Bereitstellungsnamen zu finden.

Optionen

• --timeout <seconds> – Timeout bei Aktivierungsabfrage. Die Standardeinstellung ist 360.
• --poll-interval <ms> – Millisekunden zwischen Statusabfragen. Die Standardeinstellung ist 5000.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy activate my-deployment

Datenform (--output json)

{
  "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 ist 360.
• --poll-interval <ms> – Millisekunden zwischen Statusabfragen. Die Standardeinstellung ist 5000.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy uninstall my-deployment --yes

Datenform (--output json)

{
  "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: true beim ersten Aufruf; Es finden keine Abrufe. Nur Status/DeploymentName werden angezeigt.
• Geplant – Der Orchestrator plant die Arbeit, ohne eine Instanz-ID zurückzugeben; ein Feld Scheduled wird hinzugefügt.
• Abgerufen – Ein InstanceId wird zurückgegeben und der Befehl ruft ihn wie oben gezeigt ab.

Fehlermodi

• -y, --yes fehlt. Der Befehl wird ohne Bestätigung abgelehnt.
• The deployment cannot be uninstalled in its state (inactive after an uninstall, superseded, or left by a failed install). When the record offers Delete, Instructions points to deploy delete.

---

uip solution deploy delete

Delete a deployment record from the tenant. Use this for a deployment that deploy uninstall cannot remove: one left inactive after an uninstall, one superseded by a newer version, or one left behind by a failed install. Orchestrator refuses to uninstall those with error 4007.

The command finds the deployment by name across the feeds, then reads its available actions. When the record lists actions but not Delete, the command refuses and names the state and the actions that are available. When the record lists no actions, the request goes to the server, which decides.

Argumente

• <deployment-name> (required) — Name of the deployment to delete. Use deploy list to find deployment names.

Optionen

• -y, --yes — Required. Confirms this irreversible operation; the CLI never prompts.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy delete my-deployment --yes

Datenform (--output json)

{
  "Code": "SolutionDeployDelete",
  "Data": {
    "Status": "Deleted",
    "DeploymentName": "my-deployment",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

Fehlermodi

• -y, --yes fehlt. Der Befehl wird ohne Bestätigung abgelehnt.
• No deployment with that name. Refused.
• The deployment offers Uninstall but not Delete. Refused. Run deploy uninstall <deployment-name> --yes first, then retry the delete.
• An operation is in progress on the deployment. Refused. Wait for the operation to finish, then retry.

---

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 Sie packages 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

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"
  }
}

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": [ "..." ] }
  }
}

---

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 von config get).
• <args...> (erforderlich) – Hängt von --all ab:
  • Ohne --all: <resource> <property> <value> – z. B MyQueue maxNumberOfRetries 5.
  • Mit --all: <property> <value> – gilt für jede Ressource in der Datei. Nur für die Eigenschaft conflictFixingAction der obersten Ebene gültig.

Optionen

• --all – Wenden Sie die Eigenschaft auf alle Ressourcen in der Datei an. Nur mit conflictFixingAction zulässig (z. B UseExisting).

Beispiele

Ändern Sie Wiederholungen für eine einzelne Warteschlange

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

Datenform (--output json)

Aktualisierung einer einzigen Ressource:

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}

Massenaktualisierung (--all):

{
  "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 oder resourceKey aus 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"

Datenform (--output json)

{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

---

Link zur Bereitstellung der UIP-Lösungsbereitstellung aufheben

Remove a link set with config link. On the next deploy run --config-file, the resource is created instead of reused.

Argumente

• <file> (erforderlich) – Der Pfad zur JSON-Datei zur Bereitstellungskonfiguration.
• <resource> (erforderlich) – Ressourcenname oder resourceKey zum Aufheben der Verknüpfung.

Beispiel

uip solution deploy config unlink ./deploy-config.json MyQueue

Datenform (--output json)

{
  "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 vor deploy run.
• uip solution packages list – Paketnamen und -versionen erkennen.
• uip or – Überprüfen oder erstellen Sie die Orchestrator-Ressourcen, auf die deploy config link verweist.

Siehe auch

• Ihre erste Pipeline – Packen → Veröffentlichen → Bereitstellen.
• Authentifizierung und Konfiguration – Sitzungseinrichtung und Standardeinstellungen pro Mandant.
• uip solution Übersicht.