powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-VApp



NAME
Set-VApp

SYNOPSIS
Configures a virtual appliance.

SYNTAX
Set-VApp -VApp [-Name ] [-CpuExpandableReservation []] [-CpuLimitMhz ] [-CpuReserv
ationMhz ] [-CpuSharesLevel ] [-MemExpandableReservation []] [-MemLimitMB ] [-M
emReservationMB ] [-MemSharesLevel ] [-NumCpuShares ] [-NumMemShares ] [-Server <
VIServer[]>] [-WhatIf] [-Confirm] []


DESCRIPTION
Configures a virtual appliance.


PARAMETERS
-VApp
Specify the virtual appliance you want to configure.

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

-Name
Modify the name of the virtual appliance.

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

-CpuExpandableReservation []
Indicate that the CPU reservation can grow beyond the specified value if there are available resources.

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

-CpuLimitMhz
Specify a CPU usage limit in MHz. If this parameter is set, utilization will not exceed this limit even if ther
e are available resources.

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

-CpuReservationMhz
Specify the guaranteed available CPU in MHz.

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

-CpuSharesLevel
Specify the CPU allocation level for this virtual appliance. This property is used in relative allocation betwe
en resource consumers. The valid enumeration values are Custom, High, Low, and Normal.

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

-MemExpandableReservation []
Indicate that the memory reservation can grow beyond the specified value if there are available resources.

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

-MemLimitMB
Specify a memory usage limit in MB. If this parameter is set, utilization will not exceed this limit even if th
ere are available resources.

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

-MemReservationMB
Specify the guaranteed available memory in MB.

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

-MemSharesLevel
Specify the memory allocation level for the virtual appliance. This property is used in relative allocation bet
ween resource consumers. The valid enumeration values are Custom, High, Low, and Normal.

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

-NumCpuShares
Specify the CPU allocation level for the virtual appliance. This property is used in relative allocation betwee
n resource consumers. This parameter is ignored unless CpuSharesLevel is set to Custom.

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

-NumMemShares
Specify the memory allocation level for the resource pool. This property is used in relative allocation between
resource consumers. This parameter is ignored unless MemSharesLevel is set to Custom.

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

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

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

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

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

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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
VApp[]


NOTES




-------------- Example 1 --------------

C:\PS>Get-VApp -Name TestVApp | Set-VApp -CpuSharesLevel Low -MemSharesLevel Normal


Modifies the CpuSharesLevel and MemSharesLevel properties of the TestVApp virtual appliance.





-------------- Example 2 --------------

C:\PS>$vapp = Get-VApp -Location Datacenter

Set-VApp -VApp $vapp -CpuExpandableReservation:$true -CpuLimitMhz 4000 -MemExpandableReservation:$true -MemLimitMB
2048


Modifies the properties of the virtual appliances available on the Datacenter datacenter.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-VApp.html
Export-VApp
Get-VApp
Import-VApp
New-VApp
Remove-VApp
Start-VApp
Stop-VApp
Move-VApp