Command Line Interface (CLI): Campi personalizzati e script di documentazione

Argomento

Questa documentazione spiega come utilizzare il componente ninjarmm-cli per i sistemi operativi Microsoft Windows, Apple macOS e Linux.

Ambiente

• Gestione degli endpoint NinjaOne
• NinjaOne Documentation

Descrizione

Il componente ninjarmm-cli è un file eseguibile che consente di accedere e interagire con specifici campi personalizzati e dati di documentazione dall'interfaccia a riga di comando (CLI), dal terminale o da script personalizzati.

Selezionate una categoria per saperne di più:

• Note importanti
• Accesso ai campi protetti tramite le automazioni
• Interazione con i campi personalizzati tramite CLI o terminale di Windows
• Modulo PowerShell di NinjaOne
• Interazione con i campi personalizzati tramite i comandi della CLI di Windows, gli script personalizzati Batch, ShellScript su UNIX o gli script personalizzati ShellScript
• Interazione con i campi personalizzati tramite comandi PowerShell o script personalizzati
• Risorse aggiuntive

Note importanti

Prima di utilizzare ninjarmm-cli, è necessario considerare quanto segue:

• I campi protetti sono di sola scrittura per i campi di documentazione.
  • Per la ripartizione completa dei campi supportati, fare riferimento a Interfaccia della riga di comando (CLI) Campi e funzionalità supportati.
• È possibile leggere o scrivere i dati della documentazione nella CLI o negli script personalizzati. È possibile generare un elenco di modelli, un elenco dei documenti in base al nome del modello o al numero di identificazione e il valore di ciascun campo di un documento.
  • Gli script CLI o personalizzati possono accedere solo a modelli e documenti che contengono almeno un campo compilato. I modelli e i documenti vuoti non vengono visualizzati.
• È possibile utilizzare script personalizzati scritti in Batch o PowerShell per Windows, o in ShellScript per macOS e Linux. Poiché ninjarmm-cli.exe risiede in una cartella protetta inaccessibile agli utenti normali, è necessario eseguire qualsiasi script che utilizzi questa funzionalità come sistema, oppure modificare i permessi di conseguenza.
  • Le versioni 1 e 2 di PowerShell non sono supportate.
  • Per sapere quali campi supportano l'accesso tramite CLI e script personalizzati, fare riferimento a Campi e funzionalità supportati dall'interfaccia della riga di comando (CLI).
• Per i dispositivi Linux, è necessario aggiungere . / davanti a ninjarmm-cli nel terminale per eseguire correttamente il comando.
• Per i dispositivi Windows, se è necessario memorizzare l'output del comando ninjarmm-cli get in una variabile, si può usare il parametro opzionale --direct-out per forzare l'uso del canale di output standard stdout invece delle funzioni API di Windows come WriteConsoleW/WriteFile. Tuttavia, così facendo, si può potenzialmente perdere il supporto dell'output Unicode, che non funziona correttamente su alcune versioni di Windows con il canale stdout. Fare riferimento al seguente esempio di questo comando:

 ninjarmm-cli --direct-out get [field name]

Accesso ai campi protetti tramite le automazioni

Qualsiasi automazione eseguita dalla Libreria delle automazioni può accedere ai campi protetti, che includono:

• Condizioni dello script
• Condizioni del composto di script
• Attività programmate della politica
• Attività pianificate globali
• Eseguire prima delle azioni di backup, patching, installazione dell'applicazione e attività simili
• Eseguire le azioni successive al backup, al patching, all'installazione dell'applicazione e ad attività simili
• Azioni di automazione sulle condizioni
• Eseguire l'automazione

Alcune cose importanti da notare riguardo ai campi protetti sono:

• NinjaOne fornisce l'accesso ai campi personalizzati sicuri solo durante l'esecuzione dell'automazione.
• Il terminale web o il terminale locale non possono accedere ai campi personalizzati sicuri.
• Solo i comandi eseguiti da NinjaOne su un dispositivo locale possono accedere ai campi personalizzati, comprese le operazioni GET e SET, i campi sicuri personalizzati e i campi sicuri della documentazione. Tuttavia, i campi sicuri della documentazione utilizzano solo le operazioni SET tramite la CLI.

