Veeam Home | Support | Downloads
Veeam Management Pack 8.0 for System Center VEShell Reference

Veeam Management Pack Help Center  > VEShell Reference >  VEShell Cmdlets > Get-VESettings

Get-VESettings

Previous page Next page Print this Topic

Table of contents

Gets Extensions Service settings for the Virtualization Extensions Service.

Applies to versions: 6.0, 6.5, 7.0, 8.0

Syntax

Get-VESettings [[-Include] <String[]>] [-ValueOnly] [-VESServer <Object>] [<CommonParameters>]

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.

noteNote

This parameter supports wildcards. Search is not case sensitive.

Description

Aliases

 

Required?

False

Position?

1

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

True

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

Description

Aliases

 

Required?

False

Position?

Named

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").
Veeam.Psves.VesConnection object.

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 http://go.microsoft.com/fwlink/p/?LinkID=113216.

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.

Get-VESettings

Example 2

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

Get-VESettings -Include TargetRefreshPeriod –ValueOnly –VESServer server1

Example 3

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

Get-VESettings -Include Report*

References

To learn more about supporting wildcard characters in cmdlet parameters, see http://msdn.microsoft.com/en-us/library/windows/desktop/aa717088%28v=vs.85%29.aspx.

Table of contents