Argomento
Questo articolo descrive come utilizzare l'automazione, la CLI e l'API con la funzione Documentazione di NinjaOne.
Ambiente
Documentazione NinjaOne
Descrizione
È possibile utilizzare l'API pubblica di NinjaOne e il componente ninjarmm-cli per gestire i documenti e i modelli in NinjaOne.
Seleziona una categoria per saperne di più:
Script
- Vai su Amministrazione> Libreria > Automazione > Aggiungi > Nuovo script.
- Da qui puoi accedere agli snippet personalizzati di NinjaOne. Gli snippet personalizzati sono elementi costitutivi all'interno degli script che dicono "leggi questo" o "scrivi questo", che aiutano nella creazione di uno script che interagisce con la Documentazione.
- Per iniziare, seleziona il linguaggio di programmazione desiderato, il sistema operativo e l'architettura. Usa Ctrl + Spazio per aprire il menu degli snippet.
Ora, quando esegui lo script su un dispositivo (tramite Attività pianificata, Script pianificato o ad hoc), puoi far sì che le informazioni vengano estratte automaticamente dalla Documentazione di riferimento.
CLI
I campi della Documentazione possono essere letti tramite la CLI; ciò include la possibilità di passare l'HTML attraverso la CLI per impostare il valore dei campi WYSIWYG. Per informazioni più dettagliate sullo scripting e sulla Documentazione, consultare Campi personalizzati e Documentazione: CLI e scripting. Per ulteriori informazioni sull'HTML WYSIWYG, consultare WYSIWYG: HTML supportato e stile inline.
Di seguito è riportato un esempio dell'interfaccia relativa alla documentazione per la CLI di Windows:
templates - ottiene l'elenco dei modelli, che contengono documenti e attributi
documents "<template id/name>" - ottiene l'elenco dei documenti per modello in base all'ID o al nome (virgolette obbligatorie)
get "<template id/name>" "<document name>" <attribute name> - ottiene l'attributo dal documento in base al nome del documento e all'ID/nome del modello (virgolette obbligatorie)
get "<single template name>" <nome attributo> - recupera l'attributo da un singolo documento in base al nome del modello (virgolette obbligatorie)
org-set "<id/nome modello>" "<nome documento>" <nome attributo> "<valore attributo / elenco di valori separati da virgola>" - imposta l'attributo sul documento/attributo specificato in base al nome del documento e all'id/nome del modello (virgolette obbligatorie)
org-set "<nome modello singolo>" <nome attributo> "<valore attributo / elenco di valori separati da virgola>" - imposta l'attributo su un singolo documento/attributo in base al nome del modello (virgolette obbligatorie)
org-clear "<ID/nome modello>" "<nome documento>" <nome attributo> - cancella il valore del documento in base al nome del documento e all'ID/nome del modello (virgolette obbligatorie, rappresenta NULL)
org-clear "<nome modello singolo>" <nome attributo> - cancella il valore di un singolo documento in base al nome del modello (virgolette obbligatorie, rappresenta NULL)
org-options "<ID/nome modello>" "<nome documento>" <nome attributo> - ottiene l'elenco dei valori validi per il nome dell'attributo del documento in base al nome del documento e all'ID/nome del modello (valido per attributi a discesa e a selezione multipla)
org-options "<nome modello singolo>" <nome attributo> - ottiene l'elenco dei valori validi per il nome dell'attributo di un singolo documento in base al nome del modello (valido per attributi a discesa e a selezione multipla)
È possibile accedervi anche tramite l'interfaccia PowerShell su Windows, ovvero:
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
I campi della documentazione possono essere creati e aggiornati tramite endpoint API pubblici con autenticazione client_credential e consentono l'integrazione di servizi di terze parti. Per ulteriori informazioni, consulta Operazioni API pubbliche di NinjaOne.