¿Ya eres cliente de NinjaOne? Inicia sesión para ver más guías y las últimas actualizaciones.

Interfaz de línea de comandos (CLI): campos compatibles y funcionalidad

Tema

Esta documentación describe el componente ninjarmm-clipara dispositivos Windows, Mac y Linux.

Entorno

  • Gestión de terminales de NinjaOne
  • Documentación de NinjaOne
  • Microsoft Windows 
  • macOS
  • Linux

Descripción

Este archivo es un ejecutable que puede utilizar para acceder e interactuar con campos personalizados concretos y datos de la documentación de NinjaOne desde la interfaz de línea de comandos (CLI), el Terminal o scripts personalizados. Consulte la interfaz de línea de comandos (CLI) en NinjaOne e Introducción a la biblioteca de automatización de NinjaOne (Scripting).

Selecciona una categoría para obtener más información: 

Acerca de los campos compatibles con la CLI

Ten en cuenta estas consideraciones al utilizar los campos compatibles con la CLI:

  • Utilice la CLI para establecer el ID de activo del dispositivo en cualquier valor compatible. 
  • Los campos seguros son de solo escritura para los campos de la documentación de NinjaOne. 
  • El sistema puede leer datos de documentación desde la CLI o scripts personalizados, o escribir datos de documentación en ellos. Puede obtener una lista de plantillas, una lista de documentos por nombre o ID de plantilla, y el valor de cada campo de un documento.
    • Solo se puede acceder a las plantillas o documentos que tengan al menos un campo rellenado a través de la CLI o de scripts personalizados. El sistema no muestra plantillas ni documentos vacíos.
  • Puede utilizar scripts personalizados escritos en Batch o PowerShell para Windows, o en ShellScript para macOS y Linux.
    • Dado que ninjarmm-cli.exe se encuentra en una carpeta protegida a la que los usuarios normales no tienen acceso, cualquier script que utilice esta funcionalidad debe ejecutarse como sistema (o deben modificarse los permisos en consecuencia).
  • Solo los dispositivos asignados como delegados pueden actualizar los campos de la documentación a través de la CLI o de scripts. Consulte Asignación de dispositivos como delegados de documentación para obtener más información. 
  • Los dispositivos leen el valor más cercano que se les ha asignado en función de la herencia con el siguiente flujo de trabajo: Dispositivo → usuario final asignado al dispositivo → ubicación del dispositivo → organización del dispositivo. 
    • Si el resultado de la herencia del dispositivo no tiene un valor, heredará el valor del usuario final. 
    • Si el resultado de la herencia del usuario final no tiene un valor, heredará el valor de la ubicación. 
    • Si el resultado de la herencia de la ubicación no tiene un valor, heredará el valor de la organización. 
    • Si el resultado de la herencia de la organización no tiene valor, el campo permanecerá vacío.

Campos personalizados y documentación Campos compatibles

La siguiente tabla resume qué campos admiten el acceso a través de la CLI y scripts personalizados.

CampoAcceso de lecturaAcceso de escritura
Archivo adjuntoX
Casilla de verificación
Fecha
Fecha y hora
Decimal
Menú desplegable de dispositivosX
Selección múltiple de dispositivosX
Menú desplegable
Correo electrónico
Número entero
Dirección IP
Multilínea
Selección múltiple
Menú desplegable de organizaciónX
Menú desplegable de ubicación de la organizaciónX
Selección múltiple de la ubicación de la organizaciónX
Selección múltiple de organizaciónX
Teléfono
Seguro✓*
Texto
Hora
WYSIWYG
URL 

Funcionalidades adicionales compatibles

La siguiente información trata sobre los campos calculados y la configuración avanzada.

Campos calculados

La herramienta CLI admite campos calculados, lo que le permite mostrar valores generados automáticamente a partir de otros datos. Por ejemplo, puede hacer algo como esto:

> ninjarmm-cli.exe set firstfield myvalue
myvalue
> ninjarmm-cli.exe get firstfield
myvalue
> ninjarmm-cli.exe get secondfield
othervalue
> ninjarmm-cli.exe set secondfield __firstfield__
myvalue
> ninjarmm-cli.exe get secondfield
myvalue
En el ejemplo anterior, establecemos el valor defirstfieldensecondfieldutilizando los símbolos especiales__firstfield__en la operación de establecimiento.

Configuración avanzada

La utilidad CLI puede gestionar ajustes avanzados, que se pueden definir al configurar los diferentes campos. Por ejemplo, puede definir rangos para números enteros, decimales, fechas, fechas y horas, y horas. 

Recursos adicionales

Consulte los siguientes recursos para obtener más información sobre los campos personalizados y la automatización en NinjaOne:

FAQ

Próximos pasos