Set-VESettings

Sets the value of the specified Extensions Service setting.

Applies to versions: 8.0, 9.0

Syntax

Set-VESettings [-Name] <String> [-Value] <String> [-VESServer <Object>] [<CommonParameters>]

Detailed Description

This cmdlet modifies the value of the specified Extensions Service setting.

Parameters

-Name <String>

Specifies the Extensions Service setting that should be modified.

Tip

To get a list of available Extensions Service settings and their names, use the Get-VESettings cmdlet.

 

Description

Aliases

 

Required?

True

Position?

1

Default Value

 

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

False

-Value <String>

Specifies the new effective value of the Extensions Service setting.

Description

Aliases

 

Required?

True

Position?

2

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

-VESServer

Specifies the Virtualization Extensions server. You can pass the following types of values:

  • Name of a machine (remote or local) where the Virtualization Extensions Service runs.

Acceptable formats for the input value are: server name (such as "localhost" or "."), IP address (such as "172.15.19.6") and FQDN (such as "localhost.veeam.local").

For more information, type “get-help about_VESServerParameter”.

Description

Aliases

 

Required?

False

Position?

Named

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters.  For more information about common parameters, see Microsoft Docs.

Notes

If the -VESServer parameter is not specified, the cmdlet will connect to the Virtualization Extensions Service on the local machine.

Input

The cmdlet accepts the following types of values for the -Name parameter:

  • System.String (you can pass an Extensions Service setting name, the setting name value is used exactly as it is typed)

Output

The cmdlet does not return any output.

Example 1

This command changes the “TargetRefreshPeriod” Extensions Service setting value to “300”.

Set-VESettings -Name TargetRefreshPeriod -Value 300

Example 2

This command enables the split mode for vSphere clusters.

Set-VESettings SplitClusters true

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.