Remove-VDIPersistentGuest

NAME

Remove-VDIPersistentGuest

SYNOPSIS

Removes a persistent guest VM rule.

SYNTAX

Remove-VDIPersistentGuest [-VDIHostId] <uint> [-VDIGuestId] <string> [-SiteId <uint>] [<CommonParameters>]

Remove-VDIPersistentGuest [-InputObject] <VDIPersistentGuest> [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Removes a persistent guest VM rule.

PARAMETERS


-VDIHostId <uint>
The ID of the VDI Host server on which the target Persistent Guest resides.

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-VDIGuestId <string>
The Guest ID of a persistent guest VM.

To obtain the Guest ID, use the Get-VDIPersistentGuest cmdlet.

        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <VDIPersistentGuest>
An object of type VDIPersistentGuest representing a persistent guest VM rule to remove from a site.

To obtain the object, use the Get-VDIPersistentGuest command."

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-SiteId <uint>
Site ID.

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation. 

INPUTS

VDIPersistentGuest

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Remove-VDIPersistentGuest -Id 10

Removes the persistent guest VM rule specified by ID. To obtain the ID, use the Get-VDIPersistentGuest cmdlet.

---------- EXAMPLE 2 ----------

Get-VDISettings -Id 10 | Remove-VDIPersistentGuest

Removes the persistent guest VM rule identified by an object obtained from the pipeline output.

RELATED LINKS