Import-HtmlBrowserSession
August 3, 2026 ยท View on GitHub
SYNOPSIS
Cmdlet that restores a browser session from a previously exported state file.
SYNTAX
__AllParameterSets
Import-HtmlBrowserSession [-Path] <string> [-Url] <string> [-Browser <HtmlBrowserEngine>] [-Clean] [-Visible] [-SlowMo <int>] [-Timeout <int>] [-UserAgent <string>] [-ViewportWidth <Int32>] [-ViewportHeight <Int32>] [-DeviceScaleFactor <Double>] [-GeoLatitude <Double>] [-GeoLongitude <Double>] [-Timezone <string>] [-NoDefault] [-CancellationToken <CancellationToken>] [<CommonParameters>]
DESCRIPTION
Cmdlet that restores a browser session from a previously exported state file.
EXAMPLES
EXAMPLE 1
Import-HtmlBrowserSession -Path 'C:\Path'
PARAMETERS
-Browser
Browser engine used for launching the session.
Type: HtmlBrowserEngine
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Chromium, Firefox, WebKit
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CancellationToken
Token used to cancel the operation.
Type: CancellationToken
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Clean
Reinstall browser runtimes before starting.
Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DeviceScaleFactor
Scaling factor for high DPI devices.
Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GeoLatitude
Latitude used for geolocation.
Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GeoLongitude
Longitude used for geolocation.
Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NoDefault
Do not store this session as the default.
Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
Path to the saved session state.
Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SlowMo
Delay in milliseconds between actions.
Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timeout
Timeout in milliseconds for browser operations.
Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timezone
Timezone identifier.
Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Url
URL to navigate to.
Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserAgent
User agent string used when launching the browser.
Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ViewportHeight
Viewport height in pixels.
Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ViewportWidth
Viewport width in pixels.
Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Visible
Show the browser instead of running headless.
Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:
Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None
OUTPUTS
HtmlTinkerX.HtmlBrowserSession
RELATED LINKS
- None