Set-DbatoolsPath

NAME Set-DbatoolsPath



SYNOPSIS

Configures or updates a path under a name.





SYNTAX

Set-DbatoolsPath -Name <String> -Path <String> [<CommonParameters>]



Set-DbatoolsPath -Name <String> -Path <String> -Register <Switch> [-Scope

<Sqlcollaborative.Dbatools.Configuration.ConfigScope>] [<CommonParameters>]





DESCRIPTION

Configures or updates a path under a name.



The path can be persisted using the "-Register" command.



Paths setup like this can be retrieved using Get-DbatoolsPath.





PARAMETERS

-Name [<String>]

Name the path should be stored under.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Path [<String>]

The path that should be returned under the name.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Register [<Switch>]

Registering a path in order for it to persist across sessions.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Scope [<Sqlcollaborative.Dbatools.Configuration.ConfigScope>]

The configuration scope it should be registered under.

Defaults to UserDefault.

Configuration scopes are the default locations configurations are being stored at.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Set-DbatoolsPath -Name 'temp' -Path 'C:\\temp'



Configures C:\\temp as the current temp path. (does not override $env:temp !)



RELATED LINKS