Remove-UnityHost

SYNOPSIS

Delete host.

SYNTAX

Remove-UnityHost [-session <Object>] [-ID] <Object> [-WhatIf] [-Confirm]

DESCRIPTION

Delete host. You need to have an active session with the array.

EXAMPLES

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

Remove-UnityHost -ID 'host_5'

Delete the host with ID 'host_5'

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

Get-UnityHost -ID 'host_5' | Remove-UnityHost

Delete the host with ID 'host_5'. host informations 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: Object
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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 user 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