Correct way to add a string property to existing Powershell object?

Question

So for example, I have a custom object for $server. I want to create a new property, $server.output to contain multi line output of varying size. What is the best approach to take? There doesn't seem to be any straight forward information on the web around how to add simple string properties to objects?

FYI I am using powershell v4, but it would be nice to have a solution for v5 too.

Take a look at the Add-Member cmdlet.

Jake Bruun
– Jake Bruun

2018-11-05 18:22:26 +00:00
Commented Nov 5, 2018 at 18:22 — Jake Bruun
– Jake Bruun, Commented Nov 5, 2018 at 18:22

Community · Accepted Answer · 2020-06-20 09:12:55Z

7

Outside of re-creating the object or ensuring the property exists on object initialization, you have to use Add-Member to create new properties on a pscustomobject:

# alternatively, use `-Force` on `Add-Member`
if (-not ($obj | Get-Member -Name output))
{
    $obj | Add-Member -MemberType NoteProperty -Name output -Value ''
}

Supported in v3+:

$obj | Add-Member -NotePropertyName output -NotePropertyValue '' -Force

Add multiple members:

$obj | Add-Member -NotePropertyMembers @{output = ''; output1 = ''} -Force

`Add-Member`

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Nov 5, 2018 at 18:28

Maximilian Burszley

19.9k7 gold badges39 silver badges68 bronze badges

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

Collectives™ on Stack Overflow

Correct way to add a string property to existing Powershell object?

1 Answer 1

`Add-Member`

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related