¿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-cli para dispositivos Windows, Mac y Linux.

Entorno

  • Gestión de puntos finales NinjaOne
  • NinjaOne Documentation
  • Windows 
  • MacOS
  • Linux

Descripción

Este archivo es un ejecutable que puede utilizar para acceder e interactuar con determinados campos personalizados y datos de Documentación NinjaOne desde la interfaz de línea de comandos (CLI), o Terminal, o scripts personalizados. Consulte Uso de la Interfaz de Línea de Comandos (CLI) en NinjaOne y Primeros pasos con la Biblioteca de Automatización de NinjaOne (Scripting).

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

Acerca de los campos compatibles con la CLI

Tenga en cuenta estas consideraciones cuando utilice campos compatibles con CLI:

  • Utilice la CLI para establecer el ID de activo del dispositivo en cualquier valor admitido. 
  • Los campos seguros son de sólo escritura para los campos de Documentación de NinjaOne. 
  • El sistema puede leer o escribir datos de documentación en la CLI o en scripts personalizados. Puede obtener una lista de plantillas, una lista de documentos por nombre de plantilla o ID, y el valor de cada campo de un documento.
    • Sólo las plantillas o documentos con al menos un campo rellenado son accesibles a través de la CLI o los scripts personalizados. El sistema no muestra plantillas o documentos vacíos.
  • Puede utilizar secuencias de comandos personalizadas escritas en Batch o PowerShell para Windows, o en ShellScript para macOS y Linux.
    • Dado que ninjarmm-cli.exe reside en una carpeta protegida inaccesible para los usuarios normales, cualquier script que utilice esta funcionalidad debe ejecutarse como sistema (o deben cambiarse los permisos en consecuencia).
  • Sólo los dispositivos asignados como delegados pueden actualizar los campos de Documentación mediante CLI o 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 asigna en función de la herencia con el flujo de trabajo de: 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 para el 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 para la organización no tiene valor, el campo permanecerá vacío.

Campos personalizados y documentación Campos admitidos

La siguiente tabla muestra los campos a los que se puede acceder mediante CLI y scripts personalizados.

CampoLeer AccesoAcceso de escritura
AdjuntoX
Casilla de verificación
Fecha
Fecha y hora
Decimal
Dispositivo desplegableX
Selección múltiple de dispositivosX
Desplegable
Correo electrónico
Entero
Dirección IP
Múltiples líneas
Selección múltiple
Organización desplegableX
Organización Ubicación desplegableX
Selección múltiple de ubicaciones de organizacionesX
Selección múltiple de organizacionesX
Teléfono
Seguro*
Texto
Tiempo
WYSIWYG
URL 

Características adicionales compatibles

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

Campos calculados

La herramienta CLI admite campos computados, lo que le permite mostrar valores generados automáticamente a partir de otros datos. Por ejemplo, puedes hacer algo así:

> 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 del campo primercampo al valor del segundocampo utilizando los símbolos especiales __ primercampo__ en la operación set.

Ajustes avanzados

La utilidad CLI puede gestionar ajustes avanzados, que pueden definirse al configurar los distintos 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