Variables y funciones
Security Controls proporciona un conjunto de variables y funciones de PowerShell en todas la secuencias de comandos. Los nombres de variables empiezan todos por “ST_”. Los nombres de funciones empiezan todos con “ST-“. Puede usar estas variables y funciones en sus secuencias de comandos.
Las variables dePowerShell pueden tener distintos alcances:
- Global: disponible para la sesión actual de PowerShell
- Secuencia de comandos: declarada en la secuencia (fuera de las funciones) y local a esa secuencia de comandos
- Privado: declarado en una función y local a esa función
- Local: el ámbito actual, que puede ser global, secuencia o privado
Las variables que se proporcionan con Security Controls se declaran en el ámbito global. Puesto que cada equipo de destino se ejecuta en su propia sesión de PowerShell, esto es el equivalente de estar declarado en el ámbito de la secuencia de comandos.
Ejecutar variables
La tabla siguiente lista las variables por ejecución. Todos los equipos verán el mismo valor para estas variables. No modifique los valores de las variables marcadas como [Solo lectura].
| Nombre de variable | Descripción |
|---|---|
| ST_OutputDirectory | La ruta completa al directorio de salida básico. Se creará un subdirectorio para la ejecución. [Solo lectura] |
| ST_RunDirectory | La ruta completa al directorio de salida de ejecución. [Solo lectura] |
| ST_RunErrorFile | La ruta completa al archivo de error de ejecución. Los errores que no son específicos a un equipo en concreto se deben escribir en este archivo. Este archivo también contendrá mensajes sobre equipos que no se han podido resolver con una dirección IP y no se creará ninguna subcarpeta no específica del equipo para los equipos que no se pudieron resolver. [Solo lectura] |
| ST_RunName | El nombre de la ejecución especificada en la interfaz del usuario cuando se inició o se programó la ejecución, con la hora de ejecución adjunta. El predeterminado es el mismo que el de la secuencia de comandos o la plantilla. [Solo lectura] |
| ST_RunOnConsole | Ajustar como $false si la secuencia de comandos utiliza PowerShell remoto; si no, $true. [Solo lectura] |
| ST_RunOutputFile | La ruta completa al archivo de salida de ejecución estándar. Todos los resultados que aparecerían en la consola si se ejecuta en un aviso de comando se colocarán en este archivo. [Solo lectura] |
| ST_RunResult | Este es un resultado de ejecución corto que aparecerá en el Supervisor de operaciones. Tiene un límite de 100 caracteres. Si no ajusta esta variable de manera explícita en su secuencia de comandos, se ajustará para indicar el número de equipos que tenían errores y el número de errores de resolución del equipo. |
Variables del equipo
La tabla siguiente lista las variables por equipo. El valor de estas variables puede ser distinta para cada equipo de destino. No debe modificar los valores de las variables marcadas como [Solo lectura].
| Nombre de variable | Descripción |
|---|---|
| ST_ComputerName | El nombre del equipo de destino. [Solo lectura] |
| ST_Credential | Un objeto PSCredential que contiene el nombre de usuario y la contraseña de SecureString que se usa para conectarse con el equipo de destino. Esta variable se puede pasar a cualquier comando que sea compatible con el parámetro Credencial. [Solo lectura] |
| ST_DomainName | El nombre del dominio del equipo de destino o del grupo de trabajo. [Solo lectura] |
| ST_MachineDirectory | La ruta completa al directorio del equipo. Este será normalmente el nombre del equipo, pero si el nombre del equipo contiene caracteres no permitidos en los nombres de carpetas, esos caracteres se reemplazarán con guiones bajos. [Solo lectura] |
| ST_MachineError | Un valor booleano que indica que se han detectado uno o más errores durante la ejecución de esta secuencia destinada a este equipo específico. |
| ST_MachineErrorFile | La ruta completa al archivo de error del equipo. Si se detectaron errores durante la ejecución de la secuencia, aparecerán en este archivo. [Solo lectura] |
| ST_MachineOutputFile | La ruta completa al archivo de salida del equipo. El resultado generado por la secuencia de comandos en el resultado estándar se capturará en este archivo. |
| ST_MachineResult | Este es un resultado corto del equipo que aparecerá en el Supervisor de operaciones. Tiene un límite de 100 caracteres. Si no ajusta esta variable en su secuencia de comandos, se ajustará como "Correcta" si no se detectan errores de equipo o como el mensaje de error del primero error que se encuentre en el equipo. Utilice la función ST-SetMachineResult para establecer de manera explícita el valor de esta variable. |
| ST_MachineResultSet | Un valor booleano que indica que la secuencia de comandos ha ajustado la variable ST_MachineResult. Utilice la función ST-SetMachineResult para establecer la variable ST_MachineResult y esta variable. |
Funciones
Security Controls proporciona un conjunto de funciones que están disponibles para todas las secuencias de comandos que cree. Se listan en la tabla siguiente.
| Nombre de variable | Descripción |
|---|---|
| ST-GetTargetOS | Esta función intenta conectarse con el sistema de destino, consultar WMI y recuperar el objeto Win32_OperatingSystem. |
| ST-SetMachineResult | Esta función toma un parámetro de la cadena. Ajusta la variable ST_MachineResultSet como la cadena que se pasa y la ST_MachineError como $true. |
| ST-SetMachineError | Esta función toma un argumento de la cadena. Ajusta la variable ST_MachineResult como la cadena que se pasa. También ajusta las variables ST_MachineResultSet y ST_MachineError como $true. |
| ST-SendMessage | Esta función toma un parámetro de la cadena. La cadena se mostrará en el Supervisor de operaciones. Utilice esta función para monitorizar el progreso de las secuencias de comandos largas. Cuando se complete la secuencia de comandos, se mostrará la secuencia de comandos ST_MachineResult en la pantalla de operaciones. Excepto durante la depuración, deberá evitar solicitar este método en secuencias de comandos que se ejecuten rápidamente. La cadena se truncará a 100 caracteres si se pasa una cadena más grande. |
| ST-CreateMachineDirectory | Normalmente, el directorio del equipo no se crea hasta que se escribe el resultado. Si su secuencia de comandos crea archivos en el directorio del equipo, deberá invocar esta función para crear el directorio antes de escribir cualquier cosa en el mismo. Solicitar esta función más de una vez no tendrá un efecto negativo. |
| ST-CreateRunDirectory | Normalmente, el directorio de ejecución no se crea hasta que la ejecución escribe el resultado. Si su secuencia de comandos crea archivos en el directorio de ejecución, deberá invocar esta función para crear el directorio antes de escribir cualquier cosa en el mismo. Solicitar esta función más de una vez no tendrá un efecto negativo. |
| ST-ComputerAndCredential | Esta función devuelve los valores adecuados que se usarán con los parámetros ComputerName y Credencial del equipo de destino. Para obtener más información, consulte Especificar los parámetros ComputerName y Credencial. |
| ST-SubCC | Esta función toma un parámetro de la cadena, que es un comando de PowerShell válido. Esta función sustituye “$ST_CC” en la cadena de comandos con los valores adecuados que se usarán con los parámetros ComputerName y Credencial del equipo de destino. A continuación ejecuta el comando resultante y devuelve los resultados de la ejecución. Para obtener más información, consulte Especificar los parámetros ComputerName y Credencial. |