uip Gov aops-policy

Syntax und Optionen für das Richtlinien-CRUD, den Produktkatalog, den Lizenztypkatalog und die Form.io-Vorlagenbefehle von „uip Gov aops-policy“.

uip gov aops-policy verwaltet UiPath AOps Governance-Richtlinien – Produktkonfigurationsregeln (z. B. eine StudioX-Richtlinie, die einschränkt, welche Projekteinstellungen zulässig sind), die als ausgefülltes Form.io-Formular erstellt und mandanten/benutzern/gruppenübergreifend zugewiesen wurden. Diese Seite behandelt die Autorenseite: den Richtliniendatensatz selbst (list/get/create/update/delete) sowie die schreibgeschützten Referenzkataloge (product, license-type) und die template -Befehle, die den ausfüllbaren Formulardaten- Blaupause generieren, aus dem die data -Nutzlast einer Richtlinie erstellt wird. Informationen zum Zuweisen einer Richtlinie zu einem Betreff und zur Lösung dessen, was zur Laufzeit tatsächlich gilt, finden Sie unter aops-policy deployment und deployed-policy. Die Übersicht über das übergeordnete Tool und die Zugriffsrichtlinien finden Sie unter uip gov.

Hinweis:

Typischer Ablauf: template get <product> → Bearbeiten der ausgegebenen form-data.json → policy create --product-name <product> --name <name> --input form-data.json → deployment tenant configure (oder Benutzer/Gruppe), um sie einzuführen.

Zusammenfassung

uip gov aops-policy list [--product-name <name>] [--product-label <label>] [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip gov aops-policy get <policyIdentifier>
uip gov aops-policy create --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy update --identifier <id> --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy delete <policyIdentifier>

uip gov aops-policy product list
uip gov aops-policy product get <productIdentifier>

uip gov aops-policy license-type list

uip gov aops-policy template get <productIdentifier> [--output-form-data <path>] [--output-template-locale-resource <path>]
uip gov aops-policy template list --output-dir <path>

Jedes Verb akzeptiert auch --login-validity <minutes>, um die Lebensdauer des interaktiven Anmeldetokens für diesen einen Aufruf zu überschreiben (selten erforderlich).

Governance-Richtlinienliste

Listen Sie Governance-Richtlinien mit optionaler Filterung und Paginierung auf. Gibt Richtlinienmetadaten (Bezeichner, Name, Produkt, Priorität, Verfügbarkeit) zurück – nicht das Blob der Richtlinie data.

Optionen

Long	Wert	Beschreibung
--product-name <product-name>	string	Auf ein Produkt beschränken (z. B StudioX). Entspricht product.name – siehe product list.
--product-label <productLabel>	string	Durch Anzeigebeschriftung auf ein Produkt beschränken (z. B 'Studio X'). Bevorzugen Sie --product-name für die Skripterstellung.
--search <searchTerm>	string	Groß-/Kleinschreibung wird nicht berücksichtigt, wenn die Teilzeichenfolge mit dem Richtliniennamen/der Richtlinienbeschreibung übereinstimmt.
--sort-by <field>	string	Feld, nach dem sortiert werden soll (z. B name, createdOn, priority). An die Governance-API übergeben.
--sort-order <direction>	asc | desc	Sortierrichtung für --sort-by. Groß-/Kleinschreibung wird nicht beachtet; jeder andere Wert schlägt auf Clientseite fehl.
--limit <n>	Integer	Seitengröße. Der Standardwert ist 20.
--offset <n>	Integer	Nullbasierter Seitenindex.

Beispiel

uip gov aops-policy list --product-name StudioX --limit 2

Datenform (--output json)

{
  "Code": "AopsPolicyList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX", "priority": 10, "availability": 1 }
  ]
}

Abrufen der UiPath aops-policy

Rufen Sie eine Richtlinie nach Bezeichner ab, einschließlich ihrer vollständigen data -Nutzlast (die ausgefüllte Formulardaten- Blaupause). Verwenden Sie, um übermittelte Werte zu überprüfen oder eine Folge- update zu seeden.

Argumente

Name	Erforderlich	Zweck
<policyIdentifier>	ja	Richtlinien-GUID von list.

Beispiel

uip gov aops-policy get a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "AopsPolicyGet",
  "Data": {
    "identifier": "a1b2c3d4-0000-0000-0000-000000000001",
    "name": "Baseline StudioX Policy",
    "productName": "StudioX",
    "priority": 10,
    "availability": 1,
    "data": { "allowAnalytics": true, "maxProjects": 5 }
  }
}

Die Schlüssel von data werden genau so beibehalten, wie sie im Form.io-Formular (CamelCase/ke Non-Case) angezeigt werden, nicht in PascalCase – diese Nutzlast ist so konzipiert, dass sie auf update --input unverändert bleibt.

uip Gov aops-policy erstellen

Erstellen Sie eine neue Governance-Richtlinie für ein Produkt.

Optionen

