< Back

New-AdvancedSetting

Sun Jan 19, 2020 6:58 pm

NAME New-AdvancedSetting



SYNOPSIS

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





SYNTAX

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

<AdvancedSettingType>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-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.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-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.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies a name for the advanced setting.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Type <AdvancedSettingType>

Specifies the type of the new advanced setting.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Value <Object>

Specifies a value for the advanced setting.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-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.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are

modified.



Required? false

Position? named

Default value False

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 (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

The one or more newly created AdvancedSetting objects







NOTES









-------------------------- 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.



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... tting.html

Get-AdvancedSetting

Remove-AdvancedSetting

Set-AdvancedSetting