Скачать или смотреть How to Run a PowerShell Script with Switch Parameters

Discover how to effectively use `switch` parameters in PowerShell scripts to simplify argument handling. Learn step-by-step how to implement this method for streamlined script execution.
---
This video is based on the question https://stackoverflow.com/q/64066637/ asked by the user 'Roi Shidlovsky' ( https://stackoverflow.com/u/1543852/ ) and on the answer https://stackoverflow.com/a/64066900/ provided by the user 'Uuuuuumm' ( https://stackoverflow.com/u/11744237/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: running PS script with arguments

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Run a PowerShell Script with Switch Parameters

If you're venturing into PowerShell scripting, you might have encountered the need to pass arguments to your scripts in various formats. One common scenario is running a PowerShell script with flags or switches. This guide addresses a specific question: how to run a PowerShell script with a flag, using the command script.ps1 -archive. If you've ever felt perplexed about whether this is possible, rest assured that it is achievable—and we’ll guide you through the process.

Understanding Parameters and Switches

Before diving into the solution, let’s first clarify what parameters and switches are in PowerShell:

Parameters: These are named arguments you pass to a script or function. For example, -archive=true sets the value of the archive parameter to true.

Switches: A switch is a specific type of parameter that acts as a flag. It does not require a value. Instead, if the switch is specified, it evaluates to $true; if not specified, it evaluates to $false.

For instance, if you call script.ps1 -archive, the switch activates, and $archive will be $true. If you don't include it, $archive will be $false by default.

Implementing Switch Parameters in Your Script

To run your PowerShell script with a switch parameter, you will need to define this parameter within your script first. Here’s how you can do it step-by-step:

Step 1: Define Your Parameters

At the beginning of your PowerShell script, you will want to include a param block where you define your parameters. Here’s an example:

[[See Video to Reveal this Text or Code Snippet]]

Step 2: Understanding the Default Value

In this definition:

$randomParameter can accept a string value.

$archive is defined as a switch. The = $false means that if the script is run without the -archive switch, it will default to false.

Step 3: Utilizing the Switch in the Script

Now that you have defined the parameters, you can utilize the $archive switch in your script. For example:

[[See Video to Reveal this Text or Code Snippet]]

Step 4: Running Your Script

Finally, you can run your script as follows:

To include the switch:

[[See Video to Reveal this Text or Code Snippet]]

In this case, the $archive variable will be $true.

To omit the switch:

[[See Video to Reveal this Text or Code Snippet]]

Here, the $archive variable will be $false.

Conclusion

Running a PowerShell script with a switch (like -archive) is straightforward once you understand how to define and use parameters. By following the steps outlined above, you can enhance your scripts to accept various forms of user input seamlessly. Incorporating switches into your scripts not only streamlines your code but also makes it more user-friendly.

Whether you’re a seasoned PowerShell scripter or just starting, utilizing switches can significantly simplify your scripting experience. Happy scripting!