Tema
Este artículo describe cómo utilizar la automatización, la CLI y la API con la función de documentación de NinjaOne.
Entorno
Documentación de NinjaOne
Descripción
Puedes utilizar la API pública de NinjaOne y el componente ninjarmm-cli para gestionar tus documentos y plantillas en NinjaOne.
Selecciona una categoría para obtener más información:
Scripts
- Ve a Administración> Biblioteca > Automatización > Añadir > Nuevo script.
- Desde aquí puedes acceder a los fragmentos personalizados de NinjaOne. Los fragmentos personalizados son bloques de construcción dentro de los scripts que indican «lee esto» o «escribe esto», lo que facilita la creación de un script que interactúe con la documentación.
- Para empezar, selecciona el lenguaje de programación que prefieras, el sistema operativo y la arquitectura. Utiliza Ctrl + Espacio para abrir el menú de fragmentos.
Ahora, cuando ejecutes el script en un dispositivo (ya sea mediante una tarea programada, un script programado o de forma ad hoc), podrás obtener información automáticamente de la documentación a la que se hace referencia.
CLI
Los campos de la Documentación se pueden leer a través de la CLI; esto incluye la posibilidad de pasar código HTML a través de la CLI para establecer el valor de los campos WYSIWYG. Para obtener información más detallada sobre la creación de scripts y la Documentación, consulta «Campos personalizados y Documentación: CLI y creación de scripts». Para obtener más información sobre el HTML WYSIWYG, consulta «WYSIWYG: HTML compatible y estilos en línea».
A continuación se muestra un ejemplo de la interfaz relacionada con la documentación para la CLI de Windows:
templates: obtiene la lista de plantillas, que contienen documentos y atributos
documents "<id/nombre de la plantilla>": obtiene la lista de documentos de una plantilla por su id o nombre (se requieren comillas)
get "<id/nombre de la plantilla>" "<nombre del documento>" <nombre del atributo>: obtiene un atributo de un documento por su nombre y el id/nombre de la plantilla (se requieren comillas)
get "<nombre de una sola plantilla>" <nombre del atributo>: obtener un atributo de un documento concreto por el nombre de la plantilla (se requieren comillas)
org-set "<id/nombre de la plantilla>" "<nombre del documento>" <nombre del atributo> "<valor del atributo / lista de valores separados por comas>": establecer un atributo en el documento/atributo especificado por el nombre del documento y el id/nombre de la plantilla (se requieren comillas)
org-set "<nombre de una plantilla concreta>" <nombre del atributo> "<valor del atributo / lista de valores separados por comas>" - establece el atributo en un único documento/atributo mediante el nombre de la plantilla (se requieren comillas)
org-clear "<id/nombre de la plantilla>" "<nombre del documento>" <nombre del atributo>: borra el valor de un documento por nombre de documento e ID o nombre de la plantilla (se requieren comillas; se representa como NULL)
org-clear "<nombre de una plantilla>" <nombre del atributo>: borra el valor de un documento concreto por nombre de plantilla (se requieren comillas; se representa como NULL)
org-options "<ID o nombre de la plantilla>" "<nombre del documento>" <nombre del atributo>: obtiene la lista de valores válidos para el nombre de un atributo del documento mediante el nombre del documento y el ID o nombre de la plantilla (aplicable a atributos de menú desplegable y de selección múltiple)
org-options "<nombre de una plantilla concreta>" <nombre del atributo>: obtiene la lista de valores válidos para el nombre de un atributo de un documento concreto mediante el nombre de la plantilla (aplicable a atributos de menú desplegable y de selección múltiple)
También se puede acceder a esto mediante la interfaz de PowerShell en Windows, que es:
Ninja-Property-Docs-Templates
Ninja-Property-Docs-Names $TemplateId
Ninja-Property-Docs-Names "$TemplateName"
Ninja-Property-Docs-Get $TemplateId "$DocumentName" $AttributeName
Ninja-Property-Docs-Set $TemplateID "$DocumentName" $AttributeName
Ninja-Property-Docs-Get-Single "templateName" "fieldName"
Ninja-Property-Docs-Set-Single "templateName" "fieldName" "new value"
Ninja-Property-Docs-Clear
Ninja-Property-Docs-Options
API
Los campos de documentación se pueden crear y actualizar a través de puntos finales de la API pública con autenticación mediante «client_credential», lo que permite la integración de servicios de terceros. Para obtener más información, consulta Operaciones de la API pública de NinjaOne.