vSphere PowerCLI Reference

New-AdvancedSetting

Synopsis

Creates a new advanced setting for specified entity.

Syntax

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

Related Commands

Online version
Get-AdvancedSetting
Remove-AdvancedSetting
Set-AdvancedSetting

Detailed Description

Creates a new advanced setting for specified entity.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecify a name for the advanced setting.truefalse
ValueObjectSpecify a value for the advanced setting.truefalse
EntityVIObject[]Specify the entity for which you want to create a new advanced setting. This parameter accepts VIServer, VirtualMachine, VMHost, DatastoreCluster, and Cluster objects.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
ForceSwitchParameterIndicate 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[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
TypeAdvancedSettingTypeSpecify the type of the new advanced setting.falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

AdvancedSetting

Notes

Examples

-------------- 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 © 1998 - 2012 VMware, Inc. All rights reserved.