--- sourceDocument: Australia Workflow Data Fabric sourceDocumentLink: https://www.servicenow.com/docs/r/australia/integrate-applications Release : - australia ft:locale : - en-US ft:publication_title : - Australia Workflow Data Fabric ft:clusterId : - crint bundleId : - crint workflow : - Creator --- # MID Server PowerShell files # MID Server PowerShell files {#ariaid-title1} Release version: Australia Updated March 12, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of MID Server PowerShell files The MID Server utilizes PowerShell script files (.ps1) and module files (.psm1) to perform various tasks, including credential testing, password encryption, and executing scripts in the Orchestration Activity Designer or MID Script Files. This documentation primarily discusses howPSScript.ps1leverages thecredential.psm1module for testing remote host access. Show full answer Show less ## Key Features * **PowerShell Credential Types:** There are specific credential types for various services like WMI, Exchange, Active Directory, and SCCM. If no credential type is specified, the MID Server defaults to WMI. * **Exit Codes:** The script returns exit codes to indicate success or failure of operations, which are logged for diagnostics. * **Diagnostic Utilities:** The **DiagnosticsUtil.psm1** module allows logging for debugging PowerShell scripts, providing tools to log debug messages, parameter values, and obfuscate sensitive data. * **Credential Testing:** The **Credentials.psm1** module tests access to target hosts using various methods depending on the credentials available. ## Key Outcomes By utilizing these PowerShell files and modules, ServiceNow customers can effectively test and manage remote host access, ensuring secure execution of scripts. The logging and debugging capabilities enhance the ability to troubleshoot issues, while the structured credential testing process improves the reliability of service integrations. PowerShell functions are stored in script files (\*.ps1) that use a PowerShell Script module (\*.psm1) file name extension. The PowerShell functions are used by the PowerShell MID Server script files included in these activity packs: * Active Directory * Exchange * SCCM * PowerShell {#mid-server-powershell-files__ul_gd5_554_cw} ## PSScript.ps1 This script performs a few tasks, such as credential testing, password encryption, and the execution of scripts configured in the Orchestration Activity Designer or in MID Script Files. However, this document focuses on how PSScript.ps1 uses the credential.psm1 module for testing access to remote hosts. The PowerShell variables are generally used directly in the [PowerShell execution command](https://www.servicenow.com/docs/u~KfW7OGiwUP0mmiUmfDxg#t_MapPowershellVariablesToExecCmd "Use the input variables you created to configure the command that Orchestration executes on the Windows target machine.") or as arguments in the MID Server script file you specify. There are special variables that are passed to PSScript.ps1, such as credType. Figure 1. Using credType in execution parameters ## PowerShell credTypes The PowerShell credential types: {#mid-server-powershell-files__table_pm5_b1p_cw__entry__2} | Type | Description | |-|-| | WMI | testCredentialWMI | | Exchange | testCredentilExchange | | AD | testCredentilAD | | SCCM | testCredentilSCCM | [ ] {#mid-server-powershell-files__table_pm5_b1p_cw} If no credential type is passed to the PSScrip.ps1 script, the MID Server defaults to the WMI test function to test access to the target host. If there is a credential type used, the MID Server runs the corresponding test function for that credential type. ## Exit codes These exit codes are returned from the PSScript.ps1 script and logged in the MID Server log file. {#mid-server-powershell-files__table_r4l_n5q_dw__entry__2} | Type | Test function | |-|-| | 0 | PowerShell command/script ran successfully. | | 1 | Test finished successfully, but the command/script failed to execute. | | 2 | Incorrect syntax passed to script. | | 3 | All credentials including MID Server service account failed to execute the command/script. | | 4 | Passed test and executed the activity, but an error was returned. Example user cannot be found. | [Table 1. PSScript.ps1 exit codes] {#mid-server-powershell-files__table_r4l_n5q_dw} ## DiagnosticsUtil.psm1 {#mid-server-powershell-files__section_rd2_vkl_4bb} The MID Server uses this module file to perform PowerShell logging that assists debugging any Orchestration activity using PowerShell scripting. You can also add debugging statements directly to custom scripts.{#mid-server-powershell-files__table_sd2_vkl_4bb__entry__2} | Utility | Description | |-|-| | SNCLog-DebugInfo | Log a debug message for a PowerShell script or PowerShell Orchestration activity. Examples: * `SNCLog-DebugInfo -message "My debug message..."` * `SNCLog-DebugInfo "My debug message"` {#mid-server-powershell-files__ul_qw4_knl_4bb} | | SNCLog-ParameterInfo | Log a function parameter value. For `"function getHostName{ param( [String] $target )"`, the first value to the PowerShell hashtable is a string to indicate which function executes, and the values for each of the function parameters. Examples: * Function with single parameter: `SNCLog-ParameterInfo @("Running getHostName", $target)` Note: The debug message shows, '`Running getHostName $target:[actual value of $target]`'. * Function with multiple parameters: `SNCLog-ParameterInfo @("Running functionName", $param1, $param2, $param3)` {#mid-server-powershell-files__ul_azp_p4l_4bb} | | SNCObfuscate-Value | Use this utility to encrypt values for security purposes. The function displays `"$variableName":***`, where \*\*\* is the obfuscated value. Example: `SNCObfuscate-Value $password` Note: The debug message reads: `"$password : ***"`. | [Table 2. PowerShell diagnostic utilities] {#mid-server-powershell-files__table_sd2_vkl_4bb} ## Credentials.psm1 The MID Server uses this module file to test access to a target host. The MID Server loops through all Windows credentials stored in its credentials table using the following access type functions, unless the PowerShell activity has a credential type (credType) defined. All ServiceNow® authored PowerShell activities are hard-coded to use a specific credential type. As a result, the MID Server only tests credential access against the designated function.{#mid-server-powershell-files__table_qmm_z1p_cw__entry__2} | Function | Description | |-|-| | testCredentialWMI | Tests the given user and password on the target host using the Get-WMI object. | | testCredentilAD | Tests the given user and password on the target host using the built-in DirectoryEntry object. | | testCredentialExchange | Tests the given user and password to create a session on an Exchange host. This test uses the built-in PowerShell remoting feature on a remote host. WinRM is configured on Exchange servers by default. | | testCredentialSCCM | Tests the given user and password to create a session on an SCCM server. This test uses the built-in PowerShell remoting feature on a remote host. This test requires WinRM to be configured. | | testNoCredentialAccessWMI | Tests the given user and password on the target host, using the Get-WMI object. This test is used when no credType is used. | [Table 3. PowerShell test functions] {#mid-server-powershell-files__table_qmm_z1p_cw} Note: If the test passes using one of these functions, that credential is used to run the PowerShell script/command. If the tests fail to access the target host using these functions, the MID Server runs the PowerShell script/command under the account of the MID Server service. This diagram illustrates the dependency of the credential selection behavior on the host being targeted by the PowerShell activity. If the target host is the IP address or host name of the MID Server, the MID Server bypasses all credentials in the Credentials table and uses the account of the MID Server service. If the target host is not the MID Server, then all Windows credentials are used first. If all credentials in the Credentials table are unsuccessful in running the PowerShell activity, then the MID Server uses the MID Server service account. Figure 2. PowerShell credential selection criteria ## ActiveDirectory.psm1 This module file stores the functions used by the PowerShell scripts shipped with the [Active Directory](https://www.servicenow.com/docs/access?context=c_OrchActiveDirectoryActivities&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US) activity pack. ## Exchange.psm1 This module file stores the functions used by the PowerShell scripts shipped with the [Exchange](https://www.servicenow.com/docs/UHba7jCSZaKvv4xVzHj7IA "The Exchange activity pack allows workflows to manage Microsoft Exchange mail systems.") activity pack. ## SCCM.psm1 This module file stores the functions used by the PowerShell scripts shipped with the [SCCM](https://www.servicenow.com/docs/DjHKiVCnJIKgtI1XjbHTCQ "The Microsoft System Center Configuration Management (SCCM) activity pack provides Orchestration activities you can use to manage software deployments and collections on an SCCM server.") activity pack.