Get-VESettings

Gets Extensions Service settings for the Virtualization Extensions Service.

Applies to versions: 8.0, 9.0, 9a

Syntax

Detailed Description

This cmdlet retrieves effective Extensions Service settings. The cmdlet returns a list of objects that represent Extensions Service settings.

The cmdlet displays the following property values for the returned Extensions Service settings:

Name: name of the Extensions Service setting

Value: effective value of the Extensions Service setting

Type: data type of the Extensions Service setting

Default: default value of the Extensions Service setting

Description: short description of the Extensions Service setting

Parameters

-Include <String[]>

Specifies the list of Extensions Service settings that should be retrieved. If the parameter is not specified, the cmdlet will return the list of all Extensions Service settings.

-ValueOnly

If the parameter is specified, the cmdlet will return only effective values for Extensions Service settings (instead of returning the list of settings with setting properties).

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

• Veeam.Psves.VesConnection object.

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

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

Output

If the -ValueOnly parameter is not specified, the cmdlet will return a collection of Veeam.Psves.ServerConfigProperty objects that represent Extensions Service settings.

If the -ValueOnly parameter is specified, the cmdlet will return a collection of Value properties of the Veeam.Psves.ServerConfigProperty objects. The Value properties store effective values of Virtualization Extensions settings.

Example 1

This command returns a list of all Extensions Service settings.

Example 2

This command returns the effective value of the “TargetRefreshPeriod” Extensions Service setting for the Virtualization Extensions Service on the server1 machine.

Example 3

This command returns Extensions Service settings whose names start with “report”.

References

To learn more about supporting wildcard characters in cmdlet parameters, see Microsoft Docs.