VEShell Cmdlets

In this article

    For configuration and management of Virtualization Extensions Service, you can use the following sets of VEShell cmdlets.

    Virtualization Extensions Service

    Name

    Description

    New-VEConnection

    Creates a new object that stores settings for connecting to the Virtualization Extensions Service (computer name, port and access credentials).

    Connect-VE

    Opens a connection to the Virtualization Extensions Service.

    Disconnect-VE

    Closes a connection to the Virtualization Extensions Service.

    Get-VESettings

    Gets Extensions Service settings for the Virtualization Extensions Service.

    Set-VESettings

    Sets the value of the specified Extensions Service setting.

    Start-VEShellClient

    Overrides default Virtualization Extensions Service connection settings.

    Get-License

    Gets information about a license installed for the Virtualization Extensions Service.

    Install-License

    Installs a new license for the Virtualization Extensions Service.

    VMware server

    Name

    Description

    Get-VMwareServer

    Gets VMware servers registered in the Virtualization Extensions Service configuration.

    Add-VMwareServer

    Adds VMware server connection to the Virtualization Extensions Service configuration.

    Remove-VMwareServer

    Removes VMware server connection from the Virtualization Extensions Service configuration.

    Test-VMwareServerConnection

    Tests VMware server(s) connection.

    Set-VMwareServerConnectionSettings

    Changes connection settings for the VMware server.

    Set-VMwareServerNewJobPlaceholder

    Moves the New Job Placeholder for a registered VMware server to the specified monitoring group.

    Set-VMwareServerProxySettings

    Sets proxy connection settings for a registered VMware server.

    Out-TopologyTree

    Formats VMware server topology to a tree view format.

    Enable-Monitoring (VMware)

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

    Disable-Monitoring (VMware)

    Disables monitoring of separate vSphere clusters and hosts under a registered VMware server.

    Hyper-V server

    Name

    Description

    Get-HypervServer

    Gets Hyper-V servers discovered by Veeam Management Pack.

    Enable-Monitoring (Hyper-V)

    Enables monitoring of Hyper-V servers discovered by Veeam Management Pack.

    Disable-Monitoring (Hyper-V)

    Disables monitoring of Hyper-V servers discovered by Veeam Management Pack.

    Collector

    Name

    Description

    Get-Collector

    Gets Collectors registered in the Virtualization Extensions Service configuration.

    Unregister-Collector

    Unregisters a Collector from the Virtualization Extension Service.

    Move-Collector

    Moves the Collector from one monitoring group to another.

    Invoke-RebuildTopology

    Forces topology rebuild for one or more Collectors.

    Invoke-LoadBalance

    Forces monitoring load balancing across available Collectors.

    Get-CollectorSettings

    Gets Collector settings for the specified level of the Veeam Collectors hierarchy (monitoring group or Collector).

    Get-GlobalCollectorSettings

    Gets Collector settings for the root level of the Veeam Collectors hierarchy.

    Get-CollectorJobs

    Sets the value of the specified Extensions Service setting.

    Move-CollectorJobs

    Moves one or more monitoring jobs from one Collector to another.

    Monitoring group

    Name

    Description

    Get-MonitoringGroup

    Gets existing monitoring groups for the Virtualization Extensions Service.

    Add-MonitoringGroup

    Add a new monitoring group to the Virtualization Extensions Service configuration.

    Remove-MonitoringGroup

    Removes the monitoring group from the Virtualization Extensions Service configuration.

    Rename-MonitoringGroup

    Changes the name of the specified monitoring group.