Enum parameter for powershell cmdlet

Question

I'm writing a cmdlet (script) on powershell and I wanted to use eunm as one of the parameters. But I don't know where to put enum definition so that it would be visible for cmdlet parameters declaration.

For example, I have a parameters definition of the script like this

[cmdletbinding()]
param(
    [Parameter(Mandatory=$True)]
    [string]$Level
)

and an enum like this

enum LevelEnum { NC = 1; NML = 2; CS = 3 }

I can't replace [string] with [LevelEnum] in the parameter definition because script will fail to locate enum definition. And I can't put definition before cmdletbinding, it's not allowed. I know how to do it if that would've been a function, I know it can be solved using ValidateSet, but I need to have integer values correstonding to enum options.

[ValidateSet('NC','NML','CS')]

But the question is, can I do the same for a cmdlet?

Thanks to everyone. I ended up with a combination of defferent answers.

[cmdletbinding()]
param(
    [Parameter(Mandatory=$True)]
    [ValidateSet('NC','NML','CS')]
    [string]$Level
)
# Convert level from string to enum
enum PatchLevel { NC = 1; NML = 2; CS = 3 }
[PatchLevel]$l = $Level

# Use the numeric value
Write-Host $l.value__

Does this answer your question? Enum declaration

Alex_P
– Alex_P

2020-06-22 10:27:24 +00:00
Commented Jun 22, 2020 at 10:27 — Alex_P
– Alex_P, Commented Jun 22, 2020 at 10:27

AdamL · Accepted Answer · 2020-06-23 10:04:05Z

3

If this script needs to accept a custom enum, it means that you will be calling it from some other place, where enum definition already exists. And now you're trying to add the same definition again in a script. It would be good idea to push it out to a module as per @Alex_P suggestion so the definition resides in one place, but the downside is that Import-Module or #Requires won't import it, thus the need for using module clause.

But if you're willing to accept simpler and less secure solution, you could take advantage of the fact that any enum you define is derived from System.Enum. [System.Enum]$Level will accept only and all enums and if it's not LevelEnum the script will break, but still it filters most possible mistakes before the script execution and gives some information about parameter type.

edited Jun 23, 2020 at 10:04

answered Jun 22, 2020 at 11:44

AdamL

13.3k5 gold badges57 silver badges79 bronze badges

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

1 Comment

Mak Sim Over a year ago

Thanks to everyone who replied. While most upvoted answers was most technically correct, but this answer actually made me to conclussion that my approach and my question was wrong. So I'll mark this one as accepted.

7cc · Accepted Answer · 2020-06-22 15:37:28Z

3

[cmdletbinding()]
param(
    [ArgumentCompleter({
        enum LevelEnum { NC = 1; NML = 2; CS = 3 }
        [LevelEnum].GetEnumValues()
    })]
    [ValidateScript({
        enum LevelEnum { NC = 1; NML = 2; CS = 3 }
        [LevelEnum]$_
    })]
    $Level
)

enum LevelEnum { NC = 1; NML = 2; CS = 3 }
[LevelEnum]$Level

This works, but I'm sure one will easily forget to edit all the enum definitions...

answered Jun 22, 2020 at 15:37

7cc

1,1646 silver badges10 bronze badges

Comments

Alex_P · Accepted Answer · 2020-06-23 07:00:44Z

3

I would try something like this:

Below I created a plain PSM1 file with the LevelEnum definition.

enum LevelEnum{
  High
  Medium
  Low
}

Afterwards, I use using module with the path to the PSM1 file.

using module C:\Users\Path\To\Module\testmodule.psm1

function Get-Verb {
    [CmdletBinding()]
    param (
        [LevelEnum]$b
    )
    Write-Host $b
}

I used this microsoft documentation, About_Using and I also run version 7.0.2.

edited Jun 23, 2020 at 7:00

answered Jun 22, 2020 at 10:46

Alex_P

3,0423 gold badges29 silver badges44 bronze badges

2 Comments

noobie Over a year ago

This does not work.

Alex_P Over a year ago

@noobie, my explanation works perfectly fine. What is the error you receive when following the instructions?

Collectives™ on Stack Overflow

Enum parameter for powershell cmdlet

3 Answers 3

1 Comment

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related