Set-UnityHost

SYNOPSIS

Modify a host configuration.

SYNTAX

Set-UnityHost [-session <Object>] [-ID] <String[]> [[-Name] <String>] [-Description <String>]
 [-osType <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Modify a host configuration. You need to have an active session with the array.

EXAMPLES

-------------------------- EXEMPLE 1 --------------------------

Set-UnityHost -ID 'Host_21' -Name HOST01

Change the name of the host with ID 'Host_21'

-------------------------- EXEMPLE 2 --------------------------

Get-UnityHost -ID 'Host_21' | Set-UnityHost -Name HOST01

Change the name of the host with ID 'Host_21'. The Host's information are provided by the Get-UnityHost through the pipeline.

PARAMETERS

-session

Specify an UnitySession Object.

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: ($global:DefaultUnitySession | where-object {$_.IsConnected -eq $true})
Accept pipeline input: False
Accept wildcard characters: False

-ID

Host ID or Object.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

Host Name. (Applies to manually-created hosts only.)

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Description

Host Description

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-osType

Operating system running on the host. (Applies to manually-created hosts only.)

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for Host confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

OUTPUTS

NOTES

Written by Erwan Quelin under MIT licence - https://github.com/equelin/Unity-Powershell/blob/master/LICENSE

https://github.com/equelin/Unity-Powershell