política-aops de uip gov

Sintaxis y opciones para la política CRUD de `uip gov aops-policy`, el catálogo de productos, el catálogo de tipos de licencia y los comandos de plantilla de Form.io.

uip gov aops-policy gestiona las políticas de gobernanza de UiPath AOps: reglas de configuración del producto (por ejemplo, una política de StudioX que restringe qué ajustes del proyecto están permitidos) creadas como un formulario Form.io rellenado y asignadas a través de tenants/usuarios/grupos. Esta página cubre la parte de creación: el propio registro de política (list/get/create/update/delete), más los catálogos de referencia de solo lectura (product, license-type) y los comandos template que generan el proyecto de datos de formulario rellenable a partir del cual se crea la carga útil data de una política. Para asignar una política a un asunto y resolver lo que realmente se aplica en tiempo de ejecución, consulta aops-policy deployment y deployed-policy. Para obtener la descripción general de la herramienta principal y las Políticas de acceso, consulta uip gov.

Nota:

Flujo típico: template get <product> → edita el form-data.json emitido → policy create --product-name <product> --name <name> --input form-data.json → deployment tenant configure (o usuario/grupo) para implementarlo.

Sinopsis

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>

Cada verbo también acepta --login-validity <minutes> para anular la vida útil del token de inicio de sesión interactivo para esa llamada (rara vez es necesario).

lista de políticas de aops de uip gov

Enumera las políticas de control, con filtrado y paginación opcionales. Devuelve los metadatos de la política (identificador, nombre, producto, prioridad, disponibilidad), no el blob data de la política.

Opciones

Largo	Valor	Descripción
--product-name <product-name>	String	Restringir a un producto (p. ej. StudioX). Coincide con product.name: consulta product list.
--product-label <productLabel>	String	Restringir a un producto por etiqueta de visualización (por ejemplo 'Studio X'). Prefiere --product-name para la creación de scripts.
--search <searchTerm>	String	Coincidencia de subcadena que no distingue entre mayúsculas y minúsculas con el nombre/descripción de la política.
--sort-by <field>	String	Campo por el que ordenar (p. ej. name, createdOn, priority). Pasado a través de la API de control.
--sort-order <direction>	asc | desc	Ordenar dirección para --sort-by. No distingue entre mayúsculas y minúsculas; cualquier otro valor falla en el lado del cliente.
--limit <n>	Entero	Tamaño de la página. Predeterminado 20.
--offset <n>	Entero	Índice de página de base cero.

Ejemplo

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

Forma de datos (--json de salida)

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

uip gov aops-policy get

Obtener una política por identificador, incluida su carga útil completa data (el plano de datos del formulario rellenado). Utilízalo para inspeccionar los valores enviados o para iniciar un update de seguimiento.

Argumentos

Nombre	Obligatorio	Propósito
<policyIdentifier>	Sí	GUID de política, desde list.

Ejemplo

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

Forma de datos (--json de salida)

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

Las claves de data se mantienen exactamente como aparecen en el formulario Form.io (camelCase/kebab-case), no PascalCased: esta carga útil está diseñada para ir de ida y vuelta a update --input sin modificar.

creación de política de aops de uip gov

Crea una nueva política de control para un producto.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre de la política legible por humanos (único dentro del producto).
--product-name <product-name>	String	Sí	Producto de destino (p. ej. StudioX, AITrustLayer): debe coincidir con un nombre de product list.
--description <description>	String	No	La descripción de texto libre apareció en la IU de control.
--priority <n>	Entero	No	Cuando se aplican varias políticas al mismo asunto, ganan los números más altos.
--availability <n>	Entero	No	Marca de disponibilidad (enumeración específica del producto): consulta la IU de control o los documentos de servicio para obtener valores válidos.
--input <path>	Ruta	No	JSON con el objeto de datos del formulario rellenado (de template get --output-form-data). Omitir para una política sin carga útil de datos.

Ejemplo

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

Forma de datos (--json de salida)

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

La respuesta se hace eco del blob de datos sin procesar (doble ajuste), no de la forma aplanada que devuelve get: utiliza get para producir datos de formulario para un update --input de seguimiento.

actualización de la política de aops de uip gov

Reemplaza los campos de una política existente. Actualización completa, no un parche : cada campo que quieras mantener debe pasarse de nuevo; omitir --description/--priority/--availability/--input borra ese campo en el servidor.

Opciones

Largo	Valor	Obligatorio	Descripción
--identifier <identifier>	GUID	Sí	Política que se actualizará. Desde list/get.
--name <name>	String	Sí	Nombre de la política. Al pasar el nombre existente se conserva.
--product-name <product-name>	String	Sí	Debe coincidir con el producto existente de la política: no se admite cambiar el producto en la actualización.
--description <description>	String	No	Reemplazo completo: vuelve a pasar el valor existente de get para conservarlo.
--priority <n>	Entero	No	Reemplazo completo: vuelve a pasar el valor existente para conservarlo.
--availability <n>	Entero	No	Reemplazo completo: vuelve a pasar el valor existente para conservarlo.
--input <path>	Ruta	No	Reemplazo completo: vuelve a pasar el data existente (guardado de get) para conservarlo.

