NAME

New-PSUScript

SYNOPSIS

Creates a new script within PowerShell Universal.

SYNTAX

New-PSUScript [-AppToken <String>] [-ComputerName <String>] [-Description <String>] [-DisableManualInvocation] [-ManualTime <Int32>] [-MaxHistory <Int32>] -Name <String> [-Notes <String>] [-Parameter <ScriptParameter[]>] [-Path <String>] -ScriptBlock <ScriptBlock> [-Status {Draft | Pending_Review | Published | Disabled}] [-Tag <Tag[]>] [-ConcurrentJobs <Int32>] [-Environment <String>] [-TimeOut <Double>] [-Credential <Variable>] [-UseDefaultCredentials] [-Integrated] [-RetryLimit <Int32>] [-DiscardPipeline] [-LoadProfile] [-WorkingDirectory <String>] [-Role <String[]>] [-AvailableInBranch <String[]>] [-PortalOutputType <PortalOutputType>] [-TrustCertificate] [-PortalOpenInNewWindow] [-Icon <String>] [-DisplayOutputOnExecute] [-PortalBehavior <ScriptPortalBehavior>] [-PortalLeaveForm] [<CommonParameters>]

New-PSUScript [-AppToken <String>] [-ComputerName <String>] [-Description <String>] [-DisableManualInvocation] [-ManualTime <Int32>] [-MaxHistory <Int32>] -Name <String> [-Notes <String>] [-Parameter <ScriptParameter[]>] -Path <String> [-Status {Draft | Pending_Review | Published | Disabled}] [-Tag <Tag[]>] [-ConcurrentJobs <Int32>] [-Environment <String>] [-TimeOut <Double>] [-Credential <Variable>] [-UseDefaultCredentials] [-Integrated] [-RetryLimit <Int32>] [-DiscardPipeline] [-LoadProfile] [-WorkingDirectory <String>] [-Role <String[]>] [-AvailableInBranch <String[]>] [-PortalOutputType <PortalOutputType>] [-TrustCertificate] [-PortalOpenInNewWindow] [-Icon <String>] [-DisplayOutputOnExecute] [-PortalBehavior <ScriptPortalBehavior>] [-PortalLeaveForm] [<CommonParameters>]

New-PSUScript [-AppToken <String>] [-ComputerName <String>] [-Description <String>] [-DisableManualInvocation] [-ManualTime <Int32>] [-MaxHistory <Int32>] [-Notes <String>] [-Parameter <ScriptParameter[]>] [-Status {Draft | Pending_Review | Published | Disabled}] [-Tag <Tag[]>] [-ConcurrentJobs <Int32>] [-Environment <String>] [-TimeOut <Double>] [-Credential <Variable>] [-UseDefaultCredentials] [-Integrated] [-RetryLimit <Int32>] [-DiscardPipeline] [-LoadProfile] [-WorkingDirectory <String>] -Command <String> -Module <String> [-Role <String[]>] [-AvailableInBranch <String[]>] [-PortalOutputType <PortalOutputType>] [-TrustCertificate] [-PortalOpenInNewWindow] [-Icon <String>] [-DisplayOutputOnExecute] [-PortalBehavior <ScriptPortalBehavior>] [-PortalLeaveForm] [<CommonParameters>]

DESCRIPTION

Creates a new script within PowerShell Universal. Scripts can be manually executed or scheduled inside PSU. Scripts created based on content will be written to the repository directory. Scripts created by path will be referenced by that path.

Script configurations are stored in .universal/scripts.ps1

You can also use this cmdlet to create scripts through the REST API.

PARAMETERS

-AppToken <String>

The AppToken that is used for calling the PowerShell Universal Management API. You can also call Connect-PSUServer before calling this cmdlet to set the AppToken for the entire session.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-ComputerName <String>

Specifies the computer name or URL that should be called when accessing the PowerShell Universal Management API. You can also use Connect-PSUServer before calling this cmdlet to set the computer name for the entire session.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases Uri

Accept wildcard characters? false

-Description <String>

The description of the script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DisableManualInvocation [<SwitchParameter>]

Disables manual invocation of the script. The script can only be run on a schedule.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-ManualTime <Int32>

The amount of time it would take to run this particular script manually.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-MaxHistory <Int32>

The maximum job history for this script. This defaults to 100.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Name <String>

The name of this script.

Required? true

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Notes <String>

Notes to include with this script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Parameter <ScriptParameter[]>

Obsolete

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Path <String>

The path to the script. This can be a relative path to the repository directory or an absolute path.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-ScriptBlock <ScriptBlock>

A script block to define for this script.

Required? true

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Status <ScriptStatus>

Not used.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Tag <Tag[]>

Tags to assign to this script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-ConcurrentJobs <Int32>

The number of concurrent jobs that are allowed for this script. By default, there is no limit.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Environment <String>

The environment to run this script within.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-TimeOut <Double>

The number of minutes before jobs based on this script will time out.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Credential <Variable>

The user credential variable to use when executing this script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-UseDefaultCredentials [<SwitchParameter>]

Use default credentials when connecting to the management API

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Integrated [<SwitchParameter>]

Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-RetryLimit <Int32>

The number of times to retry this script if it fails.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DiscardPipeline [<SwitchParameter>]

Whether to discard pipeline output rather than persist it in the database.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-LoadProfile [<SwitchParameter>]

Loads the user profile when running this script as another user.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-WorkingDirectory <String>

The working directory of the script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Command <String>

The command that defines this script.

Required? true

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Module <String>

The module that contains the command that defines this script.

Required? true

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Role <String[]>

The role that is required to execute this script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-AvailableInBranch <String[]>

When specified, this script will only be available in the specified branches.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-PortalOutputType <PortalOutputType>

The type of portal output to display when running this script in the portal.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-TrustCertificate [<SwitchParameter>]

Whether the cmdlet should ignore certificate issues.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-PortalOpenInNewWindow [<SwitchParameter>]

Whether to open this script in a new window when viewing it in the portal.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Icon <String>

An icon to display in the portal.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DisplayOutputOnExecute [<SwitchParameter>]

Displays output of the script while it is executing in the portal.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-PortalBehavior <ScriptPortalBehavior>

How this script behaves in the portal.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-PortalLeaveForm [<SwitchParameter>]

Whether to leave the script's form after executing it in the portal.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

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

None

OUTPUTS

System.Object

NOTES

-------------------------- Example 1 --------------------------

New-PSUScript -Name 'Script1.ps1' -Path 'Script1.ps1'

Creates a script within PSU that references a relative path of Script1.ps1 in the repository folder.

-------------------------- Example 2 --------------------------

New-PSUScript -Name 'Script1.ps1' -ScriptBlock {

"Hello, world!"

}

Creates a script within PSU based on the script block provided. This will create a Script1.ps1 file within the repository directory.

RELATED LINKS

Get-PSUScript

Remove-PSUScript

Invoke-PSUScript

Set-PSUScript

Get-PSUEnvironment