Tema
Este artículo describe cómo usar la automatización, la CLI y la API con la función Documentación de NinjaOne.
Entorno
NinjaOne Documentation
Descripción
Seleccione una categoría para aprender más:
Scripts
- Vaya a Administración > Biblioteca > Automatización > Añadir > Nuevo script.
- Desde aquí puede acceder a los fragmentos personalizados de NinjaOne. Los fragmentos personalizados son bloques de construcción dentro de scripts que dicen «leer esto» o «escribir esto», lo que ayuda a crear un script que interactúa con la Documentación.
- Para empezar, seleccione el lenguaje de programación, el sistema operativo y la arquitectura que desee. Utilice Ctrl + Espacio para abrir el menú de fragmentos.
Ahora, cuando ejecute el script en un dispositivo (ya sea mediante una tarea programada, un script programado o ad hoc), podrá obtener información automáticamente de la Documentación a la que se hace referencia.
CLI
Los campos de Documentación se pueden leer a través de la CLI; esto incluye permitir que HTML se pase a través de la CLI para establecer el valor de los campos WYSIWYG. Para obtener información más detallada sobre scripts y Documentación, consulte Campos personalizados y Documentación: CLI y scripts. Para obtener más información sobre WYSIWYG HTML, consulte WYSIWYG: HTML compatible y estilo en línea.
El siguiente es un ejemplo de la interfaz correspondiente a la Documentación para Windows CLI:
plantillas: obtiene la lista de plantillas, que tiene documentos y atributos
documentos "<id/nombre de la plantilla>" - obtiene la lista de documentos para la plantilla por id o nombre (se requieren comillas)
obtener "<id/nombre de la plantilla>" "<nombre del documento>" <nombre del atributo> - obtener el atributo del documento por nombre de documento e ID/nombre de plantilla (se requieren comillas)
obtener "<nombre de plantilla única>" <nombre del atributo> - obtener el atributo de un documento único por nombre de plantilla (se requieren comillas)
org-set "<ID/nombre de plantilla>" "<nombre del documento>" <nombre del atributo> "<valor del atributo / lista de valores separados por comas>" - establece el atributo en el documento/atributo especificado por nombre de documento y ID/nombre de plantilla (se requieren comillas)
org-set "<nombre de plantilla única>" <nombre de atributo> "<valor del atributo / lista de valores separados por comas>" - establece el atributo en un documento/atributo único por nombre de plantilla (se requieren comillas)
org-clear "<ID/nombre de plantilla>" "<nombre del documento>" <nombre del atributo> - borra el valor del documento por nombre de documento e ID/nombre de plantilla (se requieren comillas, se representa como NULL)
org-clear "<nombre de plantilla única>" <nombre del atributo> - borra el valor de un documento único por nombre de plantilla (se requieren comillas, se representa como NULL)
org-options "<ID/nombre de plantilla>" "<nombre del documento>" <nombre del atributo> - obtiene la lista de valores válidos para el nombre del atributo del documento por nombre de documento e ID/nombre de plantilla (real para atributos desplegables y de selección múltiple)
org-options "<nombre de plantilla única>" <nombre del atributo> - obtiene la lista de valores válidos para el nombre del atributo de un documento único por nombre de plantilla (real para atributos desplegables y de selección múltiple)
También se puede acceder a esto usando la interfaz 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 terminales API públicos con autenticación client_credential y permiten la integración de servicios de terceros. Para obtener más información, consulte Operaciones de la API pública de NinjaOne.