uip o carpetas

Sintaxis y opciones para `uip o carpetas`, que gestiona los contenedores de carpetas jerárquicas que abarcan los recursos y permisos de Orchestrator.

gestiona uip or folders carpetas de Orchestrator: los contenedores jerárquicos que abarcan procesos, trabajos, activos, colas y permisos de usuario. Los verbos cubren el listado, la creación, el movimiento, la edición y la eliminación de carpetas, además de un comando runtimes que informa de la asignación de tiempo de ejecución de la máquina dentro de una carpeta.

Sinopsis

uip or folders <verb> [options]

Verbos

Verbo	Propósito
list	Enumerar carpetas. Predeterminado: carpetas a las que puede acceder el usuario actual; --all, cada carpeta del tenant.
create	Crea una carpeta, opcionalmente anidada bajo una carpeta principal.
get	Obtener una carpeta por clave o ruta.
delete	Eliminar una carpeta por clave o ruta.
move	Cambiar el origen de una carpeta o moverla a la raíz.
edit	Actualizar el nombre para mostrar y/o la descripción.
runtimes	Muestra la asignación de runtime (total/conectado/disponible) por tipo de runtime para una carpeta.

uip o lista de carpetas

Enumerar carpetas. La vista predeterminada utiliza GetAllForCurrentUser : carpetas a las que tiene acceso la persona que llama. Con --all, el verbo cambia al punto final Folders completo (carpetas Estándar y Solución en el tenant); con --type personal, cambia al punto final PersonalWorkspaces . Los marcadores de filtrado y clasificación (--name, --path, --type, --top-level, --order-by) requieren --all.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-a	--all	Marca	Desactivado	Enumerar todas las carpetas del tenant; necesario para habilitar los siguientes indicadores de filtro y ordenación.
-n	--name	text	—	Contiene coincidencia en el nombre para mostrar. Requiere --all.
—	--path	Prefijo de ruta	—	Filtrar por prefijo de ruta de carpeta (por ejemplo, Shared coincide con Shared y todo lo siguiente). Requiere --all.
—	--type	ENUM	—	standard, solution o personal. Requiere --all. personal cambia al punto final de espacios de trabajo personales.
—	--top-level	Marca	Desactivado	Solo carpetas raíz (sin carpeta principal). Requiere --all. No compatible con --type personal.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--order-by	Campo	—	Ordenación de OData (por ejemplo, Name asc). Requiere --all.
—	--login-validity	minutos	10	Minutos mínimos antes de la caducidad del token que desencadena una actualización de solicitud previa.

Ejemplos

# Folders the authenticated user can access
uip or folders list

# All tenant folders, filtered and sorted
uip or folders list --all --type standard --name "Prod" --order-by "Name asc"

# Personal workspaces only
uip or folders list --all --type personal

Forma de datos (--json de salida)

{
  "Code": "FolderList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Shared",
      "Path": "Shared",
      "Description": "",
      "Type": "Standard",
      "ParentKey": ""
    }
  ]
}

Con --all, los elementos también incluyen FeedType y PermissionModel. Con --type personal, la carga útil es { Key, Name, OwnerName, OwnerKey, LastLogin }.

crear uip o carpetas

Crea una carpeta, opcionalmente anidada bajo una carpeta principal. --parent acepta un GUID de carpeta o una ruta (Shared, Production/EU).

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre para mostrar de la carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-d	--description	text	—	Descripción de la carpeta.
-p	--parent	clave o ruta	—	Carpeta principal por GUID o ruta. Omitir para una carpeta raíz.
—	--feed-type	ENUM	Processes	Processes, Libraries, FolderHierarchy.
—	--permission-model	ENUM	FineGrained	FineGrained o InheritFromTenant.
—	--provision-type	ENUM	Automatic	Automatic o Manual.

Ejemplos

uip or folders create "Staging"

uip or folders create "EU" --parent "Production" \
    --description "European workloads"

uip or folders create "Libraries" --feed-type Libraries \
    --permission-model InheritFromTenant

Forma de datos (--json de salida)

{
  "Code": "FolderCreated",
  "Data": {
    "Name": "Staging",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Created successfully"
  }
}

uip o carpetas obtener

Obtener una carpeta por clave o ruta. El argumento posicional detecta automáticamente: la entrada de UUID se trata como una clave, cualquier otra cosa como una ruta.

Argumentos