Falla con una "actualización de plantilla en curso" si se está migrando la plantilla Form.io subyacente: vuelve a intentarlo una vez que se complete.

Ejemplo

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

Forma de datos (--json de salida)

La misma forma que create, con Code: "AopsPolicyUpdate".

uip gov aops-policy eliminar

Eliminar de forma permanente una política de control.

Nota:

Falla si la política sigue asignada a cualquier tenant/usuario/grupo. Ejecute deployment tenant\|user\|group remove en cada asunto primero y luego vuelva a intentarlo.

Argumentos

Nombre	Obligatorio	Propósito
<policyIdentifier>	Sí	GUID de política, desde list.

Ejemplo

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

Forma de datos (--json de salida)

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

producto de política de aops de uip gov

Catálogo de solo lectura de productos que publican plantillas de control. Utilízalo para descubrir valores --product-name válidos.

lista de productos de política de aops de uip gov

Ejemplo

uip gov aops-policy product list

Forma de datos (--json de salida)

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

name es lo que esperan las entradas policy create --product-name, template get <productIdentifier> y deployment ... configure; label es el nombre para mostrar.

uip gov aops-policy producto get

Argumentos

Nombre	Obligatorio	Propósito
<productIdentifier>	Sí	Nombre del producto (por ejemplo StudioX) o GUID: name o identifier de product list.

Ejemplo

uip gov aops-policy product get StudioX

Forma de datos (--json de salida)

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

uip gov política-aops tipo-de-licencia

Catálogo de solo lectura de tipos de licencia (por ejemplo Attended, Unattended): se utiliza para determinar el ámbito de las entradas deployment tenant configure y como argumento <license-type> para deployed-policy get/list.

uip gov aops-policy lista de tipos de licencias

Ejemplo

uip gov aops-policy license-type list

Forma de datos (--json de salida)

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

Las identifier fuentes deployment tenant configure entradas; la visualización name es lo que deployed-policy get/list acepta como <license-type>.

plantilla de política de aops de uip gov

Genera el plano de datos del formulario rellenable (y una referencia legible por humanos) a partir de la plantilla de política Form.io de un producto: el origen de la carga útil data de una política.

obtención de la plantilla aops-policy de uip gov

Obtenga la plantilla Form.io activa para un producto y emita artefactos de política.

Argumentos

Nombre	Obligatorio	Propósito
<productIdentifier>	Sí	Nombre o identificador del producto (por ejemplo StudioX).

Opciones

Largo	Valor	Descripción
--output-form-data <path>	Ruta	Escribe el JSON del plano de datos del formulario rellenable: el objeto que editas y envías de nuevo en create/update. Se omiten los componentes de solo visualización (oculto, botón, envío, HTML, contenido); las hojas que faltan obtienen valores predeterminados apropiados para el tipo (false para casilla de verificación, [] para editgrid, {} para cuadros de selección, null para texto/selección).
--output-template-locale-resource <path>	Ruta	Escribe una referencia legible por humanos resuelta por la configuración regional: cada clave de configuración regional del producto se reemplaza por su cadena en inglés (con un hermano <prop>-key que conserva el original) y defaultData.data se convierte en un mapa anotado plano ({ value, type, label, description?, tooltip? }). Prefijos de productos cruzados (por ejemplo AutomationOps.submit) quedan sin resolver.

Si no se pasa ningún indicador --output-*, tanto la plantilla como los datos del formulario se devuelven en la carga útil de stdout Data.

Ejemplo

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

Forma de datos (--json de salida)

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

Cuando no se pasa ningún marcador --output-*, Data en su lugar contiene template (el DTO de Form.io sin procesar) y formData (el plano) directamente; ambos conservan su carcasa de clave nativa de Form.io en lugar de ser PascalCased, por lo que formData viajes de ida y vuelta a create/update --input palabra textual.

Una UnsupportedTemplateComponentError (plantilla de producto utiliza un tipo de componente que la CLI no puede convertir) falla con ErrorCode: "configuration_error" y Retry: "RetryWillNotFix": crea la política data a mano en ese caso.

lista de plantillas aops-policy de uip gov

Obtener la plantilla de cada producto y volcar un conjunto completo de artefactos por producto: utilizar en lugar de repetir template get.

Opciones

Largo	Valor	Obligatorio	Descripción
--output-dir <path>	Ruta	Sí	Directorio en el que se crea una carpeta <ProductName>/ por producto (que contiene form-template.json, form-data.json, form-template-locale-resource.json).

Los fallos por producto se recopilan y no abortan la ejecución: el comando sale distinto de cero solo si todos los productos fallan.

Ejemplo

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

Forma de datos (--json de salida)

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

La entrada de un producto fallido tiene status: "Failure" y un campo message en lugar de las tres rutas de archivo.

Relacionado

• uip gov : descripción general de la herramienta y políticas de acceso.
• aops-policy deployment y deployed-policy : asigna políticas a tenants/usuarios/grupos, resuelve la política efectiva.
• compliance-packs : agrupar políticas en un marco nombrado.

Ver también

• Herramientas (complementos)
• Opciones globales
• Códigos de salida