Remove-VDIPool

NAME

Remove-VDIPool

SYNOPSIS

Removes a VDI Pool from a site.

SYNTAX

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

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

Remove-VDIPool [-InputObject] <VDIPool> [<CommonParameters>]

DESCRIPTION

Removes a VDI Pool from a site.

PARAMETERS


-Name <string>
The name of a VDI 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 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 VDIPool to remove from the site.

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

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

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

To obtain a VDIPool object representing a VDI Pool, use the Get-VDIPool 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

VDIPool

OUTPUTS

-none-

EXAMPLES


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

Remove-VDIPool "My VDI Pool"

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

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

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

Remove-VDIPool -Id 10

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

---------- EXAMPLE 3 ----------

Get-VDIPool -Id 10 | Remove-VDIPool

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

RELATED LINKS