Start-PSFRunspace

NAME Start-PSFRunspace



SYNOPSIS

Starts a runspace that was registered to the PSFramework





SYNTAX

Start-PSFRunspace [[-Name] <String[]>] [[-Runspace] <RunspaceContainer[]>] [-NoMessage] [-EnableException]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Starts a runspace that was registered to the PSFramework

Simply registering does not automatically start a given runspace. Only by executing this function will it take

effect.





PARAMETERS

-Name <String[]>

The name of the registered runspace to launch



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Runspace <RunspaceContainer[]>

The runspace to launch. Returned by Get-PSFRunspace



Required? false

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-NoMessage [<SwitchParameter>]

Setting this will prevent messages be written to the message / logging system.

This is designed to make the PSFramework not flood the log on each import.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-EnableException [<SwitchParameter>]

This parameters disables user-friendly warnings and enables the throwing of exceptions.

This is less user friendly, but allows catching exceptions in calling scripts.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

If this switch is enabled, no actions are performed but informational messages will be displayed that explain

what would happen if the command were to run.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

If this switch is enabled, you will be prompted for confirmation before executing any operations that change

state.



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:\\>Start-PSFRunspace -Name 'mymodule.maintenance'



Starts the runspace registered under the name 'mymodule.maintenance'











RELATED LINKS