Share via

Test-PSSessionConfigurationFile

  • Reference
Module:
Microsoft.PowerShell.Core

Verifies the keys and values in a session configuration file.

Syntax

Test-PSSessionConfigurationFile
    [-Path] <String>
    [<CommonParameters>]

Description

This cmdlet is only available on the Windows platform.

This cmdlet verifies that a session configuration file contains valid keys and the values are of the correct type. For enumerated values, the cmdlet verifies that the specified values are valid.

The cmdlet returns $True if the file passes all tests and $False if it does not. To find any errors, use the Verbose parameter.

Test-PSSessionConfigurationFile verifies the session configuration files, such as those created by the New-PSSessionConfigurationFile cmdlet. For information about session configurations, see about_Session_Configurations. For information about session configuration files, see about_Session_Configuration_Files.

This cmdlet was introduced in PowerShell 3.0.

Examples

Example 1: Test a session configuration file

Test-PSSessionConfigurationFile -Path "FullLanguage.pssc"

True

Example 2: Test the session configuration file of a session configuration

In this example, we test the configuration file used in the Restricted session configuration. The value of the Path parameter is the result of the Get-PSSessionConfiguration command that gets the Restricted session configuration. The path of the session configuration file is stored in the value of the ConfigFilePath property of the session configuration.

Test-PSSessionConfigurationFile -Path (Get-PSSessionConfiguration -Name Restricted).ConfigFilePath

Example 3: Test all session configuration files

The function in this example tests all session configuration files on the local computer. The function uses the Get-PSSessionConfiguration cmdlet to get all session configurations. The code inside the ForEach-Object loop displays the file path and tests each of the session configurations.

function Test-AllConfigFiles
{
    Get-PSSessionConfiguration | ForEach-Object {
        if ($_.ConfigFilePath) {
            $_.ConfigFilePath
            Test-PSSessionConfigurationFile -Verbose -Path $_.ConfigFilePath
        }
    }
}
Test-AllConfigFiles

C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\Empty_6fd77bf6-e084-4372-bd8a-af3e207354d3.pssc
True
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\Full_1e9cb265-dae0-4bd3-89a9-8338a47698a1.pssc
VERBOSE: The member 'AliasDefinitions' must contain the required key 'Description'. Add the require key
to the fileC:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\Full_1e9cb265-dae0-4bd3-89a9-8338a47698a1.pssc.
False
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\NoLanguage_0c115179-ff2a-4f66-a5eb-e56e5692ba22.pssc
True
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\RestrictedLang_b6bd9474-0a6c-4e06-8722-c2c95bb10d3e.pssc
True
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\RRS_3fb29420-2c87-46e5-a402-e21436331efc.pssc
True

The ConfigFilePath property of a session configuration contains the path of the session configuration file that is used in the session configuration, if any.

If the value of the ConfigFilePath property is populated (is true), the command gets (prints) the ConfigFilePath property value. Then it uses the Test-PSSessionConfigurationFile cmdlet to test the file in the ConfigFilePath value. The Verbose parameter returns the file error when the file fails the test.

Parameters

-Path

Specifies the path and filename of a session configuration file (.pssc). If you omit the path, the default is the current folder. Wildcard characters are supported, but they must resolve to a single file. You can also pipe a session configuration file path to Test-PSSessionConfigurationFile.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

Inputs

String

You can pipe a session configuration file path to Test-PSSessionConfigurationFile.

Outputs

Boolean

Notes

This cmdlet is only available on Windows platforms.