Interazione con i campi personalizzati tramite CLI o terminale di Windows

L'agente decomprime automaticamente questo eseguibile nelle seguenti cartelle:

• Windows: C:ProgramDataNinjaRMMAgentninjarmm-cli.exe
• macOS: /Applicazioni/NinjaRMMAgent/programdata/ninjarmm-cli
• Linux: /opt/NinjaRMMAgent/programdata/ninjarmm-cli

Per Windows, utilizzare la seguente variabile d'ambiente speciale a livello di sistema:

• Windows: %NINJARMMCLI% per C: ProgramDataNinjaRMMAgentninjarmm-cli.exe
• Linux: $NINJA_DATA_PATH/ninjarmm-cli set $nome campo $variabile

La CLI di NinjaRMM è simile al seguente esempio per Windows:

c:ProgramDataNinjaRMMAgentninjarmm-cli.exe help ninjarmm-cli - CLI tool to access and manage NinjaRMM Agent Custom Fields.Usage:  help - show this text Global and Role fields: get <attribute name> - get value of the attribute with specified name set <attribute name> <attribute value and comma-separated values list> - set value to the specified attribute   --stdin - optional modifier to use piped data. For example: dir | %NINJARMMCLI% set --stdin myfield options <attribute name> - get list of the valid values for attribute name (actual for drop-down and multi-select attributes) Documentation fields: templates - get a list of the templates, which have documents and attributes   --ids, --names - optional modifiers documents "<template id/name>" - get a list of the documents for the template by id or name (quotes required)   --ids, --names - optional modifiers get "<template id/name>" "<document name>" <attribute name> - get attribute from document by document name and template id/name (quotes required) get "<single template name>" <attribute name> - get attribute from single document by template name (quotes required) org-set "<template id/name>" "<document name>" <attribute name> "<attribute value and comma-separated values list>" - set attribute to the specified document/attribute by document name and template id/name (quotes required) org-set "<single template name>" <attribute name> "<attribute value and comma-separated values list>" - set attribute to single document/attribute by template name (quotes required) org-clear "<template id/name>" "<document name>" <attribute name> - clear value of document by document name and template id/name (quotes required, represents as NULL) org-clear "<single template name>" <attribute name> - clear the value of a single document by template name (quotes required, represents as NULL) org-options "<template id/name>" "<document name>" <attribute name> - get list of the valid values for document attribute name by document name and template id/name (actual for drop-down and multi-select attributes) org-options "<single template name>" <attribute name> - get a list of the valid values for a single document attribute name by template name (actual for drop-down and multi-select attributes) Output format: exit codes: 0 - Success, 1 - Error on success: exit with 0 and print value on error:   exit with 1 and print error description to read exit code: Win: 'echo %errorlevel%', Unix: 'echo $?' Attribute types:   CheckBox - Boolean type, acceptable values: 0, 1, true, false   Numeric - Integer type, values range from -2147483648 to 2147483647, supports Advanced Input filter settings.   Decimal - Float type, values range from -9999999.999999 to 9999999.999999, supports Advanced Input filter settings.   TextMultiLine, Text - regular string   TextEmail - regular string, should match RFC 5322 Email format   TextIpAddress - regular string, should match IPv4 or IPv6 format, supports Advanced Input filter settings   TextPhone - regular string, should match E.164 phone number format   TextEncrypted - regular encrypted string, supports Advanced Input filter settings (write-only for Documentation)   DateTime - Integer seconds since start of Unix epoch or ISO format 'yyyy-MM-ddTHH:mm: ss' without TimeZone (UTC)   Date - Integer seconds since start of Unix epoch or ISO format 'yyyy-MM-dd'   Time - Integer seconds or ISO format 'HH:mm:ss'   MultiSelect - list of unique options (view <options> command)   MultiSelectNode, MultiSelectClient, MultiSelectClientLocation - (read-only by CLI) organization-related data   Drop-down - one unique option (see <options> command)   DropdownNode, DropdownClient, DropdownClientLocation - (read-only by CLI) organization-related data   Attachment - (read-only by CLI) JSON-object with information about the file.   WYSIWYG - (read-only by CLI) JSON-object with HTML and TEXT content

