Powershell non-positional, optional params

Question

I'm trying to create a powershell (2.0) script that will accept arguments that follow this basic pattern:

.\{script name} [options] PATH

Where options are any number of optional parameters - think along the lines of '-v' for verbose. The PATH argument will simply be whatever argument is passed in last, and is mandatory. One could call the script with no options and only one argument, and that argument would be assumed to be the Path. I'm having trouble setting up a parameters list that contains only optional parameters but is also non-positional.

This quick script demonstrates the problem I am having:

#param test script
Param(
    $firstArg,
    $secondArg,
    [switch]$thirdArg,
    [Parameter(ValueFromRemainingArguments = $true)]
    $remainingArgs)

write-host "first arg is $firstArg"
write-host "second arg is $secondArg"
write-host "third arg is $thirdArg"
write-host "remaining: $remainingArgs"

When called like so:

.\param-test.ps1 firstValue secondValue

The script outputs:

first arg is firstValue
second arg is secondValue
third arg is False
remaining:

The behavior I am trying to create would have both arguments fall through the optional params and end up in the remainingArgs variable.

This question/answer helpfully provided a way to achieve the desired behavior, but it only seems to work if there is at least one mandatory parameter, and only if it comes before all of the other arguments.

I can demonstrate this behavior by making firstArg mandatory and specifying a position of 0:

#param test script
Param(
    [Parameter(Mandatory=$true, Position = 0)]
    $firstArg,
    $secondArg,
    [switch]$thirdArg,
    [Parameter(ValueFromRemainingArguments = $true)]
    $remainingArgs)

    write-host "first arg is $firstArg"
    write-host "second arg is $secondArg"
    write-host "third arg is $thirdArg"
    write-host "remaining: $remainingArgs"

Run with the same input as before:

.\param-test.ps1 firstValue secondValue

The output is as follows:

first arg is firstValue
second arg is
third arg is False
remaining: secondValue

The first, mandatory argument is assigned, and everything left falls all the way through.

The question is this: How can I set up a params list such that all of the params are optional, and none of them is positional?

latkin · Accepted Answer · 2014-07-21 16:14:26Z

44

How about this?

function test
{
   param(
      [string] $One,

      [string] $Two,

      [Parameter(Mandatory = $true, Position = 0)]
      [string] $Three
   )

   "One = [$one]  Two = [$two]  Three = [$three]"
}

One and Two are optional, and may only be specified by name. Three is mandatory, and may be provided without a name.

These work:

test 'foo'
    One = []  Two = []  Three = [foo]
test -One 'foo' 'bar'
    One = [foo]  Two = []  Three = [bar]
test 'foo' -Two 'bar'
    One = []  Two = [bar]  Three = [foo]

This will fail:

test 'foo' 'bar'
test : A positional parameter cannot be found that accepts argument 'bar'.
At line:1 char:1
+ test 'foo' 'bar'
+ ~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [test], ParameterBindingException
    + FullyQualifiedErrorId : PositionalParameterNotFound,test

This doesn't enforce that your mandatory arg is placed last, or that it's not named. But it allows for the basic usage pattern you want.

It also does not allow for more than one value in $Three. This might be what you want. But, if you want to treat multiple non-named params as being part of $Three, then add the ValueFromRemainingArguments attribute.

function test
{
   param(
      [string] $One,

      [string] $Two,

      [Parameter(Mandatory = $true, Position = 0, ValueFromRemainingArguments = $true)]
      [string] $Three
   )

   "One = [$one]  Two = [$two]  Three = [$three]"
}

Now things like this work:

test -one 'foo' 'bar' 'baz'
  One = [foo]  Two = []  Three = [bar baz]

Or even

test 'foo' -one 'bar' 'baz'
    One = [bar]  Two = []  Three = [foo baz]

edited Jul 21, 2014 at 16:14

answered Sep 11, 2012 at 20:43

latkin

16.9k3 gold badges50 silver badges64 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

BogStandard Over a year ago

Exactly what I needed. It didn't occur to me that I could use a mandatory arg with Position=0 as the last argument.

ekkis Over a year ago

thanks latkin, I'd already burnt an hour on this. I had another question (which I've answered with credit to you) here: stackoverflow.com/questions/18861701/…

Paul Over a year ago

I know this is years later, but this answer saved me after I spent almost an hour searching for a way to do this with an arbitrary number of parameters.

joseville Over a year ago

Thanks! Had to make a modification to make it work for me. Saved script in test.ps1 and was running it as test foo and test 'foo', but nothing printed to console. Solution for me was to omit function test and corresponding { and }, then it worked as described. Not sure why it didn't work as-is.

Collectives™ on Stack Overflow

Powershell non-positional, optional params

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related