Remove-RASVDIHostPool

NAME

Remove-RASVDIHostPool

SYNOPSIS

Removes a VDI Host Pool from a site.

SYNTAX

Remove-RASVDIHostPool [-Id] <uint> [<CommonParameters>]

Remove-RASVDIHostPool [-InputObject] <VDIHostPool> [<CommonParameters>]

Remove-RASVDIHostPool [-Name] <string> [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Removes a VDI Host Pool from a site.

PARAMETERS

-Name <string> The name of a VDI Host Pool to remove from a site.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to remove the VDI Host Pool.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of a VDIHostPool to remove from the site.

To obtain the ID, use the Get-RASVDIHostPool cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <VDIHostPool> The VDI Host Pool to remove from a site.

To obtain a VDIHostPool object representing a VDI Host Pool, use the Get-RASVDIHostPool command.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        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

VDIHostPool

OUTPUTS

-none-

EXAMPLES

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

Remove-RASVDIHostPool "My VDI Host Pool"

Removes the VDI host pool specified by name from the Licensing Server site (default).

To remove a VDI host pool from a specific site, specify the -SiteId parameter. ---------- EXAMPLE 2 ----------

Remove-RASVDIHostPool -Id 10

Removes the VDI host pool specified by ID from the Licensing Server site. To obtain the group ID, use the Get-RASVDIHostPool cmdlet. ---------- EXAMPLE 3 ----------

Get-RASVDIHostPool -Id 10 | Remove-RASVDIHostPool

Removes a VDI host pool, which is identified by an object obtained from the pipeline output.

Last updated

© 2024 Parallels International GmbH. All rights reserved.