- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- UiPath für Codierungs-Agents
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Dokumentation
- 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-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Beispiele für Listenworkflows
- Packen
- restore
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- UIA
- UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
uip agent deploy installiert und aktiviert eine zuvor veröffentlichte Agent-Paketversion in einem Orchestrator-Ordner. Es steuert die gesamte Pipeline zur Lösungsbereitstellung – Konfigurieren → Bereitstellen → Installieren → Bereitstellen → Aktivieren – und fragt ab, bis jede Phase einen Endzustand erreicht.
Standardmäßig stellt der Befehl auch den Zielordner für die sofortige Ausführung bereit: Er weist eine serverlose Maschinenvorlage auf Mandantenebene zu und bindet einen Roboterbenutzer mit der Automation User -Rolle an den Ordner. Bereitstellungsfehler werden als Warnungen statt als Fehler angezeigt (Sie können die Maschine und den Benutzer nach der Tatsache manuell zuweisen).
Erfordert eine aktive CLI-Sitzung (uip login).
Zusammenfassung
uip agent deploy <packageVersionKey>
[-n <name>]
[--folder-key <guid>]
[--force-activate] [--skip-activate]
[-t <tenant>]
[--timeout <seconds>]
[--login-validity <minutes>]
uip agent deploy <packageVersionKey>
[-n <name>]
[--folder-key <guid>]
[--force-activate] [--skip-activate]
[-t <tenant>]
[--timeout <seconds>]
[--login-validity <minutes>]
Alle uip agent deploy -Aufrufe berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag mit den unten angegebenen bereitstellungsspezifischen Überschreibungen.
Argumente
<packageVersionKey>(erforderlich) – Der Paketversionsschlüssel wird vonuip agent publish(Standard-Upload-Pfad) zurückgegeben. GUID.
Optionen
| Markieren | Standard | Zweck |
|---|---|---|
-n, --name <name> | agent-<timestamp> | Name der Bereitstellung. Wird der Anzeigename in Orchestrator und – für automatisch erstellte Ordner – der Ordnername. |
--folder-key <guid> | – (Automatisch erstellen) | Installationsordnerschlüssel (GUID). Wenn er nicht angegeben wird, wird während der Installation automatisch ein neuer Ordner erstellt. |
--force-activate | aus | Erzwingen Sie die Aktivierung, auch wenn eine vorherige Bereitstellung unter diesem Konfigurationsschlüssel vorhanden ist. |
--skip-activate | aus | Nach der Installationsphase anhalten; Nicht aktivieren. Nützlich, wenn Sie die Installation überprüfen möchten, bevor Sie den Agent freigeben. |
-t, --tenant <tenant> | Mandanten anzumelden | Zielmandant. Erforderlich, wenn die Anmeldesitzung keinen Standardmandanten hat. |
--timeout <seconds> | 120 | Maximale Sekunden, die gewartet werden soll, bis jede Abrufphase (Installation, Aktivierung) einen Endzustand erreicht. Bei einer Timeout wird der Befehl mit Code 2 beendet. |
--login-validity <minutes> | 10 | Mindestlaufzeit des Tokens in Minuten erforderlich. |
Beispiele
# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent
# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>
# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate
# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate
# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600
# Deploy to an auto-created folder named "invoice-agent"
uip agent deploy a1b2c3d4-0000-0000-0000-000000000050 --name invoice-agent
# Deploy into an existing folder
uip agent deploy <PackageVersionKey> --folder-key <FolderGuid>
# Install only; do not activate (review in Orchestrator first)
uip agent deploy <PackageVersionKey> --skip-activate
# Force re-activation of a replacement deployment
uip agent deploy <PackageVersionKey> --force-activate
# Longer timeout for slow environments
uip agent deploy <PackageVersionKey> --timeout 600
Datenform (--output json)
Installation + Aktivierung abgeschlossen (Code: "AgentDeploy"):
{
"Code": "AgentDeploy",
"Data": {
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
"DeploymentName": "invoice-agent",
"Status": "SuccessfulActivate",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
"FolderId": 42,
"FolderName": "invoice-agent",
"ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
"PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
}
}
{
"Code": "AgentDeploy",
"Data": {
"DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000060",
"DeploymentName": "invoice-agent",
"Status": "SuccessfulActivate",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000070",
"FolderId": 42,
"FolderName": "invoice-agent",
"ConfigurationKey": "a1b2c3d4-0000-0000-0000-000000000080",
"PackageVersionKey": "a1b2c3d4-0000-0000-0000-000000000050"
}
}
Nur installieren (--skip-activate oder nicht bereit zum Aktivieren): dieselbe Form, wobei Status die Installationsphase widerspiegelt (SuccessfulInstall, FailedInstall) und FolderName weggelassen wird, wenn der Ordner nicht aufgelöst werden konnte.
FolderId– numerische Organisationseinheits-ID des Ordners, die nur ausgefüllt wird, wenn die automatische Bereitstellung erfolgreich war. Übergeben Sie es direkt anuip agent run list --folder-id.FolderKey– GUID des Installationsordners.ConfigurationKey– Schlüssel der LösungenConfiguration, die von dieser Bereitstellung erstellt wurden.PackageVersionKey– wird zur Vereinfachung von der Eingabe zurückgegeben.
Exitcodes
Zusätzlich zu den Standard-CLI-Codes:
0– Die Installation (und optional die Aktivierung) wurde erfolgreich abgeschlossen.1– Bereitstellung fehlgeschlagen (FailedInstall,FailedActivate), Abruffehler oder ein anderer Fehler.2– eine Abfragephase ist abgelaufen (siehe--timeout). Die Bereitstellung kann noch in Orchestrator abgeschlossen werden; Führen Sie die Aktion mit einem längeren Timeout erneut aus oder überprüfen Sie den Status auf der Orchestrator-Benutzeroberfläche.
Siehe Austrittscodes für den gemeinsamen Vertrag.
Bereitstellungsdetails
Wenn ein Ordner automatisch erstellt wird (kein --folder-key), versucht die Bereitstellung Folgendes:
- Weisen Sie dem Ordner eine serverlose Maschinenvorlage auf Mandantenebene zu. Wenn im Mandanten keine serverlose Vorlage vorhanden ist, schlägt die Bereitstellung fehl und die Bereitstellung zeigt eine Warnung an – Sie müssen manuell eine zuweisen.
- Wählen Sie einen zuweisbaren Benutzer aus und gewähren Sie ihm die Rolle
Automation Userim Ordner. Wenn im Mandanten keine solche Rolle vorhanden ist, schlägt die Bereitstellung mit einer Warnung fehl.
Konflikte (HTTP 409) während der Maschinen- oder Benutzerzuweisung werden als idempotente Erfolge behandelt.
Zugehörig
uip agent publish– erzeugt den von diesem Befehl verbrauchtenPackageVersionKey.uip agent run start– Starten Sie einen Auftrag für ein Release im bereitgestellten Ordner.uip agent run list– listet die von der Bereitstellung erstellten Releases auf.
Siehe auch
- Orchestrator: Aufträge – das zugrunde liegende Auftragsmodell.
- Authentifizierung – Sitzungen, Mandanten und
--login-validity. - Globale Optionen, Exitcodes.