Skip to content

Import-PSRyverConfig

SYNOPSIS

Import a PSRyver module configuration from file.

SYNTAX

Import-PSRyverConfig [[-Path] <FileInfo>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Import a PSRyver module configuration from file and set the $Script:PSRyver module configuration variable.

EXAMPLES

EXAMPLE 1

Import-PSRyverConfig

Loads the PSRyver module configuration to $Script:PSRyver from the default file path stored in $Script:PSRyverConfigFilePath. which can be accessed via Get-PSRyverConfigPath and set via Set-PSRyverConfigPath.

The default location is '~/.psryver.xml'

EXAMPLE 2

Import-PSRyverConfig -Path '~/.psryver.xml'

Loads the PSRyver module configuration from '~/.psryver.xml' to $Script:PSRyver.

EXAMPLE 3

'~/.psryver.xml' | Export-PSRyverConfig

Loads the PSRyver module configuration from '~/.psryver.xml', specified via the pipeline, to $Script:PSRyver.

EXAMPLE 4

Import-PSRyverConfig '~/.psryver.xml'

Loads the PSRyver module configuration from '~/.psryver.xml', specified via positional parameter, to $Script:PSRyver.

PARAMETERS

-Path

Specifies the PSRyver config file to import.

Type: FileInfo
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

INPUTS

System.IO.FileInfo

OUTPUTS

System.Void

NOTES

  • Troy Lindsay
  • Twitter: @troylindsay42
  • GitHub: tlindsay42

https://tlindsay42.github.io/PSRyver/Public/Import-PSRyverConfig/

https://github.com/tlindsay42/PSRyver/blob/master/PSRyver/Public/Import-PSRyverConfig.ps1

Export-PSRyverConfig

Read-PSRyverConfig

Get-PSRyverConfig

Set-PSRyverConfig

Get-PSRyverConfigPath

Set-PSRyverConfigPath