Main | Contact | Blog | Documentation

PowerShell Framework

The project dedicated to empowering your PowerShell scripting.

Export-PSFConfig

SYNOPSIS

Exports configuration items to a Json file.

SYNTAX

FullName (Default)

Export-PSFConfig [-FullName] <String> [-OutPath] <String> [-SkipUnchanged] [-EnableException]
 [<CommonParameters>]

Module

Export-PSFConfig [-Module] <String> [[-Name] <String>] [-OutPath] <String> [-SkipUnchanged] [-EnableException]
 [<CommonParameters>]

Config

Export-PSFConfig [-Config] <Config[]> [-OutPath] <String> [-SkipUnchanged] [-EnableException]
 [<CommonParameters>]

ModuleName

Export-PSFConfig -ModuleName <String> [-ModuleVersion <Int32>] [-Scope <ConfigScope>] [-SkipUnchanged]
 [-EnableException] [<CommonParameters>]

DESCRIPTION

Exports configuration items to a Json file.

EXAMPLES

EXAMPLE 1

Get-PSFConfig | Export-PSFConfig -OutPath '~/export.json'

Exports all current settings to json.

EXAMPLE 2

Export-PSFConfig -Module MyModule -OutPath '~/export.json' -SkipUnchanged

Exports all settings of the module ‘MyModule’ that are no longer the original default values to json.

PARAMETERS

-FullName

Select the configuration objects to export by filtering by their full name.

Type: String
Parameter Sets: FullName
Aliases:

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

-Module

Select the configuration objects to export by filtering by their module name.

Type: String
Parameter Sets: Module
Aliases:

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

-Name

Select the configuration objects to export by filtering by their name.

Type: String
Parameter Sets: Module
Aliases:

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

-Config

The configuration object(s) to export. Returned by Get-PSFConfig.

Type: Config[]
Parameter Sets: Config
Aliases:

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

-ModuleName

Exports all configuration pertinent to a module to a predefined path. Exported configuration items include all settings marked as ‘ModuleExport’ that have been changed from the default value.

Type: String
Parameter Sets: ModuleName
Aliases:

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

-ModuleVersion

The configuration version of the module-settings to write.

Type: Int32
Parameter Sets: ModuleName
Aliases:

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

-Scope

Which predefined path to write module specific settings to. Only file scopes are considered. By default it writes to the suer profile.

Type: ConfigScope
Parameter Sets: ModuleName
Aliases:
Accepted values: UserDefault, UserMandatory, SystemDefault, SystemMandatory, FileUserLocal, FileUserShared, FileSystem

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

-OutPath

The path (filename included) to export to. Will fail if the folder does not exist, will overwrite the file if it exists.

Type: String
Parameter Sets: FullName, Module, Config
Aliases:

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

-SkipUnchanged

If set, configuration objects whose value was not changed from its original value will not be exported. (Note: Settings that were updated with the same value as the original default will still be considered changed)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-EnableException

This parameters disables user-friendly warnings and enables the throwing of exceptions. This is less user friendly, but allows catching exceptions in calling scripts.

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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES