Interfaz de línea de comandos del agente Kandji

Prev Next

El Kandji Agent ofrece un conjunto de potentes comandos de Terminal que brindan a los administradores control e información adicionales para su flota de dispositivos. Si bien algunos comandos solo se pueden ejecutar localmente en un dispositivo que usa Terminal, otros se pueden implementar a través de un Library Item de script personalizado para una mayor flexibilidad.

Comandos de solo local

Los siguientes comandos deben ejecutarse directamente en un dispositivo en Terminal. No se pueden implementar a través de un script personalizado o un Custom App Library Item.

Correr

El agente se ejecutará y se registrará inmediatamente. Normalmente, el agente se registra cada 15 minutos. Sin una conexión a Internet, el agente se ejecutará en modo sin conexión.

sudo kandji run

Al agregar --reset-daily al comando run, se ejecutarán todas las Parameters, incluidas las que se ejecutan solo una vez al día.

sudo kandji run --reset-daily

Ejecutar diariamente MDM actualización de inventario

El agente solicitará al servidor de MDM que inicie sus comandos de MDM diarios, como validar Apps y Libros de Apple Business Manager, así como consultar cierta información del dispositivo.

sudo kandji update-mdm

Recopilar aplicaciones

Recopila el inventario completo de aplicaciones del Mac.

sudo kandji collect-apps

Ejecutar Library Items

Comprueba los elementos de biblioteca que se van a ejecutar.

sudo kandji library

Opciones de comandos de biblioteca disponibles:

Opción

Descripción

--list

Enumere todos los elementos de biblioteca asignados al equipo.

--state

Obtenga el estado actual del administrador de bibliotecas de Kandji Agent .

--item

Ejecutar un elemento de biblioteca específico por nombre o ID de elemento de biblioteca; especifique -F para forzar la ejecución.

--cancel

Cancela el elemento de biblioteca que se está ejecutando actualmente y borra la cola actual.

Imprimir registros de Kandji

Imprime entradas de registro para el subsistema de Kandji Agent desde el sistema de registro unificado. La opción '--last' es obligatoria y especifica el número de segundos anteriores desde los que se imprimirán los registros. Reemplace <segundos> por un número, como 300. (Los resultados reales que se muestran están limitados en función del almacenamiento de registros unificado disponible).

Redirija la salida del comando mediante > para guardarlo en un archivo de registro externo.

sudo kandji logs --last <seconds>

Opciones de comando de registros disponibles:

Opción

Descripción

--no-format

Imprima entradas de registro sin formato de color ANSI.

--debug

Incluye registros de nivel de depuración, el registro de depuración debe estar habilitado antes.

Habilite el registro de depuración.

sudo log config --mode "level:debug" --subsystem io.kandji.KandjiAgent

Deshabilite el registro de depuración.

sudo log config --mode "level:default" --subsystem io.kandji.KandjiAgent

Ejemplo de uso del comando de registro de depuración.

sudo kandji logs --no-format --debug --last 10000 >~/Desktop/kandji.log

Evitar

Enumerar los archivos en cuarentena.

sudo kandji avert --list-quarantine

Eliminar archivos en cuarentena.

sudo kandji avert --delete-quarantine

Comandos programables

Estos comandos se pueden ejecutar a través de un script personalizado o un Custom App Library Item. También se pueden ejecutar localmente en una Mac en Terminal.

Al utilizar las siguientes opciones de scripts, como dentro de un Library Itemde script personalizado, debe reemplazar sudo kandji con la ruta completa al binario: /usr/local/bin/kandji

Reiniciar

Esta opción se puede utilizar en flujos de trabajo con scripts para forzar un reinicio aprovechando la aplicación de Kandji Agent y barra de menús. Es visualmente similar al reinicio forzado durante la habilitación de FileVault o una actualización Managed OS .

Esto inicia un reinicio solicitando al usuario que ha iniciado sesión un temporizador de cuenta regresiva. Si no se especifica ningún retraso, se utilizará el valor predeterminado 1800 (30 minutos). Si ningún usuario ha iniciado sesión, el retraso se ignorará y el Mac se reiniciará inmediatamente.

sudo kandji reboot --delaySeconds NumberOfSeconds

Fuerza un reinicio sin dar a los usuarios la opción de retrasarlo.

sudo kandji reboot --no-deferral 

Dársena

Esta opción se puede utilizar en flujos de trabajo con scripts para agregar elementos al final del Dock de macOS o eliminar elementos del Dock de macOS del usuario que ha iniciado sesión actualmente.

La aplicación a la que hace referencia el identificador de paquete debe estar en la carpeta /Applications.

Opcionalmente, si se especifica la opción --all , se agrega el icono al final del Dock para todas las cuentas de usuario.

sudo kandji dock [--add bundle identifier] [--remove bundle identifier] [--all]

Si usa varias opciones a la vez, use un solo comando y separe las opciones usando comillas y espacios separados, como se muestra en el ejemplo a continuación.

/usr/local/bin/kandji dock --add "com.google.Chrome us.zoom.xos com.tinyspeck.slackmacgap"

Alerta

Este comando se puede utilizar en flujos de trabajo con scripts para presentar una alerta a los usuarios.

sudo kandji display-alert [--title text] [--message text] [--icon path_to_image] [--suppression-key string] [--help-url url] [--no-wait]

Tiene varias opciones, que se describen a continuación.

Opción

Descripción

Predeterminado si no se proporciona

--title

Especifica un título personalizado para la ventana de alerta

"Alerta"

--message

Especifica un mensaje personalizado para la ventana de alerta

No hay valor predeterminado

--icon

Especifica un icono personalizado para la ventana de alerta. Se recomienda utilizar archivos .jpg, .png o .icns

Icono de Kandji Agent

--suppression-key

Si se proporciona, mostrará una opción al usuario: "No volver a mostrar este mensaje"

Si esta clave de supresión se proporciona en una alerta futura y el usuario opta por no volver a verla, la alerta no se mostrará.

No hay valor predeterminado

Si no se especifica ninguna clave de supresión, no se muestra la opción "No volver a mostrar este mensaje".

--help-url

Permite especificar una dirección URL personalizada para el botón de ayuda de alerta.

Debe ser una URL HTTPS

No hay valor predeterminado

Si no se especifica ninguna dirección URL, no se muestra el botón Ayuda.

--no-wait

Permite que se muestre la alerta, pero mantiene el resto del script en ejecución sin esperar la interacción del usuario en la alerta

La alerta se mostrará y esperará la interacción del usuario antes de que el script continúe.


A continuación se muestra un ejemplo del comando subyacente para una alerta y la experiencia resultante en macOS Sequoia:

sudo /usr/local/bin/kandji display-alert --title "Low Disk Space" --message "Your Mac computer's Hard Drive is running critically low on space, please contact Accuhive IT as soon as possible." --suppression-key accuhive --help-url https://kandji.io --no-wait

Enviar diagnósticos

Enviar diagnósticos a Kandji. Equivalente al elemento del menú de acción (equipo) disponible en el menú Kandji .

sudo kandji submit-diagnostics [--comment text]

Opción de comando submit-diagnostics disponible:

Opción

Descripción

Predeterminado si no se proporciona

--comment

Especifica un comentario que se presentará en el diagnóstico

No hay valor predeterminado

Versión

Muestra la versión de Kandji Agent instalada.

sudo kandji version

Ayuda

Mostrar texto de ayuda.

sudo kandji help