PowerCLI Reference



This cmdlet creates a new advanced setting for the specified entity.


New-AdvancedSetting [-Name] <String> [-Value] <Object> [-Entity] <VIObject> [-Force] [-Server <VIServer[]>] [-Type <AdvancedSettingType>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet creates a new advanced setting for the specified entity.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies a name for the advanced setting.trueFalse
ValueObjectSpecifies a value for the advanced setting.trueFalse
EntityVIObjectSpecifies the entity for which you want to create a new advanced setting. This parameter accepts VIServer, VirtualMachine, DatastoreCluster, and Cluster objects. Passing multiple values to this parameter is obsolete.trueTrue (ByValue)
ConfirmSwitchParameterIf 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.falseFalse
ForceSwitchParameterIndicates that you want to create the new advanced setting even if another setting with the same name exists for the specified object type.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseFalse
TypeAdvancedSettingTypeSpecifies the type of the new advanced setting.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The one or more newly created AdvancedSetting objects



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

New-AdvancedSetting -Entity (Get-Cluster -Name Cluster) -Name SettingName -Value SettingValue -Type ClusterHA

Creates a new advanced setting for the Cluster cluster - of type CLusterHA, with name SettingName and value SettingValue.

Copyright © VMware, Inc. All rights reserved.