Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support powershell parameters when passing a script. #2651

Closed
adreyer opened this issue Feb 18, 2021 · 0 comments · Fixed by #2685
Closed

Support powershell parameters when passing a script. #2651

adreyer opened this issue Feb 18, 2021 · 0 comments · Fixed by #2685
Assignees
@beechtom
Labels
Feature New features and improvements.

Comments

@adreyer
Copy link
Contributor

adreyer commented Feb 18, 2021 •
edited by beechtom
Loading

Use Case

Powershell has a standard method of passing parameters to a script. Bolt should expose this to the run_script function and script step.

Describe the Solution You Would Like

Bolt's run_script should accept a hash of pwsh_params and pass those parameters to the script.

run_script(my_script.ps, $targets, pwsh_params => { 'this' => 1, 'that' => argument} )

Bolt should support accepting arguments along with params.

Questions

  • Should we support typed or structured data?
    Not at this point string only for now.
  • Should we support passing powershell params from the bolt script run cli?
    This is less important because you don't have filter out parameters.
  • Does it make escaping less awful?
    Not at this point but we should look for how we can leverage this after it's merged in.
@adreyer adreyer added the Feature New features and improvements. label Feb 18, 2021
@beechtom beechtom self-assigned this Mar 1, 2021
beechtom added a commit to beechtom/bolt that referenced this issue Mar 2, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
17426e5 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 2, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
272f1f5 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 2, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
da5872e 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 2, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
69427bb 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 2, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
a586cc1 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 2, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
ba937df 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 2, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
40883bc 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
@beechtom beechtom mentioned this issue Mar 2, 2021
Merged
@beechtom beechtom linked a pull request Mar 4, 2021 that will close this issue
(GH-2651) Add pwsh_params option to run_script function #2685
Merged
beechtom added a commit to beechtom/bolt that referenced this issue Mar 8, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
1919fee 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 8, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
e3b8bae 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 8, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
bf88efa 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 8, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
2a2cd2b 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 8, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
8a7fac5 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 8, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
86bde50 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
beechtom added a commit to beechtom/bolt that referenced this issue Mar 8, 2021
@beechtom
(puppetlabsGH-2651) Add pwsh_params option to run_script function
19c3503 
This adds a `pwsh_params` option to the `run_script` plan function.
The option accepts a hash of named parameters to pass to a PowerShell
script, where each key is the name of the parameter. If the `run_script`
function is called with both the `arguments` and `pwsh_params` options,
Bolt will error and provide a helpful message that both cannot be
specified.

This also adds a `pwsh_params` key to the YAML plan script step.

!feature

* **Add `pwsh_params` option to `run_script` plan function**
  ([puppetlabs#2651](puppetlabs#2651))

  The `run_script` plan function now accepts a `pwsh_params` option
  which can be used to pass named parameters to a PowerShell script.
lucywyman added a commit that referenced this issue Mar 9, 2021
@lucywyman
Merge pull request #2685 from beechtom/2651/pwsh-params
0f83f68 
(GH-2651) Add pwsh_params option to run_script function
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@beechtom beechtom

Labels
Feature New features and improvements.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(GH-2651) Add pwsh_params option to run_script function beechtom/bolt
2 participants
@adreyer @beechtom