Syntax
New-AdvancedSetting [-Name] <String> [-Value] <Object> [-Entity] <VIObject> [-Force] [-Server <VIServer[]>] [-Type <AdvancedSettingType>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet creates a new advanced setting for the specified entity.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String | Specifies a name for the advanced setting. | true | False | |
| Value | Object | Specifies a value for the advanced setting. | true | False | |
| Entity | VIObject | Specifies 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. | true | True (ByValue) | |
| Confirm | SwitchParameter | 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. | false | False | |
| Force | SwitchParameter | Indicates that you want to create the new advanced setting even if another setting with the same name exists for the specified object type. | false | False | |
| Server | VIServer[] | 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. | false | False | |
| Type | AdvancedSettingType | Specifies the type of the new advanced setting. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
The one or more newly created AdvancedSetting objectsNotes
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.