Nombre	Obligatorio	Propósito
<folder-key-or-path>	Sí	GUID o ruta de la carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.

Ejemplos

uip or folders get "Shared"
uip or folders get a1b2c3d4-0000-0000-0000-000000000001
uip or folders get "Shared/Staging" --output-filter 'Data.Key'

Forma de datos (--json de salida)

{
  "Code": "FolderGet",
  "Data": {
    "Name": "Shared",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Description": "No description",
    "Path": "Shared",
    "ParentID": "Root",
    "FolderType": "Standard",
    "IsPersonal": "No",
    "ProvisionType": "Automatic",
    "PermissionModel": "FineGrained",
    "FeedType": "Processes"
  }
}

uip o eliminación de carpetas

Eliminar una carpeta por clave o ruta. Falla si la carpeta contiene entidades o asociaciones de usuarios: elimina o mueve el contenido primero.

Argumentos

Nombre	Obligatorio	Propósito
<folder-key-or-path>	Sí	GUID o ruta de la carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.

Ejemplos

uip or folders delete "Shared/Staging"
uip or folders delete a1b2c3d4-0000-0000-0000-000000000010
uip or folders delete "Shared/Staging" --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "FolderDelete",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Path": "Shared/Staging",
    "Status": "Deleted successfully"
  }
}

mover uip o carpetas

Mover una carpeta a una nueva carpeta principal o hasta la raíz. Debe proporcionar exactamente uno de --parent o --root.

Argumentos

Nombre	Obligatorio	Propósito
<folder-key-or-path>	Sí	GUID de la carpeta o ruta que se va a mover.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-p	--parent	clave o ruta	—	Nueva carpeta principal. Obligatorio a menos que se establezca --root .
—	--root	Marca	Desactivado	Mover al nivel superior (sin principal).

Ejemplos

uip or folders move "Shared/Staging" --parent "Production"
uip or folders move a1b2c3d4-0000-0000-0000-000000000010 --root
uip or folders move "Shared/Staging" --parent "Production" \
    --output-filter 'Data.TargetParentPath'

Forma de datos (--json de salida)

{
  "Code": "FolderMove",
  "Data": {
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "FolderPath": "Shared/Staging",
    "TargetParentPath": "Production",
    "Status": "Moved successfully"
  }
}

--root establece TargetParentPath en (root).

editar uip o carpetas

Actualizar el nombre para mostrar y/o la descripción. Se debe proporcionar al menos uno de --name o --description .

Argumentos

Nombre	Obligatorio	Propósito
<folder-key-or-path>	Sí	GUID o ruta de la carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.
-n	--name	text	—	Nuevo nombre para mostrar.
-d	--description	text	—	Nueva descripción.

Ejemplos

uip or folders edit a1b2c3d4-0000-0000-0000-000000000010 --name "Staging (EU)"
uip or folders edit "Shared/Staging" --description "Pre-prod runs"
uip or folders edit "Shared/Staging" --name "Staging (EU)" --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "FolderUpdate",
  "Data": { "Status": "Updated successfully" }
}

runtimes de uip o carpetas

Enumerar la asignación de runtime para una carpeta: para cada tipo de runtime, cuántas ranuras hay en total, conectadas y disponibles. Útil para comprobar la capacidad antes de iniciar trabajos.

Argumentos

Nombre	Obligatorio	Propósito
<folder-key-or-path>	Sí	GUID o ruta de la carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.

Ejemplos

uip or folders runtimes "Shared"
uip or folders runtimes a1b2c3d4-0000-0000-0000-000000000001
uip or folders runtimes "Shared" \
    --output-filter "Data[?Type=='Unattended'].Available | [0]"

Forma de datos (--json de salida)

{
  "Code": "FolderRuntimes",
  "Data": [
    { "Type": "Unattended", "Total": 4, "Connected": 3, "Available": 1 },
    { "Type": "NonProduction", "Total": 2, "Connected": 1, "Available": 1 }
  ]
}

Códigos de salida

Consulta Códigos de salida. Sin anulaciones específicas de verbos.

Comandos relacionados

• uip or processes : vinculaciones de procesos con ámbito de carpeta.
• uip or machines , especialmente machines assign / unassign para la pertenencia a carpetas.
• uip or users — users list-in-folder, users assign, users unassign.
• uip or roles : asignaciones de roles a nivel de carpeta.

Ver también

• Opciones globales.
• Sesiones : resolución de contexto de tenant y carpeta.