Modulo PowerShell di NinjaOne

Quando si installa l'agente NinjaOne, NinjaOne distribuisce e carica un modulo NinjaOne PowerShell personalizzato per interagire con i campi personalizzati. È possibile accedere a ninjarmm-cli sui dispositivi Windows tramite questo modulo PowerShell, semplicemente richiamando i nomi delle funzioni all'interno di PowerShell.

Comandi PowerShell di NinjaOne

I comandi PowerShell che si possono eseguire sono descritti di seguito.

Get-NinjaProperty 

Il comando Get-NinjaProperty è un'evoluzione del comando originale Ninja-Property-Get. La funzione Get-NinjaProperty recupera e converte il valore di un campo personalizzato Ninja in base al nome e al tipo di campo specificato.

Il comando accetta un nome di campo, un tipo di proprietà e un nome di documento opzionale. Quando si fornisce un nome di documento, la funzione recupera il valore della proprietà dal documento Ninja specificato. A seconda del tipo specificato (ad esempio, Date, DateTime, Checkbox, Dropdown, ecc.), la funzione convertirà il valore grezzo in un oggetto PowerShell appropriato. Se il tipo di proprietà richiede opzioni aggiuntive, come le caselle a discesa o i campi a selezione multipla, la funzione recupera queste opzioni e restituisce un valore di facile utilizzo.

I tipi supportati includono: Allegato, Casella di controllo, Data, Data e ora, Decimale, Discesa dispositivo, Multi selezione dispositivo, Discesa, Email, Numero intero, Indirizzo IP, Multi linea, Multi selezione, Discesa organizzazione, Discesa posizione organizzazione, Multi selezione posizione organizzazione, Multi selezione organizzazione, Telefono, Sicuro, Testo, Ora, WYSIWYG e URL.

La sintassi è la seguente: Get-NinjaProperty [-Name] <String[]> [[-Type] <String>] [[-DocumentName] <String>] [<CommonParameters>]

Esempi

Il recupero di un campo a discesa personalizzato senza specificare il tipo restituisce il valore GUID dell'opzione a discesa selezionata.

Se si recupera un campo personalizzato a discesa specificando il tipo di campo personalizzato (a discesa), il comando restituisce il valore user-friendly visto nella piattaforma invece del valore GUID.

Imposta-Proprietà-Ninja

Il comando Set-NinjaProperty è un'evoluzione del comando originale Ninja-Property-Set. La funzione Set-NinjaProperty imposta un campo personalizzato in base ai parametri forniti. Quando viene dato un tipo di campo, tenta di convertire il valore fornito in uno supportato da quel particolare campo. Per esempio, quando viene dato un oggetto DateTime e viene specificato il tipo "Date", converte l'oggetto date in un timestamp Unix epoch e imposta il campo con quel valore.

È inoltre possibile impostare campi a discesa e a selezione multipla utilizzando i nomi dei campi anziché i loro GUID.

I tipi supportati includono: Casella di controllo, data, data o ora, data e ora, decimale, a discesa, e-mail, intero, indirizzo IP, multilinea, multiselezione, telefono, sicurezza, testo, ora, URL e WYSIWYG.

Esempi

L'impostazione di un campo personalizzato a discesa senza specificare il tipo di campo richiede il valore GUID univoco per l'opzione a discesa desiderata.

L'impostazione di un campo personalizzato a discesa, specificando il tipo di campo come a discesa, consente di utilizzare il valore user-friendly mostrato all'interno della piattaforma invece del valore GUID.

Entrambi i comandi, Get-NinjaProperty e Set-NinjaProperty, hanno il pieno supporto di Unicode, per cui è possibile impostare e recuperare le emoji tramite questi comandi.

È possibile accedere a ulteriori dettagli ed esempi per entrambi i comandi aprendo PowerShell su un dispositivo con l'agente NinjaOne installato e immettendo:

Get-Help Get-NinjaProperty

Oppure

Get-Help Set-NinjaProperty

Tutti i comandi PowerShell originali di NinjaOne funzionano ancora come sono stati progettati. Questi comandi sono:

