Skip to content

Restore-PodeState

SYNOPSIS

Restores the shared state from some JSON file.

SYNTAX

Restore-PodeState [-Path] <String> [-Merge] [[-Depth] <Int16>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Restores the shared state from some JSON file.

EXAMPLES

EXAMPLE 1

Restore-PodeState -Path './state.json'

PARAMETERS

-Depth

Saved JSON maximum depth. Will be passed to ConvertFrom-JSON's -Depth parameter (Powershell >=6). Default is 10.

Type: Int16
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 10
Accept pipeline input: False
Accept wildcard characters: False

-Merge

If supplied, the state loaded from the JSON file will be merged with the current state, instead of overwriting it.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Path

The path to a JSON file that contains the state information.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

OUTPUTS

NOTES