How to handle command-line arguments in PowerShell

Handling command-line arguments in PowerShell typically involves several key steps. I will demonstrate how to accomplish this task using a specific example.

Step 1: Defining Parameters

At the beginning of a PowerShell script, we typically use the param block to define expected command-line arguments. This helps us set default values, types, and other attributes.

For example, suppose we have a script that requires the user to input a username and password. We can define the parameters as follows:

powershell
param (
    [string]$Username,
    [string]$Password
)

Step 2: Using Parameters

After defining the parameters, we can use them within the script.

powershell
Write-Host "The username provided is: $Username"
Write-Host "The password provided is: $Password"

Step 3: Passing Parameters

When running the script, we can directly pass these parameters from the command line.

shell
powershell .\script.ps1 -Username "admin" -Password "123456"

Advanced Usage

Using Parameter Validation

PowerShell allows us to validate parameters, such as checking the password length:

powershell
param (
    [string]$Username,
    [ValidateLength(6,20)]
    [string]$Password
)

Setting Optional Parameters and Default Values

If certain parameters are optional, we can provide default values for them:

powershell
param (
    [string]$Username = "guest",
    [string]$Password
)

This means that if the user does not provide a username, the script will default to 'guest'.

Example Script

Combining the above elements, a complete example script is as follows:

powershell
param (
    [string]$Username = "guest",
    [ValidateLength(6,20)]
    [string]$Password
)

Write-Host "The username provided is: $Username"
if ($Password) {
    Write-Host "The password provided is: $Password"
} else {
    Write-Host "No password provided"
}

This approach enables flexible handling of user-provided command-line arguments within the script, while also incorporating parameter validation and default value settings.