Ninja-Property-Get $AttributeNameNinja-Property-Set $AttributeName $ValueNinja-Property-Options $AttributeNameNinja-Property-Clear $AttributeName

Comandi di documentazione

Ninja-Property-Docs-TemplatesNinja-Property-Docs-Names $TemplateIdNinja-Property-Docs-Names "$TemplateName"Ninja-Property-Docs-Get $TemplateId "$DocumentName" $AttributeNameNinja-Property-Docs-Set $TemplateID "$DocumentName" $AttributeName "value"Ninja-Property-Docs-Get-Single "templateName" "fieldName"Ninja-Property-Docs-Set-Single "templateName" "fieldName" "new value"Ninja-Property-Docs-ClearNinja-Property-Docs-OptionsNinja-Property-Docs-Clear-Single - clear value of single document by template name (quotes required, represented as NULL)Ninja-Property-Docs-Options-Single - get list of the valid values for single document attribute name by template name (actual for drop-down and multi-select attributes)

Interazione con i campi personalizzati tramite comandi CLI di Windows, script personalizzati batch, ShellScript su UNIX o script personalizzati ShellScript

Gli esempi di questa sezione mostrano come utilizzare i comandi e gli script batch per tipi specifici di campi personalizzati. Descrivono le chiamate a ninjarmm-cli senza un percorso completo, ma è possibile specificare il percorso completo in base alla propria piattaforma, come descritto in precedenza in questo articolo. Non ci sono differenze tra le chiamate all'utility CLI su piattaforme diverse.

Data e ora

Il tempo viene calcolato come segue:

• Il sistema fa riferimento al 1° gennaio 1970, alle 00:00:00 UTC, come epoca di Unix.
• Il valore della data è in secondi dal 1° gennaio 1970, alle 00:00:00 UTC. È possibile utilizzare uno strumento di conversione del timestamp per ottenere questo valore per una data leggibile dall'uomo.
• Se si imposta il valore in formato ISO, verrà convertito in secondi dal 1970-01-01 in UTC.

Gli esempi di questa sezione mostrano come utilizzare i comandi o gli script di PowerShell per tipi specifici di campi personalizzati.

Seleziona un argomento per continuare.

• Casella di controllo
• Data
• Data/Ora
• Decimale
• Dropdown (Elenco a discesa)
• E-mail
• Numero intero
• Indirizzo IP
• Multilinea
• Selezione multipla
• Phone Number (Numero di telefono)
• Protetti
• Testo
• Orario
• URL
• Documentation Fields (Campi documentazione)

Casella di controllo

Get:

# get value for checkbox field> ninjarmm-cli get globalcheckbox0

Set:

# set a boolean value to the checkbox field> ninjarmm-cli set globalcheckbox 00> ninjarmm-cli set globalcheckbox 11> ninjarmm-cli set globalcheckbox true1> ninjarmm-cli set globalcheckbox false0

Data

Get:

# get value for date field> ninjarmm-cli get globaldate456

Set:

# set value to date field> ninjarmm-cli set globaldate 1626875470000 > ninjarmm-cli set testdate 2021-10-151634256000

Data/Ora

Get:

# get value for date-time field> ninjarmm-cli get globaldatetime1626875470000

Set:

# set value to date-time field> ninjarmm-cli set globaldatetime 16268754700001626875470000 > ninjarmm-cli set testdatetime 2021-10-15T00:00:001634256000

Decimale

Get:

# get value for decimal field> ninjarmm-cli get globaldecimal123.456

Set:

# set value to decimal field> ninjarmm-cli set typedecimal 11 > ninjarmm-cli set typedecimal 1.231.23 > ninjarmm-cli set typedecimal 1.231.23 > ninjarmm-cli set typedecimal 1.23456789012345678901.234567 # truncated to max precision, better not to use a shorter value to avoid data type conversion issues > ninjarmm-cli set typedecimal 1234567890.12345678901234567890.123457

Dropdown (Elenco a discesa)

Opzioni:

