# Parameters

## Parameters

Jobs support automatically generating forms with parameters based on your script's `param` block. The type of control will change based on the type you define in the block. Parameters that are mandatory will also be required by the UI.

### Basic Parameters

Parameters can be simply defined without any type of parameter attribute and they will show up as text boxes in the UI.

```powershell
param($Test)

$Test
```

### Parameters Types

Universal supports various types of parameters. You can use String, String\[], Int, DateTime, Boolean, Switch and Enum types.

#### String

You can define string parameters by specifying the `[String]` type of by not specifying a type at all. Strings will generate a textbox.

```powershell
param(
    [String]$Textbox,
    $Textbox2
)
```

![](/files/Qml4zywSOdzhGvsVmycM)

#### String Arrays

You can specify string arrays by using the `[String[]]` type specifier. String arrays will generate a multi-tag select box.

```powershell
param([String[]]$Array)
```

![](/files/p0Bv0j3F3G4OYejgiCoz)

#### Date and Time

You can use the `[DateTime]` type specifier to create a date and time selector.

```powershell
param([DateTime]$DateTime)
```

![](/files/l6PwgbDJw7muP5dKJnRA)

#### Boolean

You can use a `[Bool]` type selector to create a switch.

```powershell
param([Bool]$Switch)
```

![](/files/uFqWuuwrnH2zwsDIHznf)

#### Integer

You can define a number selector by using the `[Int]` type specifier.

```powershell
param([Int]$Number)
```

![](/files/iBWz1TpZQQsWwALHb412)

#### Switch Parameter

You can define a switch parameter using the `[Switch]` type specifier to create a switch.

```powershell
param([Switch]$Switch)
```

![](/files/dmfC6H3zuSt6xkXeEizX)

#### Enumerations

You can use System.Enum values to create select boxes. For example, you could use the `System.DayOrWeek` to create a day of the week selection box.

```powershell
param([System.DayOfWeek]$DayOfWeek)
```

![](/files/b2jPGCPuSbcfdeiEfEXN)

#### PSCredential

When you specify a `PSCredential` , the user will be presented with a drop down of credentials available as [variables](/platform/variables.md#creating-a-secret-variable).

```powershell
param(
    [PSCredential]$Credential
)
```

![](/files/2JILjQOFFVvB8Ratf1Ln)

#### File

You can allow users to upload files by using the `[File]` type.

```powershell
param(
    [File]$File
)
```

Files will be available as a `PSUFile` object in your scripts. This object has a `byte[]` array that you can use to process the file.

For example, you can get the string content for the file by converting it using the Encoding classes.

```powershell
[Text.Encoding]::UTF8.GetString($File.Content)
```

### Display Name

You can use the `DisplayNameAtrribute` to set a display name for the script parameter.

```powershell
param(
    [ComponentModel.DisplayName("My Script")]
    $MyScript
)
```

![](/files/L2M2uH5WWVGeE0ZEZZ4k)

### Help Messages

You can define help messages for your parameters by using the `HelpMessage` property of the `Parameter` attribute.

```powershell
param(
    [Parameter(HelpMessage = "Class you want to enroll in")]
    [string]$Class
)
```

![](/files/ZMxv4sG8gfmpDFedfR7g)

### Required Parameters

You can use the Parameter attribute to define required parameters.

```powershell
param(
    [Parameter(Mandatory)]
    $RequiredParameter
)

$RequiredParameter
```

![](/files/zpQqTh4JUMBgbM4r9L7a)

### Default Value

You can use both static and default values for parameters. The default value is calculated when the job is about to be run.

```powershell
param(
    $Parameter = "Hello, World",
    [DateTime]$ExecutionTime = Get-Date
)

$Parameter
$ExecutionTime
```

## ValidateSet

The `ValidateSet` attribute is used to enforce which values can be passed to a parameter. Learn about [ValidateSet here.](https://duckduckgo.com/?q=validateset\&ia=web) PowerShell Universal will automatically create a drop-down menu with the values provided to the `ValidateSet` attribute for parameters.

For example, a script could define a param block as follows.

```powershell
param(
    [ValidateSet("Steve", "Mary")]
    [string]$Name
)
```

The result is shown below.

<figure><img src="/files/1Fl9LxivUGl4inqvxz1S" alt=""><figcaption><p>ValidateSet Attribute</p></figcaption></figure>

## Passing Parameters from PowerShell

You can pass parameters from PowerShell using the `Invoke-PSUScript` cmdlet. This cmdlet supports dynamic parameters. If you have a `param` block on your script, these parameters will automatically be added to `Invoke-PSUScript`.

For example, I had a script named Script1.ps1 and the contents were are follows.

```powershell
param($MyParameter)

$MyParameter
```

I could then invoke that script using this syntax.

```powershell
Invoke-PSUScript -Name 'Script.ps1' -MyParameter "Hello"
```

The result would be that Hello was output in the job log and pipeline.

## Parameter Sets

PowerShell Universal supports parameter sets. When a parameter set is defined, a drop down is provided that allows for switching between the sets.

```powershell
param(
    [Parameter(ParameterSetName = 'Set1')]
    $Parameter1,
    [Parameter(ParameterSetName = 'Set2')]
    $Parameter2
)
```

![Parameter Sets](/files/A3Gv5RHwF2ZbkJSp32jP)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.powershelluniversal.com/automation/scripts/parameters.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.