How to pass arguments to functions in PowerShell

Question

I have the below PowerShell script

Function Publish
{
    Param(
        [parameter(Mandatory=$true)]
        [String]
        $RELEASEDIR,

        [parameter(Mandatory=$true)]
        [String]
        $SERVICENAME,

        [parameter(Mandatory=$true)]
        [String]
        $SERVER
    )

    Get-ChildItem "$RELEASEDIR\*"
    $service = Get-Service -Name $SERVICENAME -Computername $SERVER -ErrorAction SilentlyContinue
    $service.Status
}
Publish

How I am executing this:

PS C:\Release\RPCPS> .\RPCPublish.ps1 -RELEASEDIR "C:\Location" -SERVICENAME "value" -SERVER "server"
cmdlet Publish at command pipeline position 1
Supply values for the following parameters:
RELEASEDIR:

Even after passing arguments while executing, the script is expecting it again. What am I doing wrong here?

dotsource the script and do publish -arg1 -arg2 -arg3, also, consider changing function name to verb-noun format — 4c74356b41
– 4c74356b41, Commented Feb 21, 2017 at 12:27
You script does not accept arguments. Your publish function inside your script does. The arguments you are passing to your script are not getting to your function hence why it starts asking for them. — Matt
– Matt, Commented Feb 21, 2017 at 12:27

TToni · Accepted Answer · 2017-02-21 12:30:50Z

7

If you want to execute the script by calling the .ps1 as in your example, there is no need to use a function. Your script should look just like this:

Param(
    [parameter(Mandatory=$true)]
    [String]
    $RELEASEDIR,
    [parameter(Mandatory=$true)]
    [String]
    $SERVICENAME,
    [parameter(Mandatory=$true)]
    [String]
    $SERVER
    )
Get-ChildItem "$RELEASEDIR\*"
$service = Get-Service -Name $SERVICENAME -Computername $SERVER -ErrorAction SilentlyContinue
$service.Status

The parameters are passed directly to the script and can be used there.

If, on the other hand, you want to establish a (reusable) function, remove just the last line from your script, which calls the function without parameters (which is why it asks for the mandatory parameters every time).

If you remove the last line, you can call the script without parameters once. After that you have a new function Publish in your current session, which you can then call with

Publish -RELEASEDIR "C:\Release\Batchfile" -SERVICENAME "AmazonSSMAgent" -SERVER "10.0.1.91"

independent of the script file.

answered Feb 21, 2017 at 12:30

TToni

9,4011 gold badge33 silver badges44 bronze badges

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

2 Comments

asur Over a year ago

How can I execute the same in Jenkins

TToni Over a year ago

No idea, I don't do Jenkins. Maybe this will be helpful: hodgkins.io/…

Peter Mortensen · Accepted Answer · 2019-02-18 06:45:04Z

1

Your script is creating a function, "Publish", (lines 1-17) and then calling it with no parameters (line 18). Since you've defined parameters as mandatory (lines 4, 7, 10), failing to supply the parameters when you call the function (line 18) causes PowerShell to request values for the unsupplied parameters.

Supplying parameters to the script file itself does not help; there is no mechanism for "automagically" passing those parameters to anything within the script (you would have to explicitly code the script for that).

As Matt suggested in the comments, dot-source your script after deleting line 18, and then call your function explicitly, passing the parameters (publish -RELEASEDIR "C:\Release\Batchfile" -SERVICENAME "AmazonSSMAgent" -SERVER "10.0.1.91").

edited Feb 18, 2019 at 6:45

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Feb 21, 2017 at 12:34

Jeff Zeitlin

11k2 gold badges26 silver badges38 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-01-24 20:07:10Z

0

As per my understanding your requirement is to run the function, and you have to compile the scripts also in Jenkins.

You can do something like this:

Let's say your script name is RPCPublish.ps1 and the path is D:\Folder.

And I can see your function name is Publish.

So in your case,

powershell -command "& { D:\folder\RPCPublish.ps1; Publish }"

You can pass the parameters after this in the script block.

edited Jan 24, 2019 at 20:07

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Feb 21, 2017 at 14:20

Ranadip Dutta

9,5493 gold badges33 silver badges48 bronze badges

Comments

Peter Mortensen · Accepted Answer · 2019-02-18 06:50:10Z

0

I used a PowerShell plugin (PowerShell) and executed the same.

. "C:\Release\RPCPS\RPCPublish.ps1"
FUunctionName -RELEASEDIR "C:\bin\Release" -SERVICENAME "Service" -SERVER "$env:SERVER" -DISPLAYNAME "Services Air" -BINPATH "D:\Build\Project.exe" -DESCRIPTION "This service hosts Air service" -DESTINATION "d$\Build\"

edited Feb 18, 2019 at 6:50

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Feb 22, 2017 at 5:56

asur

1,87910 gold badges44 silver badges86 bronze badges

2 Comments

Peter Mortensen Over a year ago

Does the plugin have a name?

asur Over a year ago

@PeterMortensen wiki.jenkins.io/display/JENKINS/PowerShell+Plugin

Collectives™ on Stack Overflow

How to pass arguments to functions in PowerShell

4 Answers 4

2 Comments

Comments

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest