PowerShellでの引数の扱い方とは？Paramを使った様々なオプションや記述方法を紹介

この記事でわかること

PowerShellでの引数の扱い方について紹介します！

今回は、PowerShellでの引数の扱い方について説明します。
引数を扱うにはParamを使用します。
ここでは、PowerShellのスクリプトファイルであるps1ファイルを作成・実行するケースとします。

PowerShellでの引数の扱い方に興味のある方はぜひご覧ください。

引数の基本的な使い方

PowerShellでの引数の基本的な使い方について紹介します。
実際のコマンドを見てみましょう。

Param( $name, $age ) Write-Host "name: $name" Write-Host "age: $age"

1 2 3 4

Param( $name, $age )   Write-Host "name: $name" Write-Host "age: $age"

実行結果は以下のようになります。

PS C:\test> .\pstest.ps1 "taro" 20 name: taro age: 20 PS C:\test> # -name, -ageを付与すると、順番を入れ替えても構いません。 PS C:\test> .\pstest.ps1 -age 20 -name "taro" name: taro age: 20 PS C:\test>

1 2 3 4 5 6 7 8

PS C:\test> .\pstest.ps1 "taro" 20 name: taro age: 20 PS C:\test> # -name, -ageを付与すると、順番を入れ替えても構いません。 PS C:\test> .\pstest.ps1 -age 20 -name "taro" name: taro age: 20 PS C:\test>

型指定

PowerShellでの引数の型指定の方法について紹介します。

実際のコマンドを見てみましょう。

Param( [string]$name, [int]$age ) Write-Host "name: $name" Write-Host "age: $age"

1 2 3 4

Param( [string]$name, [int]$age )   Write-Host "name: $name" Write-Host "age: $age"

実行結果は以下のようになります。

PS C:\test> .\pstest.ps1 -name "taro" -age "20" name: taro age: 20 PS C:\test> .\pstest.ps1 -name "taro" -age "jiro" C:\test\pstest.ps1 : パラメーター 'age' の引数変換を処理できません。値 "jiro" を型 "System.Int32" に変換できません。エ ラー: "入力文字列の形式が正しくありません。" 発生場所 行:1 文字:32 + .\pstest.ps1 -name "taro" -age "jiro" + ~~~~~~ + CategoryInfo : InvalidData: (:) [pstest.ps1]、ParameterBindingArgumentTransformationException + FullyQualifiedErrorId : ParameterArgumentTransformationError,pstest.ps1 PS C:\test>

1 2 3 4 5 6 7 8 9 10 11 12 13

PS C:\test> .\pstest.ps1 -name "taro" -age "20" name: taro age: 20 PS C:\test> .\pstest.ps1 -name "taro" -age "jiro" C:\test\pstest.ps1 : パラメーター 'age' の引数変換を処理できません。値 "jiro" を型 "System.Int32" に変換できません。エ ラー: "入力文字列の形式が正しくありません。" 発生場所 行:1 文字:32 + .\pstest.ps1 -name "taro" -age "jiro" +                                ~~~~~~     + CategoryInfo          : InvalidData: (:) [pstest.ps1]、ParameterBindingArgumentTransformationException     + FullyQualifiedErrorId : ParameterArgumentTransformationError,pstest.ps1   PS C:\test>

文字列の数字を入力するとintにキャストしますが、キャストできない文字列を入力するとエラーになります。

必須オプション

PowerShellでの引数を必須にする方法について紹介します。mandatory=$trueを指定します。

実際のコマンドを見てみましょう。

Param( [parameter(mandatory=$true)][string]$name, [parameter(mandatory=$true)][int]$age ) Write-Host "name: $name" Write-Host "age: $age"

1 2 3 4 5

Param( [parameter(mandatory=$true)][string]$name,        [parameter(mandatory=$true)][int]$age )   Write-Host "name: $name" Write-Host "age: $age"

実行結果は以下のようになります。

PS C:\test> # 引数入力時 PS C:\test> .\pstest.ps1 -name "taro" -age 20 name: taro age: 20 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1 -name "taro" コマンド パイプライン位置 1 のコマンドレット pstest.ps1 次のパラメーターに値を指定してください: age: 20 name: taro age: 20 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1 コマンド パイプライン位置 1 のコマンドレット pstest.ps1 次のパラメーターに値を指定してください: name: taro age: 20 name: taro age: 20 PS C:\test>

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

PS C:\test> # 引数入力時 PS C:\test> .\pstest.ps1 -name "taro" -age 20 name: taro age: 20 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1 -name "taro"   コマンド パイプライン位置 1 のコマンドレット pstest.ps1 次のパラメーターに値を指定してください: age: 20 name: taro age: 20 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1   コマンド パイプライン位置 1 のコマンドレット pstest.ps1 次のパラメーターに値を指定してください: name: taro age: 20 name: taro age: 20 PS C:\test>

デフォルト値

PowerShellでの引数のデフォルト値を設定する方法について紹介します。

実際のコマンドを見てみましょう。

