PowerShell script exchange
Post Reply
pshute
Veteran
Posts: 254
Liked: 14 times
Joined: Nov 23, 2015 10:56 pm
Full Name: Peter Shute
Contact:

Suggested change to documentation for Get-VBRBackup

Post by pshute »

I've just discovered that Get-VBRBackup's -Name parameter can include comma separated backup names, and also wildcards. This might save someone considerable coding effort if it was mentioned in the documentation.
jhoughes
Veeam Vanguard
Posts: 279
Liked: 112 times
Joined: Apr 20, 2017 4:19 pm
Full Name: Joe Houghes
Location: Castle Rock, CO
Contact:

Re: Suggested change to documentation for Get-VBRBackup

Post by jhoughes »

It is documented as such in both the PowerShell help and the online documentation, based on the Name parameter showing that it can accept an array of strings (which is the "<String[]>" distinction in the PowerShell help).

That is how PowerShell denotes that a parameter can accept multiple values passed as an array. If you need more details on this, just run "Get-Help about_Parameters" in a PowerShell prompt.
Husband, Father, Solutions Architect, Geek Extraordinaire | @DenverVMUG, @AustinVMUG & @ATXPowerShell leader | VMware vExpert | Cisco Champion
nielsengelen
Product Manager
Posts: 5619
Liked: 1177 times
Joined: Jul 15, 2013 11:09 am
Full Name: Niels Engelen
Contact:

Re: Suggested change to documentation for Get-VBRBackup

Post by nielsengelen »

On our helpcenter there is a report feedback button at the bottom of every page. If you use this, useful changes can be applied directly by the correct team.
Personal blog: https://foonet.be
GitHub: https://github.com/nielsengelen
pshute
Veteran
Posts: 254
Liked: 14 times
Joined: Nov 23, 2015 10:56 pm
Full Name: Peter Shute
Contact:

Re: Suggested change to documentation for Get-VBRBackup

Post by pshute »

jhoughes wrote: Apr 24, 2020 12:11 am It is documented as such in both the PowerShell help and the online documentation, based on the Name parameter showing that it can accept an array of strings (which is the "<String[]>" distinction in the PowerShell help).
It does too (the online documentation). Could have sworn it didn't. The page for one of the other cmdlets specifically mentioned comma separated, so I looked for it there and perhaps didn't notice the words "array" and "names".

Sorry, thanks.
jhoughes
Veeam Vanguard
Posts: 279
Liked: 112 times
Joined: Apr 20, 2017 4:19 pm
Full Name: Joe Houghes
Location: Castle Rock, CO
Contact:

Re: Suggested change to documentation for Get-VBRBackup

Post by jhoughes »

You are correct, it doesn't mention anything about array or names.

What I am referring to is the PowerShell language standard for parameters and how the [] denotes that this can be an array of values.

Again, I would suggest running "Get-Help about_Parameters" in a PowerShell prompt, as this is a fairly important basic concept to understand about PowerShell documentation.
Husband, Father, Solutions Architect, Geek Extraordinaire | @DenverVMUG, @AustinVMUG & @ATXPowerShell leader | VMware vExpert | Cisco Champion
pshute
Veteran
Posts: 254
Liked: 14 times
Joined: Nov 23, 2015 10:56 pm
Full Name: Peter Shute
Contact:

Re: Suggested change to documentation for Get-VBRBackup

Post by pshute »

It really does say it: "Specifies the array of backup, backup copy or Veeam Agent for Microsoft Windows backup job names. The cmdlet will return backups produced with these jobs."

That's from https://helpcenter.veeam.com/docs/backu ... ml?ver=100

Not as explicit as https://helpcenter.veeam.com/docs/backu ... ml?ver=100, which says "Specifies the name(s) of the backup or search conditions. You can specify multiple names separated by commas."

Yes, I should learn to do powershell properly.
oleg.feoktistov
Veeam Software
Posts: 1912
Liked: 635 times
Joined: Sep 25, 2019 10:32 am
Full Name: Oleg Feoktistov
Contact:

Re: Suggested change to documentation for Get-VBRBackup

Post by oleg.feoktistov »

It really does say it: "Specifies the array of backup, backup copy or Veeam Agent for Microsoft Windows backup job names. The cmdlet will return backups produced with these jobs."
Actually, it does have the same meaning conveyed with slightly different words:
"Specifies the array of backup... names." vs. "Specifies the name(s) of the backup...".

Anyway, use the button Niels suggested if you feel that this article can be improved.

Thanks,
Oleg
Post Reply

Who is online

Users browsing this forum: No registered users and 22 guests