---
title: "Get-VESettings"
description: "This cmdlet retrieves effective Extensions Service settings. The cmdlet returns a list of objects that represent Extensions Service settings."
canonical: "https://helpcenter.veeam.com/docs/mp/veshell/get-vesettings.html"
breadcrumb: "Veeam MP VEShell Reference > VEShell Cmdlets > Get-VESettings"
dateModified: "2026-09-10"
---

# Get-VESettings

Gets Extensions Service settings for the Virtualization Extensions Service.

**Applies to versions**: 8.0, 9.0, 9a

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

::: note

This parameter supports wildcards. Search is not case sensitive.

:::

<table style="width:500px; head-row-background-color:#c5e2ff; alt-row-background-color:#f5f5f5;" class="Blue_Table">
  <tr style="vertical-align:top">
    <th colspan="2" style="height:19px;">
      <p>Description</p>
    </th>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Aliases</p>
    </td>
    <td style="width:268px; height:19px;"></td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Required?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Position?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>1</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Default Value</p>
    </td>
    <td style="width:268px; height:19px;"></td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Accept Pipeline Input?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Accept Wildcard Characters?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>True</p>
    </td>
  </tr>
</table>

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

<table style="width:500px; head-row-background-color:#c5e2ff; alt-row-background-color:#f5f5f5;" class="Blue_Table">
  <tr style="vertical-align:top">
    <th colspan="2" style="height:19px;">
      <p>Description</p>
    </th>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Aliases</p>
    </td>
    <td style="width:268px; height:19px;"></td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Required?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Position?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>Named</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Default Value</p>
    </td>
    <td style="width:268px; height:19px;"></td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Accept Pipeline Input?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Accept Wildcard Characters?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
</table>

### -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](connection.md) object.

For more information, type “[get-help about_VESServerParameter](connection_parameter.md)”.

<table style="width:500px; head-row-background-color:#c5e2ff; alt-row-background-color:#f5f5f5;" class="Blue_Table">
  <tr style="vertical-align:top">
    <th colspan="2" style="height:19px;">
      <p>Description</p>
    </th>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Aliases</p>
    </td>
    <td style="width:268px; height:19px;"></td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Required?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Position?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>Named</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Default Value</p>
    </td>
    <td style="width:268px; height:19px;"></td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Accept Pipeline Input?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="width:228px; height:19px;">
      <p>Accept Wildcard Characters?</p>
    </td>
    <td style="width:268px; height:19px;">
      <p>False</p>
    </td>
  </tr>
</table>

### \<CommonParameters\>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see [Microsoft Docs](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](extensions_service_settings.md) 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](extensions_service_settings.md) 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 [Microsoft Docs](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/supporting-wildcard-characters-in-cmdlet-parameters?view=powershell-7).