Enable-Monitoring (VMware)

Enables monitoring of separate vSphere clusters or hosts under a registered VMware server.

Applies to versions: 8.0, 9.0

Syntax

Enable-Monitoring [–VMwareServer] <VMwareServer> [-Include <String[]>] [-Exclude <String[]>] [-Force] [-VESServer <Object>] [<CommonParameters>]]

Detailed Description

This cmdlet enables monitoring of separate vSphere clusters and hosts under a VMware server registered in configuration of the Virtualization Extensions Service.

Note

The cmdlet is only applicable if you work with vCenter Server connections.

Parameters

-VMwareServer <VMwareServer>  

Specifies the object of the VMware server whose child clusters or hosts should be included in monitoring.

Tip

To get the list of connected VMware servers, use the Get-VMwareServer cmdlet.

 

Description

Aliases

 

Required?

True

Position?

1

Default Value

 

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

False

-Include <String>

Specifies the list of vSphere clusters and hosts for which monitoring must be enabled. If the parameter is not specified, the cmdlet will enable monitoring for all child clusters and hosts of the VMware server.

Acceptable formats for the input value are:

  • vSphere cluster: cluster name, for example “Production”
  • Clustered vSphere host: cluster/hostname, for example “Production/esx01.veeam.local”
  • Standalone vSphere host: hostname,  for example “esx01.veeam.local”

Note

This parameter supports wildcards. Search is not case sensitive.

 

Description

Aliases

 

Required?

False

Position?

Named

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

True

-Exclude <String[]>

Specifies the list of vSphere clusters and hosts that must be excluded from the list of servers for which monitoring is enabled.

Acceptable formats for the input value are:

  • vSphere cluster: cluster name, for example “Production”
  • Clustered vSphere host: cluster/hostname, for example “Production/esx01.veeam.local”
  • Standalone vSphere host: hostname,  for example “esx01.veeam.local”

Note

This parameter supports wildcards. Search is not case sensitive.

 

Description

Aliases

 

Required?

False

Position?

Named

Default Value

 

Accept Pipeline Input?

False

Accept Wildcard Characters?

True

-Force

Specifies whether the confirmation dialog must be suppressed. If the parameter is not specified, the cmdlet will prompt you to confirm the enabling of monitoring for selected clusters and hosts.

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

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 -VMwareServer parameter:

Output

The cmdlet does not return any output.

Example

This command enables monitoring for the “esx20.veeam.local” host included in the "production" cluster of the “prod-vcenter” vCenter Server.

Get-VMwareServer prod-vcenter | Enable-Monitoring –Include production/esx20.veeam.local

References

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

I want to report a typo

There is a misspelling right here:

 

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