# list options for the dropdown field> ninjarmm-cli options globaldropdown333f541e-747e-4a1e-a2e2-a82c1c2f2008=Option274a6ffda-708e-435a-86e3-40b67c4f981a=Option1f1ba449c-fd34-49df-b878-af3877180d17=Option3

Ottiene il GUID per nome dell'opzione:

# find the option GUID by the option name for the dropdown field> ninjarmm-cli options globaldropdown | grep "Option 1" | awk -F= '{print $1}'74a6ffda-708e-435a-86e3-40b67c4f981a

Get:

# get value for dropdown field> ninjarmm-cli get globaldropdown74a6ffda-708e-435a-86e3-40b67c4f981a

Set:

# set value to the dropdown field> ninjarmm-cli set globaldropdown f1ba449c-fd34-49df-b878-af3877180d17

E-mail

Get:

# get stored value> ninjarmm-cli get [email protected]

Set:

# correct values> ninjarmm-cli set typeemail [email protected]@test.test > ninjarmm-cli set typeemail [email protected]@test123.test.othertest # set wrong values> ninjarmm-cli set typeemail [email protected]: Wrong value format or type...

Numero intero

Get:

# get value for integer field> ninjarmm-cli get globalinteger456

Set:

# set value to integer field> ninjarmm-cli set globalinteger 123

Indirizzo IP

Get:

# get stored value> ninjarmm-cli get typeipaddress192.168.1.100

Set:

# set correct values> ninjarmm-cli set typeipaddress 255.255.255.255255.255.255.255 > ninjarmm-cli set typeipaddress 0.0.0.00.0.0.0 # set wrong values> ninjarmm-cli set typeipaddress 192.168.1.Error: Wrong value format / type ... > ninjarmm-cli set typeipaddress 255.255.255.256Error: Wrong value format / type ... > ninjarmm-cli set typeipaddress 0.-1.0.0Error: Wrong value format / type ...

Multilinea

Get:

# get multi-line field> ninjarmm-cli get globalmultilinesampletext1

Set:

# set text field> ninjarmm-cli set globalmultiline sampletext2 

Set (alternate): # set text field with piped data> ls -alh | ninjarmm-cli set globalmultiline

NinjaOne supporta l'uso di una singola stringa multilinea se si utilizza il carattere di controllo `n (il tasto "backtick" o "backspark" più la lettera "n"). Il testo deve essere inserito nel prompt dei comandi come una singola riga di testo a causa delle restrizioni della CLI o del terminale ed è limitato a 10.000 caratteri. Puoi anche incorporare gli spazi mettendo l'intera stringa tra virgolette. Quando si utilizzano questi caratteri di controllo, i dati vengono visualizzati come segue:

Ninja-Property-Set multiline "linea con spazi'nline2'nline3'nfinalval"

multilineline with spacesline2line3finalval

Selezione multipla

Opzioni:

# list options for multi-select field> ninjarmm-cli options globalmultiselect333f541e-747e-4a1e-a2e2-a82c1c2f2008=Option274a6ffda-708e-435a-86e3-40b67c4f981a=Option1f1ba449c-fd34-49df-b878-af3877180d17=Option3

Ottenere il GUID per nome dell'opzione:

# find option GUID by the option name for the multi-select field> ninjarmm-cli options globalmultiselect | grep "Option 1" | awk -F= '{print $1}'74a6ffda-708e-435a-86e3-40b67c4f981a

Set:

# set multiple values for multi-select field, comma-separated> ninjarmm-cli set globalmultiselect 333f541e-747e-4a1e-a2e2-a82c1c2f2008,74a6ffda-708e-435a-86e3-40b67c4f981a

Get:

# get values for multi-select field> ninjarmm-cli get globalmultiselect333f541e-747e-4a1e-a2e2-a82c1c2f2008, 74a6ffda-708e-435a-86e3-40b67c4f981a

Phone Number (Numero di telefono)

Get:

# get stored valueninjarmm-cli get typephone+1234567890

Set:

# set correct values> ninjarmm-cli set typephone +77013273916+77013273916 > ninjarmm-cli set typephone 123456789012344567123456789012344567 > ninjarmm-cli set typephone +123456789012344567+123456789012344567 # set wrong values> ninjarmm-cli set typephone 14953273916qwertyError: Wrong value format / type ... > ninjarmm-cli set typephone 1234567890123445678 # too longError: Wrong value format / type ... > ninjarmm-cli set typephone ++123456789012344567Error: Wrong value format / type ...

