Variabili e funzioni
Security Controls fornisce un set di variabili PowerShell e di funzioni per ogni script. Tutti i nomi delle variabili iniziano per “ST_”. I nomi delle funzioni iniziano tutti con “ST-”. È possibile utilizzare tali variabili e funzioni nei propri script.
Le variabili PowerShell possono avere diversi ambiti:
- Globale: disponibile per la sessione PowerShell corrente
- Script: dichiarato nello script (al di fuori delle funzioni) e locale per tale script
- Privato: dichiarato in una funzione e locale per tale funzione
- Locale: l'ambito corrente, che può essere globale, script o privato
Le variabili fornite con Security Controls sono dichiarate nell'ambito globale. Dato che ciascun computer di destinazione è in esecuzione nella propria sessione di PowerShell, ciò equivale ad essere dichiarati nell'ambito dello script.
Esegui variabili
La tabella seguente elenca le variabili per esecuzione. Tutti i computer vedranno lo stesso valore per tali variabili. Non modificare i valori delle variabili contrassegnate come [Sola lettura].
| Nome variabile | Descrizione |
|---|---|
| ST_OutputDirectory | Il percorso completo alla directory output base. Per l'esecuzione verrà creata una sottodirectory. [Sola lettura] |
| ST_RunDirectory | Il percorso completo alla directory output di esecuzione. [Sola lettura] |
| ST_RunErrorFile | Il percorso completo al file di errore esecuzione. Gli errori che non sono specifici per un particolare computer devono essere scritti in questo file. Questo file conterrà anche messaggi sui computer che non è stato possibile risolvere a un indirizzo IP, e non verrà creata alcuna sottocartella specifica di un computer per i computer che non è stato possibile risolvere. [Sola lettura] |
| Nome esecuzione ST | Il nome dell'esecuzione specificata nell'interfaccia utente quando l'esecuzione è stata inizializzata o pianificata, con l'aggiunta del tempo di esecuzione. Il valore predefinito è il nome dello script o del modello. [Sola lettura] |
| ST_RunOnConsole | Impostare su $false se lo script sta utilizzando PowerShell in remoto; altrimenti $true. [Sola lettura] |
| ST_RunOutputFile | Il percorso completo al file di output di esecuzione standard. Tutto l'output che apparirebbe sulla console se l'esecuzione a un prompt dei comandi venisse posizionata in questo file. [Sola lettura] |
| ST_RunResult | Questo è un breve risultato di esecuzione che apparirà nel Monitor operazioni. Il limite di lunghezza è 100 caratteri. Se non si imposta esplicitamente questa variabile nel proprio script, verrà impostata per indicare il numero di computer con errori e il numero di errori di risoluzione computer. |
Variabili computer
La tabella seguente elenca le variabili per computer. Il valore di queste variabili potrebbe essere diverso per ciascun computer di destinazione. Non si dovrebbero modificare i valori delle variabili contrassegnate come [Sola lettura].
| Nome variabile | Descrizione |
|---|---|
| ST_ComputerName | Il nome del computer di destinazione. [Sola lettura] |
| ST_Credential | Un oggetto PSCredential contenente il nome utente e la password SecureString utilizzati per la connessione al computer di destinazione. Questa variabile può essere inoltrata a qualsiasi comando che supporti il parametro Credenziale. [Sola lettura] |
| ST_DomainName | Il nome del dominio o gruppo di lavoro del computer di destinazione. [Sola lettura] |
| ST_MachineDirectory | Il percorso completo alla directory del computer. In genere corrisponderà al nome del computer, ma se il nome del computer contiene caratteri che non sono consentiti nei nomi delle cartelle, allora tali caratteri saranno sostituiti da caratteri di sottolineatura. [Sola lettura] |
| ST_MachineError | Un valore booleano che indica che uno o più errori sono stati rilevati durante l'esecuzione di questo script relativo a questo specifico computer. |
| ST_MachineErrorFile | Il percorso completo al file di errore del computer. Se vengono rilevati errori durante l'esecuzione dello script, appariranno in questo file. [Sola lettura] |
| ST_MachineOutputFile | Il percorso completo del file di output del computer. L'output generato dallo script all'output standard verrà acquisito in questo file. |
| ST_MachineResult | Questo è un breve risultato del computer che apparirà nel Monitor operazioni. Il limite di lunghezza è 100 caratteri. Se non si imposta esplicitamente questa variabile nel proprio script, verrà impostata su "Operazione riuscita" qualora non venga rilevato alcun errore del computer, oppure sul messaggio di errore del primo errore rilevato per tale computer. Utilizzare la funzione ST-SetMachineResult per impostare esplicitamente il valore di questa variabile. |
| ST_MachineResultSet | Un valore booleano che indica che lo script ha impostato la variabile ST_MachineResult. Utilizzare la funzione ST-SetMachineResult per impostare sia la variabile ST_MachineResult sia questa variabile. |
Funzioni
Security Controls fornisce un set di funzioni che sono disponibili per ogni script che si crea. Sono elencati nella tabella seguente.
| Nome variabile | Descrizione |
|---|---|
| ST-GetTargetOS | Questa funzione tenta di stabilire una connessione al sistema di destinazione, interrogare WMI e recuperare l'oggetto Win32_OperatingSystem. |
| ST-SetMachineResult | Questa funzione richiede un parametro stringa. Imposta la variabile ST_MachineResult alla stringa passata e imposta ST_MachineResultSet su $true. |
| ST-SetMachineError | Questa funzione richiede un argomento stringa. Imposta la variabile ST_MachineResult alla stringa passata. Imposta anche le variabili ST_MachineResultSet e ST_MachineError su $true. |
| ST-SendMessage | Questa funzione richiede un parametro stringa. La stringa verrà visualizzata nel Monitor operazioni. Utilizzare questa funzione per monitorare i progressi degli script di lungo corso. Quando lo script è completo, la stringa in ST_MachineResult verrà visualizzata nel Monitor operazioni. Ad eccezione della fase di debug, si dovrebbe evitare di richiamare questo metodo negli script che vengono eseguiti rapidamente. La stringa verrà troncata a 100 caratteri se viene passata una stringa più lunga. |
| ST-CreateMachineDirectory | Normalmente, la directory computer non viene creata fino alla scrittura dell'output. Se il proprio script sta creando file nella directory del computer, si dovrebbe richiamare questa funzione per creare la directory prima di scrivere qualsiasi cosa nella directory. Il richiamo di questa funzione più di una volta non avrà alcun effetto negativo. |
| ST-CreateRunDirectory | Normalmente, la directory di esecuzione non viene creata fino a che l'esecuzione non scrive un qualche output. Se il proprio script sta creando file nella directory di esecuzione, si dovrebbe richiamare questa funzione per creare la directory prima di scrivere qualsiasi cosa nella directory. Il richiamo di questa funzione più di una volta non avrà alcun effetto negativo. |
| ST-ComputerAndCredential | Questa funzione restituisce valori appropriati per l'uso con i parametri Nome computer e Credenziale per i computer di destinazione. Vedere Specifica dei parametri Nome computer e credenziali per i dettagli. |
| ST-SubCC | Questa funzione richiede un parametro stringa, che rappresenta un comando PowerShell valido. Questa funzione sostituisce “$ST_CC” in tale stringa di comando con valori appropriati da usare per i parametri Nome computer e Credenziale per il comando. Esegue quindi il comando risultante e restituisce i risultati dell'esecuzione. Vedere Specifica dei parametri Nome computer e credenziali per i dettagli. |