Variáveis ​​e funções

Security Controls fornece um conjunto de variáveis ​​e funções do PowerShell para cada script. Todos os nomes de variável começam com "ST_". Todos os nomes de função começam com "ST-". Você pode usar essas variáveis ​​e funções em seus scripts.

As variáveis ​​do PowerShell podem ter diferentes escopos:

• Global: disponível para a sessão atual do PowerShell
• Script: declarado no script (fora das funções) e local para esse script
• Privado: declarado em uma função e local para essa função
• Local: o escopo atual, que pode ser global, script ou privado

As variáveis ​​fornecidas com o Security Controls são declaradas no escopo global. Como cada máquina alvo roda em sua própria sessão do PowerShell, é como se estivesse declarada no escopo do script.

Variáveis de execução

A tabela a seguir lista as variáveis ​​por execução. Todas as máquinas verão o mesmo valor para essas variáveis. Não modifique os valores das variáveis ​​marcadas como [Somente leitura].

Nome da variável	Descrição
ST_OutputDirectory	O caminho completo para o diretório básico de saída. Um subdiretório será criado para a execução. [Somente leitura]
ST_RunDirectory	O caminho completo para o diretório de saída da execução. [Somente leitura]
ST_RunErrorFile	O caminho completo para o arquivo de erros de execução. Erros que não são específicos a uma máquina em particular devem ser gravados neste arquivo. Este arquivo também conterá mensagens sobre as máquinas que não puderam ser resolvidas como endereço IP, e não haverá criação de nenhuma subpasta específica para as máquinas que não puderam ser resolvidas. [Somente leitura]
ST_RunName	O nome especificado para a execução na interface de usuário quando ela foi iniciada ou agendada, com o tempo de execução anexado. O padrão é o nome do script ou do modelo. [Somente leitura]
ST_RunOnConsole	Definir como $false se o script estiver usando comunicação remota do PowerShell; caso contrário, como $true. [Somente leitura]
ST_RunOutputFile	O caminho completo para o arquivo padrão de saída de execução. Todas as saídas que apareceriam no console se executadas em um prompt de comando serão colocadas neste arquivo. [Somente leitura]
ST_RunResult	É um pequeno resultado de execução que aparecerá no Monitor de Operações. É limitado a 100 caracteres de comprimento. Se você não definir explicitamente esta variável no script, ela será definida para indicar o número de máquinas que apresentaram erros e o número de erros de resolução da máquina.

Variáveis ​​de máquina

A tabela a seguir lista as variáveis ​​por máquina. O valor dessas variáveis ​​pode ser diferente para cada máquina alvo. Você não deve modificar os valores das variáveis ​​marcadas como [Somente leitura].

Nome da variável	Descrição
ST_ComputerName	O nome do computador alvo. [Somente leitura]
ST_Credential	Um objeto PSCredential que contém o nome de usuário e a senha SecureString usados ​​para conectar à máquina alvo. Esta variável pode ser passada para qualquer comando que suporte o parâmetro Credential. [Somente leitura]
ST_DomainName	O nome de domínio ou grupo de trabalho do computador alvo. [Somente leitura]
ST_MachineDirectory	O caminho completo para o diretório da máquina. Normalmente será o nome da máquina, mas, se o nome da máquina contiver caracteres que não sejam permitidos em nomes de pasta, tais caracteres serão substituídos por caracteres de sublinhado. [Somente leitura]
ST_MachineError	Valor booleano que indica que foram detectados um ou mais erros durante a execução do script direcionada a essa máquina específica.
ST_MachineErrorFile	Caminho completo para o arquivo de erros da máquina. Se forem detectados erros durante a execução do script, eles aparecerão neste arquivo. [Somente leitura]
ST_MachineOutputFile	Caminho completo para o arquivo de saída da máquina. A saída gerada pelo script na saída padrão será capturada neste arquivo.
ST_MachineResult	É um pequeno resultado de máquina que aparecerá no Monitor de Operações. É limitado a 100 caracteres de comprimento. Se você não definir explicitamente esta variável no script, ela será definida como "Sucesso" se nenhum erro for detectado; ou como a mensagem de erro do primeiro erro encontrado para essa máquina. Use a função ST-SetMachineResult para definir explicitamente o valor desta variável.
ST_MachineResultSet	Valor booleano que indica se o script definiu a variável ST_MachineResult. Use a função ST-SetMachineResult para definir tanto a variável ST_MachineResult quanto esta variável.

Funções

Security Controls disponibiliza um conjunto de funções a cada script que você cria. Elas estão listadas na tabela a seguir.

Nome da variável	Descrição
ST-GetTargetOS	Esta função tenta se conectar ao sistema alvo, consultar o WMI e recuperar o objeto Win32_OperatingSystem.
ST-SetMachineResult	Esta função recebe uma string como parâmetro. Define a variável ST_MachineResult com a string recebida e ST_MachineResultSet como $true.
ST-SetMachineError	Esta função recebe uma string como argumento. Define a variável ST_MachineResult com a string recebida. Também define as variáveis ST_MachineResultSet e ST_MachineError como $true.
ST-SendMessage	Esta função recebe uma string como parâmetro. A string será exibida no Monitor de Operações. Use esta função para monitorar o progresso de scripts de longa execução. Quando o script for concluído, a string em ST_MachineResult será exibida no monitor de operações. Exceto durante a depuração, evite chamar este método em scripts que são executados rapidamente. A string recebida será truncada para 100 caracteres se for mais longa do que isso.
ST-CreateMachineDirectory	Normalmente, o diretório da máquina não é criado até que a saída seja gravada. Se o seu script estiver criando arquivos no diretório da máquina, você deve invocar esta função para criar o diretório antes de gravar qualquer coisa nele. Chamar esta função mais de uma vez não terá efeito negativo.
ST-CreateRunDirectory	Normalmente, o diretório de execução não é criado até que a execução grave alguma saída. Se o seu script estiver criando arquivos no diretório de execução, você deve invocar esta função para criar o diretório antes de gravar qualquer coisa nele. Chamar esta função mais de uma vez não terá efeito negativo.
ST-ComputerAndCredential	Esta função retorna os valores apropriados a serem usados nos parâmetros ComputerName e Credential da máquina alvo. Consulte Especificando os parâmetros ComputerName e Credential para obter detalhes.
ST-SubCC	Esta função usa como parâmetro uma string contendo um comando válido do PowerShell. A função substitui "$ST_CC" na string pelos valores apropriados a serem usados nos parâmetros ComputerName e Credential do comando. Em seguida, executa o comando resultante e retorna os resultados da execução. Consulte Especificando os parâmetros ComputerName e Credential para obter detalhes.