Protetti

Per evitare che i valori dei campi protetti vengano visualizzati nell'output dello script per i dispositivi Windows, lo script deve contenere @echo off e @echo on attorno al codice che chiama %NINJARMMCLI% set [nome campo protetto] [valore protetto]. Per impostazione predefinita, Windows fa l'eco di tutti i comandi immessi o eseguiti dagli utenti.

Per evitare che i valori dei campi protetti vengano visualizzati nell'output dello script per i dispositivi Unix (macOS o Linux), lo script non deve contenere set -x prima del funzionamento. Questa omissione impedisce l'eco dei comandi eseguiti che contengono valori sicuri.

Get: 

# get secure field> ninjarmm-cli get globalsecuresampletext1

Set:

# set secure field> ninjarmm-cli set globalsecure sampletext2

Testo

Get:

# get text field> ninjarmm-cli get globaltextsampletext1

Set:

# set text field> ninjarmm-cli set globaltext sampletext2

Ora

Get:

# get value for time field> ninjarmm-cli get globaldatetime120

Set:

# set value to time field> ninjarmm-cli set globaldatetime 36003600 > ninjarmm-cli set testdatetime 00:00:000

URL

Il campo URL è limitato a 200 caratteri e deve iniziare con https://.

Get:

# get URL field> ninjarmm-cli get urlhttps://www.google.com

Set:

# set URL field> ninjarmm-cli set url https://www.ninjarmm.com

Documentation Fields (Campi documentazione)

Get:

# get templates list> ninjarmm-cli templates1=template 12=template 2 # get documents list by template ID> ninjarmm-cli documents 216=template 2 # get documents list by template name> ninjarmm-cli documents "template 2"16=template 2 # get field value from document> ninjarmm-cli get "template 2" "template 2" fieldnameThis is the field value

Set:

# set attribute to the specified document/attribute by document name and template id/name (quotes required)> ninjarmm-cli org-set "template 2" "ExampleDoc" ExampleTextField "SampleText1" # set attribute to single document/attribute by template name (quotes required)> ninjarmm-cli org-set "template 2" ExampleTextField "SampleText1" # clear value of document by document name and template id/name (quotes required, represented as NULL)> ninjarmm-cli org-clear "template 2" "ExampleDoc" ExampleTextField # clear value of single document by template name (quotes required, represented as NULL)> ninjarmm-cli org-clear "template 2" ExampleTextField

Opzioni:

# get list of the valid values for document attribute name by document name and template id/name (actual for drop-down and multi-select attributes)> ninjarmm-cli org-options "template 2" "ExampleDoc" ExampleTextField # get list of the valid values for a single document attribute name by template name (actual for drop-down and multi-select attributes)> ninjarmm-cli org-options "template 2" ExampleTextField

Interazione con i campi personalizzati tramite comandi PowerShell o script personalizzati

Gli esempi di questa sezione mostrano come utilizzare i comandi o gli script di PowerShell per tipi specifici di campi personalizzati. Utilizzate i link sottostanti per accedere agli script che desiderate esaminare:

• Casella di controllo
• Data
• Data/Ora
• Decimale
• Dropdown (Elenco a discesa)
• E-mail
• Numero intero
• Indirizzo IP
• Multilinea
• Selezione multipla
• Phone Number (Numero di telefono)
• Protetti
• Testo
• Orario
• URL
• Documentation Fields (Campi documentazione)

Casella di controllo

Get:

# get value for checkbox field> Ninja-Property-Get globalcheckbox0

Set:

# set a boolean value to the checkbox field> Ninja-Property-Set globalcheckbox 00> Ninja-Property-Set globalcheckbox 11> Ninja-Property-Set globalcheckbox true1> Ninja-Property-Set globalcheckbox false0

Data

Get:

# get value for date field> Ninja-Property-Get globaldate456

Set:

