Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 2.35 KB

Import-PSRemoteOpPath.md

File metadata and controls

104 lines (70 loc) · 2.35 KB
external help file Module Name online version schema
PSRemoteOperations-help.xml
PSRemoteOperations
2.0.0

Import-PSRemoteOpPath

SYNOPSIS

Import path settings for the PSRemoteOperations module

SYNTAX

Import-PSRemoteOpPath [[-Path] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This command will import the PSRemoteOPPath.json file in the module directory, and define the $PSRemoteOpPath and $PSRemoteOpArchive global variables. This settings file should be created with Register-PSRemoteOpPath. Normally, you should not need to run this command as settings are imported and defined when the module is imported.

EXAMPLES

Example 1

PS C:\> Import-PSRemoteOpPath

Import the settings which were created with Register-PSRemoteOpPath. The settings file is stored in the module root by default. But you can specify a path for testing purposes.

PARAMETERS

-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

-Path

Enter the path to the remote opertion path json file. You should normally use the default but you can specify an alternate path for testing purposes.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: $PSScriptRoot\psremoteoppath.json
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.

INPUTS

None

OUTPUTS

System.Object

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Register-PSRemoteOpPath