Long	Wert	Erforderlich	Beschreibung
--name <name>	string	ja	Benutzerlesbarer Richtlinienname (eindeutig innerhalb des Produkts).
--product-name <product-name>	string	ja	Zielprodukt (z. B. StudioX, AITrustLayer) – muss mit einem Namen aus product list übereinstimmen.
--description <description>	string	nein	Freitextbeschreibung in der Governance-Benutzeroberfläche.
--priority <n>	Integer	nein	Wenn mehrere Richtlinien für denselben Betreff gelten, gewinnt eine höhere Anzahl.
--availability <n>	Integer	nein	Availability Flag (produktspezifische Aufzählung) – Überprüfen Sie die Governance-UI oder Servicedokumente auf gültige Werte.
--input <path>	Pfad	nein	JSON-Datei mit dem ausgefüllten Formulardatenobjekt (von template get --output-form-data). Für eine Richtlinie ohne Datennutzlast auslassen.

Beispiel

uip gov aops-policy create --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

Datenform (--output json)

{
  "Code": "AopsPolicyCreate",
  "Data": { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX" }
}

Die Antwort gibt den Rohdatenblob (doppelt umgebrochen) an, nicht die vereinfachte Form get – verwenden Sie get, um Formulardaten für ein Folge- update --input zu erzeugen.

Aktualisierung der UiPath aops-Richtlinie

Ersetzen Sie die Felder einer vorhandenen Richtlinie. Vollständige Aktualisierung, kein Patch – jedes Feld, das Sie beibehalten möchten, muss erneut übergeben werden; Wenn Sie --description/--priority/--availability/--input weglassen, wird dieses Feld auf dem Server gelöscht.

Optionen

Long	Wert	Erforderlich	Beschreibung
--identifier <identifier>	GUID	ja	Zu aktualisierende Richtlinie. Von list/get.
--name <name>	string	ja	Richtlinienname. Wenn Sie den vorhandenen Namen übergeben, wird er beibehalten.
--product-name <product-name>	string	ja	Muss mit dem vorhandenen Produkt der Richtlinie übereinstimmen – ein Ändern des Produkts bei der Aktualisierung wird nicht unterstützt.
--description <description>	string	nein	Vollständige Ersetzung: Übergeben Sie erneut den vorhandenen Wert von get, um ihn beizubehalten.
--priority <n>	Integer	nein	Vollständiger Ersatz: Übergeben Sie den vorhandenen Wert erneut, um ihn beizubehalten.
--availability <n>	Integer	nein	Vollständiger Ersatz: Übergeben Sie den vorhandenen Wert erneut, um ihn beizubehalten.
--input <path>	Pfad	nein	Vollständiger Ersatz: Übergeben Sie das vorhandene data (aus get gespeichert), erneut, um es beizubehalten.

Schlägt mit einem „Vorlagen-Upgrade wird ausgeführt“ fehl Error, wenn die zugrunde liegende Form.io-Vorlage migriert wird – versuchen Sie es erneut, sobald sie abgeschlossen ist.

Beispiel

uip gov aops-policy update --identifier a1b2c3d4-0000-0000-0000-000000000001 --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

Datenform (--output json)

Die gleiche Form wie create, mit Code: "AopsPolicyUpdate".

uip Gov aops-policy löschen

Löschen Sie eine Governance-Richtlinie endgültig.

Hinweis:

Schlägt fehl, wenn die Richtlinie immer noch einem Mandanten/Benutzer/Gruppe zugewiesen ist. Führen Sie deployment tenant\|user\|group remove zuerst für jeden Betreff aus, und versuchen Sie es dann erneut.

Argumente

Name	Erforderlich	Zweck
<policyIdentifier>	ja	Richtlinien-GUID von list.

Beispiel

uip gov aops-policy delete a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)

{ "Code": "AopsPolicyDelete", "Data": { "Status": "Deleted", "identifier": "a1b2c3d4-0000-0000-0000-000000000001" } }

uip Gov aops-policy-Produkt

Schreibgeschützter Katalog von Produkten, die Governance-Vorlagen veröffentlichen. Verwenden Sie, um gültige --product-name -Werte zu erkennen.

UIP Gov aops-policy-Produktliste

Beispiel

uip gov aops-policy product list

Datenform (--output json)

{
  "Code": "AopsProductList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" }
  ]
}

name ist das, was die Einträge policy create --product-name, template get <productIdentifier> und deployment ... configure erwarten; label ist der Anzeigename.

Abrufen des aops-policy-Produkts

Argumente

Name	Erforderlich	Zweck
<productIdentifier>	ja	Produktname (z. B StudioX) oder GUID – entweder name oder identifier von product list.

Beispiel

uip gov aops-policy product get StudioX

Datenform (--output json)

{ "Code": "AopsProductGet", "Data": { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" } }

uip gov aops-policy-Lizenztyp

Schreibgeschützter Katalog von Lizenztypen (z. B. Attended, Unattended) – Wird verwendet, um deployment tenant configure -Einträge und als <license-type> -Argument für deployed-policy get/list zu erstellen.

uip gov aops-policy-Lizenztypliste

Beispiel

uip gov aops-policy license-type list

Datenform (--output json)

{
  "Code": "AopsLicenseTypeList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A1", "name": "Attended" },
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A2", "name": "Unattended" }
  ]
}

