Export PSProfileConfiguration

Export-PSProfileConfiguration

SYNOPSIS

Exports the PSProfile configuration as a PSD1 file to the desired path.

SYNTAX

Export-PSProfileConfiguration [-Path] <String> [-IncludeVault] [-Force] [<CommonParameters>]

DESCRIPTION

Exports the PSProfile configuration as a PSD1 file to the desired path.

EXAMPLES

EXAMPLE 1

Export-PSProfileConfiguration ~\MyPSProfileConfig.psd1

Exports the configuration to the specified path.

EXAMPLE 2

Export-PSProfileConfiguration ~\MyScripts -Force

Exports the configuration to the resolved path of '~\MyScripts\PSProfile.Configuration.psd1' and overwrites the file if it already exists. The exported configuration does not include the Vault to prevent secrets from being migrated with the portable configuration that is exported.

PARAMETERS

-Path

The existing folder or file path with PSD1 extension to export the configuration to. If a folder path is provided, the configuration will be exported to the path with the file name 'PSProfile.Configuration.psd1'.

Type: String
Parameter Sets: (All)
Aliases:

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

-IncludeVault

If $true, includes the Vault property as well so Secrets are also exported.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Force

If $true and the resolved file path exists, overwrite it with the current configuration.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

RELATED LINKS