Enable-VMIntegrationService

Enable-VMIntegrationService

Enables an integration service on a virtual machine.

Syntax

Parameter Set: VMName
Enable-VMIntegrationService [-Name] <String[]> [-VMName] <String[]> [-ComputerName <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMIntegrationService
Enable-VMIntegrationService [-VMIntegrationService] <VMIntegrationComponent[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Enable-VMIntegrationService [-Name] <String[]> [-VM] <VirtualMachine[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Enable-VMIntegrationService cmdlet enables an integration service on a virtual machine.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which an integration service is to be enabled. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.

Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the name of the integration service to be enabled.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Passthru

Specifies that a Microsoft.Virtualization.PowerShell.IntegrationService object is to be passed through to the pipeline representing the integration service to be enabled.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VM<VirtualMachine[]>

Specifies the virtual machine on which the integration service is to be enabled.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMIntegrationService<VMIntegrationComponent[]>

Specifies the integration service to be enabled.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMName<String[]>

Specifies the name of the virtual machine on which the integration service is to be enabled.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None by default; Microsoft.Virtualization.PowerShell.IntegrationService if –PassThru is specified.

Examples

Example 1

Enables integration services Shutdown and VSS on virtual machine Test1.

PS C:\> Enable-VMIntegrationService -Name Shutdown,VSS -VMName Test1

Example 2

Enables integration services Shutdown and VSS on virtual machine Test1.

PS C:\> Get-VMIntegrationService Shutdown,Vss -VMName Test1 | Enable-VMIntegrationService

Example 3

Enables integration services Shutdown and VSS on virtual machine Test1.

PS C:\> Get-VM Test1 | Enable-VMIntegrationService Shutdown,VSS