identifier feeds deployment tenant configure Einträge; Die Anzeige name wird von deployed-policy get/list als <license-type> akzeptiert.

Vorlage für die UiPath aops-Richtlinie

Generiert die ausfüllbare Formulardaten- Blaupause (und eine visuell lesbare Referenz) aus der Form.io-Richtlinienvorlage eines Produkts – der Quelle der data -Nutzlast einer Richtlinie.

Abrufen der aops-Richtlinienvorlage für die UIP-gov-Richtlinie

Rufen Sie die aktive Form.io-Vorlage für ein Produkt ab und geben Sie Richtlinienartefakte aus.

Argumente

Name	Erforderlich	Zweck
<productIdentifier>	ja	Produktname oder -kennung (z. B StudioX).

Optionen

Long	Wert	Beschreibung
--output-form-data <path>	Pfad	Schreiben Sie das ausfüllbare Form-Data Blueprint-JSON – das Objekt, das Sie bearbeiten und am create/update zurücksenden. Nur-Anzeige-Komponenten (ausgeblendet, Schaltfläche, Senden, HTML, Inhalt) werden übersprungen; fehlende Blätter erhalten typisierte Standardeinstellungen (false für Kontrollkästchen, [] für EditGrid, {} für Auswahlfelder, null für Text/Auswahl).
--output-template-locale-resource <path>	Pfad	Schreiben Sie eine lokal aufgelöste, visuell lesbare Referenz: Jeder Gebietsschemaschlüssel im Produktbereich wird durch seine englische Zeichenfolge ersetzt (mit einem gleichgeordneten <prop>-key, der das Original beibehält), und defaultData.data wird zu einer einfachen Karte mit Anmerkungen ({ value, type, label, description?, tooltip? }). Produktübergreifende Präfixe (z. B. AutomationOps.submit) bleiben ungelöst.

Wenn keines der Flags --output-* übergeben wird, werden stattdessen sowohl die Vorlage als auch die Formulardaten in der Standardnutzlast Data zurückgegeben.

Beispiel

uip gov aops-policy template get StudioX --output-form-data form-data.json --output-template-locale-resource reference.json

Datenform (--output json)

{
  "Code": "AopsPolicyTemplateGet",
  "Data": {
    "formDataFile": "/Users/alice/aops/form-data.json",
    "templateLocaleResourceFile": "/Users/alice/aops/reference.json"
  }
}

Wenn kein --output-* -Flag übergeben wird, enthält Data stattdessen direkt template (das rohe Form.io-DTO) und formData (die Blaupause) – beide behalten ihre native Form.io-Schlüsselgröße bei, anstatt in PascalCased zu sein formData Roundflows in create/update --input Verbatim.

Ein UnsupportedTemplateComponentError (die Produktvorlage verwendet einen Komponententyp, den die CLI nicht konvertieren kann) schlägt mit ErrorCode: "configuration_error" und Retry: "RetryWillNotFix" fehl – erstellen Sie die Richtlinie data in diesem Fall manuell.

uip Gov aops-policy-Vorlagenliste

Rufen Sie die Vorlage jedes Produkts ab und geben Sie einen vollständigen Artefaktsatz pro Produkt ab – verwenden Sie ihn anstelle von template get-Schleifen.

Optionen

Long	Wert	Erforderlich	Beschreibung
--output-dir <path>	Pfad	ja	Verzeichnis, unter dem ein Ordner <ProductName>/ pro Produkt (enthält form-template.json, form-data.json, form-template-locale-resource.json) erstellt wird.

Fehler pro Produkt werden gesammelt und brechen die Ausführung nicht ab – der Befehl wird nur dann beendet, wenn jedes Produkt fehlschlägt.

Beispiel

uip gov aops-policy template list --output-dir ./aops-templates

Datenform (--output json)

{
  "Code": "AopsPolicyTemplateList",
  "Data": {
    "outputDir": "/Users/alice/aops-templates",
    "results": [
      {
        "productName": "StudioX",
        "status": "Success",
        "templateFile": "/Users/alice/aops-templates/StudioX/form-template.json",
        "formDataFile": "/Users/alice/aops-templates/StudioX/form-data.json",
        "templateLocaleResourceFile": "/Users/alice/aops-templates/StudioX/form-template-locale-resource.json"
      }
    ]
  }
}

Der Eintrag eines fehlgeschlagenen Produkts hat status: "Failure" und ein message -Feld anstelle der drei Dateipfade.

Zugehörig

• uip gov – Toolübersicht und Zugriffsrichtlinien.
• aops-policy deployment und deployed-policy – weisen Richtlinien zu Mandanten/Benutzern/Gruppen zu, lösen die effektive Richtlinie auf.
• compliance-packs – bündeln Sie Richtlinien in einem benannten Framework.

Siehe auch

• Tools (Plugins)
• Globale Optionen
• Exitcodes