Argomento
Questo articolo descrive come utilizzare l'automazione, la CLI e l'API con la funzionalità Documentazione di NinjaOne.
Ambiente
NinjaOne Documentation
Descrizione
Seleziona una categoria per ulteriori informazioni:
Script
- Vai su Amministrazione > Libreria > Automazione > Aggiungi > Nuovo script.
- Da qui è possibile accedere agli snippet personalizzati di NinjaOne. Gli snippet personalizzati sono elementi costitutivi degli script che dicono "leggi questo" o "scrivi questo" e aiutano a creare 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 visualizzare il menu dei frammenti.
Ora, quando esegui lo script su un dispositivo (tramite Script pianificato o ad hoc), puoi ottenere automaticamente le informazioni dalla Documentazione di riferimento.
CLI
I campi della Documentazione possono essere letti tramite la CLI; ciò include la possibilità di passare HTML attraverso la CLI per impostare il valore dei campi WYSIWYG. Per informazioni più dettagliate sullo scripting e sulla Documentazione, consulta Campi personalizzati e Documentazione: CLI e Scripting. Per ulteriori informazioni su WYSIWYG HTML, consulta WYSIWYG: HTML supportato e Stile in linea.
Di seguito è riportato un esempio dell'interfaccia relativa alla Documentazione per Windows CLI:
templates - ottiene l'elenco dei modelli, che contiene 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>" "<nome documento>" <nome attributo> - ottiene l'attributo dal documento in base al nome del documento e all'ID/nome del modello (virgolette obbligatorie)
get "<nome modello singolo>" <nome attributo> - ottiene 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 valori separati da virgole>" - 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 valori separati da virgole>" - 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 (effettivo per gli attributi con menu a discesa e selezione multipla)
org-options "<nome modello singolo>" <nome attributo> - ottiene l'elenco dei valori validi per il nome dell'attributo del singolo documento in base al nome del modello (effettivo per gli attributi con menu a discesa e selezione multipla)
È possibile accedervi anche tramite l'interfaccia PowerShell su Windows, che è:
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" "nuovo valore"
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 NinjaOne.