Param( [string]$name = "jiro", [int]$age = 30 ) Write-Host "name: $name" Write-Host "age: $age"

1 2 3 4 5

Param( [string]$name = "jiro",        [int]$age = 30 )   Write-Host "name: $name" Write-Host "age: $age"

実行結果は以下のようになります。

PS C:\test> .\pstest.ps1 -name "taro" -age 20 name: taro age: 20 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1 -name "taro" name: taro age: 30 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1 name: jiro age: 30 PS C:\test>

1 2 3 4 5 6 7 8 9 10 11 12

PS C:\test> .\pstest.ps1 -name "taro" -age 20 name: taro age: 20 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1 -name "taro" name: taro age: 30 PS C:\test> # 引数省略時 PS C:\test> .\pstest.ps1 name: jiro age: 30 PS C:\test>

配列

PowerShellでは引数を配列で受け取ることもできます。

実際のコマンドを見てみましょう。

Param( [array]$array ) $array Write-Host "length: " $array.Length $array.GetType()

1 2 3 4 5

Param( [array]$array )   $array Write-Host "length: " $array.Length $array.GetType()

実行結果は以下のようになります。

PS C:\test> .\pstest.ps1 "taro","jiro","saburo" taro jiro saburo length: 3 IsPublic IsSerial Name BaseType -------- -------- ---- -------- True True Object[] System.Array PS C:\test>

1 2 3 4 5 6 7 8 9 10 11 12

PS C:\test> .\pstest.ps1 "taro","jiro","saburo" taro jiro saburo length:  3   IsPublic IsSerial Name                                     BaseType -------- -------- ----                                     -------- True     True     Object[]                                 System.Array     PS C:\test>

配列の要素数に制限を設けることもできます。ValidateCountを使用します。

Param( [ValidateCount(1,5)][array]$array ) $array Write-Host "length: " $array.Length $array.GetType()

1 2 3 4 5

Param( [ValidateCount(1,5)][array]$array )   $array Write-Host "length: " $array.Length $array.GetType()

実行結果は以下のようになります。

PS C:\test> .\pstest.ps1 "taro","jiro","saburo","shiro","goro" taro jiro saburo shiro goro length: 5 IsPublic IsSerial Name BaseType -------- -------- ---- -------- True True Object[] System.Array PS C:\test> # 要素数が5を超えるのでエラー PS C:\test> .\pstest.ps1 "taro","jiro","saburo","shiro","goro","rokuro" C:\test\pstest.ps1 : パラメーター 'array の引数を確認できません。指定された引数の数 (6) が、引数の最大許容数 (5) を超え ています。5 未満の数の引数を指定して、コマンドを再度実行してください。 発生場所 行:1 文字:14 + .\pstest.ps1 "taro","jiro","saburo","shiro","goro","rokuro" + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidData: (:) [pstest.ps1]、ParameterBindingValidationException + FullyQualifiedErrorId : ParameterArgumentValidationError,pstest.ps1 PS C:\test>

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

PS C:\test> .\pstest.ps1 "taro","jiro","saburo","shiro","goro" taro jiro saburo shiro goro length:  5   IsPublic IsSerial Name                                     BaseType -------- -------- ----                                     -------- True     True     Object[]                                 System.Array     PS C:\test> # 要素数が5を超えるのでエラー PS C:\test> .\pstest.ps1 "taro","jiro","saburo","shiro","goro","rokuro" C:\test\pstest.ps1 : パラメーター 'array の引数を確認できません。指定された引数の数 (6) が、引数の最大許容数 (5) を超え ています。5 未満の数の引数を指定して、コマンドを再度実行してください。 発生場所 行:1 文字:14 + .\pstest.ps1 "taro","jiro","saburo","shiro","goro","rokuro" +              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~     + CategoryInfo          : InvalidData: (:) [pstest.ps1]、ParameterBindingValidationException     + FullyQualifiedErrorId : ParameterArgumentValidationError,pstest.ps1   PS C:\test>

パイプライン引数

PowerShellでは引数をパイプラインから受け取ることができます。
ValueFromPipelineを使用します。

実際のコマンドを見てみましょう。

Param( [Parameter(ValueFromPipeline=$true)][string]$name, [Parameter(ValueFromPipeline=$false)][int]$age ) Write-Host "name: $name" Write-Host "age: $age"

1 2 3 4 5

Param( [Parameter(ValueFromPipeline=$true)][string]$name,        [Parameter(ValueFromPipeline=$false)][int]$age )   Write-Host "name: $name" Write-Host "age: $age"

実行結果は以下のようになります。

PS C:\test> "taro" | .\pstest.ps1 -age 20 name: taro age: 20

1 2 3

PS C:\test> "taro" | .\pstest.ps1 -age 20 name: taro age: 20

パイプラインから引数を受け取れていることが分かります。ValueFromPipelineを指定しないと以下のようになります。

Param( [string]$name, [int]$age ) Write-Host "name: $name" Write-Host "age: $age"

1 2 3 4

