Set-VDIPool

NAME

Set-VDIPool

SYNOPSIS

Modifies a VDI Pool.

SYNTAX

Set-VDIPool [-Name] <string> [[-SiteId] <uint>] [-Description <string>] [-Enabled <bool>] [-NewName <string>] [-WildCard <string>] [<CommonParameters>]

Set-VDIPool [-Id] <uint> [-Description <string>] [-Enabled <bool>] [-NewName <string>] [-WildCard <string>] [<CommonParameters>]

Set-VDIPool [-InputObject] <VDIPool> [-Description <string>] [-Enabled <bool>] [-NewName <string>] [-WildCard <string>] [<CommonParameters>]

DESCRIPTION

Modifies properties of a VDI Pool.

PARAMETERS


-Name <string>
The name of the target VDI Pool.

This must be the actual VDI Pool name used in the RAS farm. 

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

-SiteId <uint>
Site ID in which to modify the specified VDI Pool.

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

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

-Id <uint>
The ID of the VDIPool to modify. 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 modify.

To obtain an object of type VDIPool representing a VDI Pool, use the Get-VDIPool cmdlet. 

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

-NewName <string>
The new name of the target VDI Pool. 

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

-Description <string>
A user-defined VDI Pool description. 

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

-Enabled <bool>
Enable or disable the specified VDI Pool in a site. 

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

-Enable <bool>
Enable or disable the specified VDI Pool in a site.

This is an alias of the Enabled parameter. 

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

-WildCard <string>
A user-defined VDI Pool wildcard. 

        Required?                    false
        Position?                    named
        Default value                
        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

VDIPool

OUTPUTS

-none-

EXAMPLES


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

Set-VDIPool "My VDI Pool" -Enabled $False

Disables the VDI Pool specified by name.

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

Set-VDIPool -Id 10 -Enabled $False

Disables the VDI Pool specified by ID.

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

Set-VDIPool $VDIPool -Enabled $False

Disables the VDI Pool specified by the $VDIPool variable (an object of type VDIPool).

---------- EXAMPLE 4 ----------

Get-VDIPool -Id 10 | Set-VDIPool -Enabled $False

Disables the VDI Pool obtained from the pipeline output.

RELATED LINKS