# set value to date field> Ninja-Property-Set globaldate 1626875470000 > Ninja-Property-Set testdate 2021-10-151634256000

Data/Ora

Get:

# get value for date-time field> Ninja-Property-Get globaldatetime1626875470000

Set:

# set value to date-time field> Ninja-Property-Set globaldatetime 16268754700001626875470000 > Ninja-Property-Set testdatetime 2021-10-15T00:00:001634256000

Decimale

Get:

# get value for decimal field> Ninja-Property-Get globaldecimal123.456

Set:

# set value to decimal field> Ninja-Property-Set typedecimal 11 > Ninja-Property-Set typedecimal 1.231.23 > Ninja-Property-Set typedecimal 1.231.23 > Ninja-Property-Set typedecimal 1.23456789012345678901.234567 # truncated to max precision, better not to use more precision to avoid data type conversion issues > Ninja-Property-Set typedecimal 1234567890.12345678901234567890.123457

Dropdown (Elenco a discesa)

Opzioni:

# list options for the dropdown field> Ninja-Property-Options globaldropdown333f541e-747e-4a1e-a2e2-a82c1c2f2008=Option274a6ffda-708e-435a-86e3-40b67c4f981a=Option1f1ba449c-fd34-49df-b878-af3877180d17=Option3

Ottenere il GUID dell'opzione in base al nome dell'opzione:

# find the option GUID by the option name for the dropdown field> Ninja-Property-Get globaldropdown | grep "Option1" | awk -F= '{print $1}'74a6ffda-708e-435a-86e3-40b67c4f981a

Get:

# get value for dropdown field> Ninja-Property-Get globaldropdown74a6ffda-708e-435a-86e3-40b67c4f981a

Set:

# set value to the dropdown field> Ninja-Property-Set globaldropdown f1ba449c-fd34-49df-b878-af3877180d17

E-mail

Get:

# get stored value> Ninja-Property-Get [email protected]

Set:

# correct values> Ninja-Property-Set typeemail [email protected]@test.test > Ninja-Property-Set typeemail [email protected]@test123.test.othertest # set wrong values> Ninja-Property-Set typeemail [email protected]: Wrong value format / type ...

Numero intero

Per il campo Integer, il valore impostato deve essere un numero intero (un numero intero senza decimali) compreso nell'intervallo tra -2147483648 e 2147483647.

Get:

# get value for integer field> Ninja-Property-Get globalinteger456

Set:

# set value to integer field> Ninja-Property-Set globalinteger 123

Indirizzo IP

Per il campo IP , il valore impostato deve essere in formato IPv4 (Internet Protocol version 4) o IPv6 (Internet Protocol version 6).

Get:

# get stored value> Ninja-Property-Get typeipaddress192.168.1.100

Set:

# set correct values> Ninja-Property-Set typeipaddress 255.255.255.255255.255.255.255 > Ninja-Property-Set typeipaddress 0.0.0.00.0.0.0 # set wrong values> Ninja-Property-Set typeipaddress 192.168.1.Error: Wrong value format / type ... > Ninja-Property-Set typeipaddress 255.255.255.256Error: Wrong value format / type ... > Ninja-Property-Set typeipaddress 0.-1.0.0Error: Wrong value format / type ...

Multilinea

A causa delle restrizioni della CLI o del terminale, il testo deve essere inserito nel prompt dei comandi come una singola riga ed è limitato a 10.000 caratteri.

Get:

# get text field> Ninja-Property-Get globaltextsampletext1

Set:

# set text field>Ninja-Property-Set globaltext sampletext2

Selezione multipla

Opzioni:

# list options for multi-select field> Ninja-Property-Options globalmultiselect333f541e-747e-4a1e-a2e2-a82c1c2f2008=Option274a6ffda-708e-435a-86e3-40b67c4f981a=Option1f1ba449c-fd34-49df-b878-af3877180d17=Option3

Ottenere il GUID dell'opzione in base al nome dell'opzione:

# find option GUID by the option name for the multi-select field> Ninja-Property-Options globalmultiselect | grep "Option 1" | awk -F= '{print $1}'74a6ffda-708e-435a-86e3-40ba67c4f981a

Set:

