Переменные и функции
Security Controls поддерживает использование ряда переменных и функций PowerShell для выполнения каждого сценария. Все имена переменных начинаются с "ST_". Все имена функций начинаются с "ST-". Вы можете использовать эти переменные и функции в своих сценариях.
Переменные PowerShell могут иметь другие области действия:
- Global: Доступна в текущем сеансе PowerShell.
- Script: Используется в сценарии (вне функций) и локально для этого сценария.
- Закрытая: Используется в функции и локально для этой функции.
- Local: Текущая область действия, которая может быть глобальной, сценарием или закрытой.
Переменные, используемые с Security Controls, имеют общую область действия. Так как каждый целевой компьютер выполняет собственный сеанс PowerShell, это равносильно использованию области действия сценария.
Переменные выполнения
В следующей таблице перечислены переменные для каждого выполнения. Для всех компьютеров будет отображаться одно и то же значение этих переменных. Не изменяйте значения переменных, отмеченных как [Только чтение].
| Имя переменной | Описание |
|---|---|
| ST_OutputDirectory | Полный путь к базовому каталогу вывода. Для выполнения будет создан подкаталог. [Только чтение] |
| ST_RunDirectory | Полный путь к каталогу выполнения вывода. [Только чтение] |
| ST_RunErrorFile | Полный путь к файлу ошибок выполнения вывода. В этом файле должны быть представлены ошибки, не относящиеся к конкретному компьютеру. Этот файл также будет содержать сообщения о компьютерах, для которых не удалось определить IP-адрес, и о компьютерах, на которых не будут созданы соответствующие им вложенные папки. [Только чтение] |
| ST_RunName | Имя выполнения, указанное в пользовательском интерфейсе во время запуска вручную или по расписанию с добавленным временем выполнения. По умолчанию используется имя сценария или шаблона. [Только чтение] |
| ST_RunOnConsole | Установите значение $false, если в сценарии используется удаленное подключение PowerShell, а в противном случае - $true. [Только чтение] |
| ST_RunOutputFile | Полный путь к стандартному файлу вывода выполнения вывода. В этом файле будут присутствовать все данные вывода, отображаемые на консоли во время запуска из командной строки. [Только чтение] |
| ST_RunResult | Это краткий результат выполнения, отображаемый в Мониторе операций. Он ограничен 100 символами. Если вы не введете эту переменную явно в своем сценарии, она будет установлена для указания количества компьютеров, на которых были обнаружены ошибки, и количество ошибок обнаружения компьютеров. |
Переменные компьютера
В следующей таблице перечислены переменные для каждого компьютера. Значения этих переменных могут отличаться для каждого целевого компьютера. Не изменяйте значения переменных, отмеченных как [Только чтение].
| Имя переменной | Описание |
|---|---|
| ST_ComputerName | Имя целевого компьютера. [Только чтение] |
| ST_Credential | Объект PSCredential, содержащий имя пользователя и пароль SecureString, используемые для подключения к целевому компьютеру. Эту переменную можно передать в любую команду, которая поддерживает параметр Credential. [Только чтение] |
| ST_DomainName | Имя домена или рабочей группы целевого компьютера. [Только чтение] |
| ST_MachineDirectory | Полный путь к каталогу компьютера. Обычно это имя компьютера, однако, если имя компьютера содержит символы, недопустимые в именах папок, эти символы будут заменены символами подчеркивания. [Только чтение] |
| ST_MachineError | Логическое значение, указывающее, что во время выполнения этого сценария на конкретном компьютере, обнаружена одна или несколько ошибок. |
| ST_MachineErrorFile | Полный путь к файлу ошибок компьютера. Если во время выполнения сценария будут обнаружены ошибки, они будут записаны в этот файл. [Только чтение] |
| ST_MachineOutputFile | Полный путь к файлу вывода компьютера. В этом файле будут представлены данные вывода, созданные сценарием для стандартного вывода. |
| ST_MachineResult | Это краткий результат для компьютера, отображаемый в Мониторе операций. Он ограничен 100 символами. Если вы не укажете эту переменную явно в своем сценарии, для нее будет установлено значение "Успешно" в случае отсутствия ошибок на компьютере, или сообщение первой ошибки, обнаруженной для этого компьютера. Используйте функцию ST-SetMachineResult для явной установки значения этой переменной. |
| ST_MachineResultSet | Логическое значение, указывающее, что сценарий установил переменную ST_MachineResult. Используйте функцию ST-SetMachineResult для явной установки значения ST_MachineResult и этой переменной. |
Функции
Security Controls содержит набор функций, доступных для каждого создаваемого вами сценария. Они перечислены в следующей таблице.
| Имя переменной | Описание |
|---|---|
| ST-GetTargetOS | Эта функция выполняет попытку подключения к целевой системе, опрашивая WMI и получая объект Win32_OperatingSystem. |
| ST-SetMachineResult | Эта функция использует строковый параметр. Она устанавливает переменную ST_MachineResult для передачи строки и устанавливает для переменной ST_MachineResultSet значение $true. |
| ST-SetMachineError | Эта функция использует строковый аргумент в качестве параметра. Она устанавливает переменную ST_MachineResult для передачи строки. Она также устанавливает для переменных ST_MachineResultSet и ST_MachineError значение $true. |
| ST-SendMessage | Эта функция использует строковый параметр. Эта строка будет отображаться в Мониторе операций. Используйте эту функцию для отслеживания выполнения долговременных сценариев. После выполнения сценария строка в ST_MachineResult будет отображена в Мониторе операций. За исключением процесса отладки вы должны избегать вызова этого метода в быстро выполняемых сценариях. Строка будет усечена до 100 символов, если будет передана строка длиннее этого значения. |
| ST-CreateMachineDirectory | Обычно каталог компьютера не создается до записи выводных данных. Если ваш сценарий создает файлы в каталоге компьютера, перед записью в каталоге вы должны вызвать эту функцию для создания каталога. Вызов этой функции более одного раза не имеет отрицательного эффекта. |
| ST-CreateRunDirectory | Обычно каталог выполнения не создается до тех пор, пока во время выполнения не будут записаны любые выходные данные. Если ваш сценарий создает файлы в каталоге выполнения, перед записью в каталоге вы должны вызвать эту функцию для создания каталога. Вызов этой функции более одного раза не имеет отрицательного эффекта. |
| ST-ComputerAndCredential | Эта функция возвращает для целевого компьютера соответствующие значения для использования в параметрах ComputerName и Credential. Для получения информации см. раздел Использование параметров ComputerName и Credential. |
| ST-SubCC | Эта функция принимает строковый параметр, который является допустимым для команд PowerShell. Эта функция заменяет параметр "$ST_CC" в этой командной строке соответствующими значениями для использования параметров ComputerName и Credential. Затем она выполняет полученную команду и возвращает результаты выполнения. Для получения информации см. раздел Использование параметров ComputerName и Credential. |