Param( [string]$name, [int]$age )   Write-Host "name: $name" Write-Host "age: $age"

実行結果は以下のようになります。

PS C:\test> "taro" | .\pstest.ps1 -age 20 name: age: 20 PS C:\test>

1 2 3 4

PS C:\test> "taro" | .\pstest.ps1 -age 20 name: age: 20 PS C:\test>

まとめ

いかがでしたでしょうか。
PowerShellでの引数の扱い方について説明しました。
引数を扱うにはParamを使用します。
Paramには様々なオプションや記述方法があり、そのうちのいくつかを紹介しました。

ぜひご自身でコマンドを書いて、理解を深めてください。

FEnetを運営しているネプラス株式会社はサービス開始から10年以上
『エンジニアの生涯価値の向上』をミッションに掲げ、
多くのインフラエンジニア・ネットワークエンジニアの就業を支援してきました。

ネプラス株式会社はこんな会社です

秋葉原オフィスにはネプラス株式会社をはじめグループのIT企業が集結！
数多くのエンジニアが集まります。

• インフラ業界に特化

  

  ネットワーク・サーバー・データベース等、ITインフラ業界に特化。Cisco Systemsプレミアパートナーをはじめ各種ベンダーのパートナー企業です。

  業界を知り尽くしているからこそ大手の取引先企業、経験豊富なエンジニアに選ばれています。

• 正社員なのにフリーランスのような働き方

  

  正社員の方でも希望を聞いたうえでプロジェクトをアサインさせていただいており、フリーランスのような働き方が可能。帰社日もありません。

  プロジェクト終了後もすぐに次の案件をご紹介させていただきますのでご安心ください。

• 大手直取引の高額案件

  

  案件のほとんどが大手SIerやエンドユーザーからの直取引のためエンジニアの皆様へに高く還元できています。

  Ciscoをはじめ、Juniper、Azure、Linux、AWS等インフラに特化した常時300件以上の案件があります。

• スキルアップ支援

  

  不要なコストを削減し、その分エンジニアの方へのスキルアップ支援(ネットワーク機器貸出、合格時の受験費用支給など)や給与で還元しています。

  受験費用例）CCNP,CCIE:6-20万円、JNCIS:3-4万円、AWS:1-3万円など

  ※業務に関連する一定の資格のみ。各種条件がありますので詳しくは担当者へにお尋ねください。

• 現給与を保証します！※

  

  前職の給与保証しており、昨年度は100%の方が給与アップを実現。収入面の不安がある方でも安心して入社していただけます。

  ※適用にはインフラエンジニアの業務経験1年以上、等一定の条件がございます。

• インセンティブ制度

  

  ネットワーク機器の販売・レンタル事業等、売上に貢献いただいた方にはインセンティブをお支払いしています。

  取引先企業とエンジニア側、双方にメリットがあり大変好評をいただいています。

• 社会保険・福利厚生

  

  社員の方は、社会保険を完備。健康保険は業界内で最も評価の高い「関東ITソフトウェア健康保険組合」です。

  さらに様々なサービスをお得に利用できるベネフィットステーションにも加入いただきます。

• 東証プライム上場企業グループ

  

  ネプラスは東証プライム上場「株式会社夢真ビーネックスグループ」のグループ企業です。

  安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。

ネプラス株式会社に興味を持った方へ

ネプラス株式会社では、インフラエンジニアを募集しています。

年収をアップしたい！スキルアップしたい！大手の上流案件にチャレンジしたい！
オンライン面接も随時受付中。ぜひお気軽にご応募ください。

新着案件New Job

• 【高額年収】/【CCNA取得者歓迎】/ネットワークの構築/BIG-IP/東京都千代田区/【WEB面談可】/在宅ワーク/20代～30代の方活躍中

  年収540万～540万円
  東京都千代田区(神保町駅)
  • CCNA
  • BIG-IP

• 東京都中央区/【WEB面談可/インフラサーバ経験者/20～40代の方活躍中】/在宅ワーク

  年収600万～600万円
  東京都中央区(小伝馬町駅)
  • Windows
  • Linux

• 【高額年収】/インフラ構築支援/東京都港区/【WEB面談可/インフラサーバ経験者/20～40代の方活躍中】/在宅ワーク

  年収960万～960万円
  東京都港区(新橋駅)
  • Windows

• ガバナンス推進、セキュリティ基盤支援/東京都港区/【WEB面談可】/在宅ワーク/20代～40代の方活躍中

  年収780万～780万円
  東京都港区(新橋駅)
  • Windows

• カー用品販売会社の情報システム運用/東京都千代田区/【WEB面談可/インフラサーバ経験者/20～40代の方活躍中】/テレワーク

  年収576万～576万円
  東京都千代田区(水道橋駅)
  • Linux
  • Windows

• ネットワーク構築、検証/東京都渋谷区/【WEB面談可】/テレワーク/20代～40代の方活躍中

  年収540万～540万円
  東京都渋谷区(渋谷駅)
  • Windows