# set multiple values for multi-select field, comma-separated> Ninja-Property-Set globalmultiselect 333f541e-747e-4a1e-a2e2-a82c1c2f2008, 74a6ffda-708e-435a-86e3-40b67c4f981a

Get:

# get values for multi-select field> Ninja-Property-Get globalmultiselect333f541e-747e-4a1e-a1e2-a82c1c2f2008, 74a6ffda-708e-435a-86e3-40b67c4f981a

Phone Number (Numero di telefono)

Get:

# get stored valueNinja-Property-Get typephone+1234567890

Set:

# set correct values> Ninja-Property-Set typephone +77013273916+77013273916 > Ninja-Property-Set typephone 123456789012344567123456789012344567 > Ninja-Property-Set typephone 123456789012344567123456789012344567 > Ninja-Property-Set typephone +123456789012344567+123456789012344567 # set wrong values> Ninja-Property-Set typephone 14953273916qwertyError: Wrong value format / type ... > Ninja-Property-Set typephone 14953273916qwertyError: Wrong value format / type ... > Ninja-Property-Set typephone 1234567890123445678 # too longError: Wrong value format / type ... > Ninja-Property-Set typephone ++123456789012344567Error: Wrong value format / type ...

Protetti

Get:

# get secure field> Ninja-Property-Get globalsecuresampletext1

Set:

# set secure field>Ninja-Property-Set globalsecure sampletext2

Testo

Get:

# get text field> Ninja-Property-Get globaltextsampletext1

Set:

# set text field>Ninja-Property-Set globaltext sampletext2

Ora

Per il campo Ora , il valore impostato deve essere in secondi o in formato ISO (hh:mm:ss).

Get:

# get value for time field> Ninja-Property-Get globaldatetime120

Set:

# set value to time field> Ninja-Property-Set globaldatetime 36003600 > Ninja-Property-Set testdatetime 00:00:000

URL

Il campo URL è limitato a 200 caratteri e deve iniziare con "https://'".

Get:

# get URL field> Ninja-Property-Get urlhttps://www.google.com

Set:

# set URL field>Ninja-Property-Set url https://www.google.com

Documentation Fields (Campi documentazione)

Get:

# get templates list> Ninja-Property-Docs-Templates1=template 12=template 2 # get documents list by template ID> Ninja-Property-Docs-Names 216=template 2 # get documents list by template name> Ninja-Property-Docs-Names "template 2"16=template 2 # get field value from document> Ninja-Property-Docs-Get "template 2" "template 2" fieldnameThis is the field value

Set:

# set attribute to the specified document/attribute by document name and template id/name (quotes required)> Ninja-Property-Docs-Set 2 "ExampleDoc" ExampleTextField # set attribute to single document/attribute by template name (quotes required)> Ninja-Property-Docs-Set-Single "template 2" ExampleTextField "sampletext1" # clear value of document by document name and template id/name (quotes required, represented as NULL)> Ninja-Property-Docs-Clear "template 2" "ExampleDoc" ExampleTextField # clear value of single document by template name (quotes required, represented as NULL)> Ninja-Property-Docs-Clear-Single "template 2" ExampleTextField

Opzioni:

# get list of the valid values for document attribute name by document name and template id/name (actual for drop-down and multi-select attributes)> Ninja-Property-Docs-Options "template 2" "ExampleDoc" ExampleTextField # get list of the valid values for a single document attribute name by template name (actual for drop-down and multi-select attributes)> Ninja-Property-Docs-Options-Single "template 2" ExampleTextField

Risorse aggiuntive

Per saperne di più su documentazione, campi personalizzati, CLI e scripting, consultare i seguenti articoli:

Interfaccia a riga di comando (CLI)

Utilizzo dell'interfaccia della riga di comando (CLI) in NinjaOne.

Documentazione e campi personalizzati

• Campi personalizzati NinjaOne: Catalogo delle risorse.
• Introduzione ai campi personalizzati di NinjaOne.
• NinjaOne Documentation: Applicazioni e servizi.

Scripting

• Scripting, automazione, CLI: Catalogo delle risorse.
• Come iniziare con la libreria di automazione di NinjaOne (scripting).