Add-SCVMHost
Adds a computer as a virtual machine host.
Syntax
Add-SCVMHost
[-VMHostGroup <HostGroup>]
[-VMMServer <ServerConnection>]
[-ComputerName] <String>
[-MaintenanceHost <Boolean>]
[-AvailableForPlacement <Boolean>]
[-Description <String>]
[-CPUPercentageReserve <UInt16>]
[-NetworkPercentageReserve <UInt16>]
[-DiskSpaceReserveMB <UInt64>]
[-MaxDiskIOReservation <UInt64>]
[-MemoryReserveMB <UInt64>]
[-VMPaths <String>]
[-BaseDiskPaths <String>]
[-RemoteConnectEnabled <Boolean>]
[-RemoteConnectPort <UInt32>]
[-EnableLiveMigration <Boolean>]
[-LiveMigrationMaximum <UInt32>]
[-LiveStorageMigrationMaximum <UInt32>]
[-UseAnyMigrationSubnet <Boolean>]
[-MigrationSubnet <String[]>]
[-MigrationAuthProtocol <MigrationAuthProtocolType>]
[-MigrationPerformanceOption <MigrationPerformanceOptionType>]
[-Reassociate <Boolean>]
-Credential <VMMCredential>
[-IsDedicatedToNetworkVirtualizationGateway <Boolean>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]Add-SCVMHost
[-VMHostGroup <HostGroup>]
[-VMMServer <ServerConnection>]
[-ComputerName] <String>
[-MaintenanceHost <Boolean>]
[-AvailableForPlacement <Boolean>]
[-TCPPort <UInt32>]
[-Certificate <ClientCertificate>]
[-Description <String>]
[-CPUPercentageReserve <UInt16>]
[-NetworkPercentageReserve <UInt16>]
[-DiskSpaceReserveMB <UInt64>]
[-MaxDiskIOReservation <UInt64>]
[-MemoryReserveMB <UInt64>]
[-VMPaths <String>]
[-BaseDiskPaths <String>]
[-RemoteConnectEnabled <Boolean>]
[-RemoteConnectPort <UInt32>]
[-EnableLiveMigration <Boolean>]
[-LiveMigrationMaximum <UInt32>]
[-LiveStorageMigrationMaximum <UInt32>]
[-UseAnyMigrationSubnet <Boolean>]
[-MigrationSubnet <String[]>]
[-MigrationAuthProtocol <MigrationAuthProtocolType>]
[-MigrationPerformanceOption <MigrationPerformanceOptionType>]
[-XenServerHost]
[-EnableSecureMode <Boolean>]
[-Reassociate <Boolean>]
-Credential <VMMCredential>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]Add-SCVMHost
[-VMHostGroup <HostGroup>]
[-VMMServer <ServerConnection>]
[-ComputerName] <String>
[-MaintenanceHost <Boolean>]
[-AvailableForPlacement <Boolean>]
[-Description <String>]
[-CPUPercentageReserve <UInt16>]
[-NetworkPercentageReserve <UInt16>]
[-DiskSpaceReserveMB <UInt64>]
[-MaxDiskIOReservation <UInt64>]
[-MemoryReserveMB <UInt64>]
[-VMPaths <String>]
[-BaseDiskPaths <String>]
[-RemoteConnectEnabled <Boolean>]
[-RemoteConnectPort <UInt32>]
[-EnableLiveMigration <Boolean>]
[-LiveMigrationMaximum <UInt32>]
[-LiveStorageMigrationMaximum <UInt32>]
[-UseAnyMigrationSubnet <Boolean>]
[-MigrationSubnet <String[]>]
[-MigrationAuthProtocol <MigrationAuthProtocolType>]
[-MigrationPerformanceOption <MigrationPerformanceOptionType>]
[-NonTrustedDomainHost]
[-Reassociate <Boolean>]
-Credential <VMMCredential>
[-IsDedicatedToNetworkVirtualizationGateway <Boolean>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]Add-SCVMHost
[-VMHostGroup <HostGroup>]
[-VMMServer <ServerConnection>]
[-ComputerName] <String>
[-MaintenanceHost <Boolean>]
[-AvailableForPlacement <Boolean>]
[-Description <String>]
[-CPUPercentageReserve <UInt16>]
[-NetworkPercentageReserve <UInt16>]
[-DiskSpaceReserveMB <UInt64>]
[-MaxDiskIOReservation <UInt64>]
[-MemoryReserveMB <UInt64>]
[-VMPaths <String>]
[-BaseDiskPaths <String>]
[-RemoteConnectEnabled <Boolean>]
[-RemoteConnectPort <UInt32>]
[-EnableLiveMigration <Boolean>]
[-LiveMigrationMaximum <UInt32>]
[-LiveStorageMigrationMaximum <UInt32>]
[-UseAnyMigrationSubnet <Boolean>]
[-MigrationSubnet <String[]>]
[-MigrationAuthProtocol <MigrationAuthProtocolType>]
[-MigrationPerformanceOption <MigrationPerformanceOptionType>]
[-PerimeterNetworkHost]
[-Reassociate <Boolean>]
-SecurityFile <String>
-EncryptionKey <PSCredential>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]Add-SCVMHost
[-VMHostGroup <HostGroup>]
-VirtualizationManager <VirtualizationManager>
[-VMMServer <ServerConnection>]
[-ComputerName] <String>
[-MaintenanceHost <Boolean>]
[-AvailableForPlacement <Boolean>]
[-TCPPort <UInt32>]
[-Certificate <ClientCertificate>]
[-SshTcpPort <UInt32>]
[-SshPublicKey <ClientSshPublicKey>]
[-SshPublicKeyFile <String>]
[-Description <String>]
[-CPUPercentageReserve <UInt16>]
[-NetworkPercentageReserve <UInt16>]
[-DiskSpaceReserveMB <UInt64>]
[-MaxDiskIOReservation <UInt64>]
[-MemoryReserveMB <UInt64>]
[-VMPaths <String>]
[-BaseDiskPaths <String>]
[-RemoteConnectEnabled <Boolean>]
[-RemoteConnectPort <UInt32>]
[-EnableLiveMigration <Boolean>]
[-LiveMigrationMaximum <UInt32>]
[-LiveStorageMigrationMaximum <UInt32>]
[-UseAnyMigrationSubnet <Boolean>]
[-MigrationSubnet <String[]>]
[-MigrationAuthProtocol <MigrationAuthProtocolType>]
[-MigrationPerformanceOption <MigrationPerformanceOptionType>]
[-Reassociate <Boolean>]
-Credential <VMMCredential>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]Add-SCVMHost
-VMHostCluster <HostCluster>
[-VMMServer <ServerConnection>]
[-ComputerName] <String>
[-MaintenanceHost <Boolean>]
[-AvailableForPlacement <Boolean>]
[-TCPPort <UInt32>]
[-Certificate <ClientCertificate>]
[-Description <String>]
[-CPUPercentageReserve <UInt16>]
[-NetworkPercentageReserve <UInt16>]
[-DiskSpaceReserveMB <UInt64>]
[-MaxDiskIOReservation <UInt64>]
[-MemoryReserveMB <UInt64>]
[-VMPaths <String>]
[-BaseDiskPaths <String>]
[-RemoteConnectEnabled <Boolean>]
[-RemoteConnectPort <UInt32>]
[-EnableLiveMigration <Boolean>]
[-LiveMigrationMaximum <UInt32>]
[-LiveStorageMigrationMaximum <UInt32>]
[-UseAnyMigrationSubnet <Boolean>]
[-MigrationSubnet <String[]>]
[-MigrationAuthProtocol <MigrationAuthProtocolType>]
[-MigrationPerformanceOption <MigrationPerformanceOptionType>]
[-EnableSecureMode <Boolean>]
[-Reassociate <Boolean>]
-Credential <VMMCredential>
[-IsDedicatedToNetworkVirtualizationGateway <Boolean>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]Description
The Add-SCVMHost cmdlet adds one or more computers as virtual machine hosts to Virtual Machine Manager (VMM). A virtual machine host is a physical computer managed by VMM whose role is to host one or more virtual machines.
Virtual Machine Host Support in System Center 2019 - VMM
From the perspective of networking and domains, the types of hosts that System Center 2019 - VMM supports include:
- Domain-joined Windows host. The host can be located in either a trusted or untrusted domain.
- Perimeter network Windows host. A non-domain-joined Windows host can be managed in the same way as a perimeter network Windows host that is located in a domain.
- A VMware ESX host. ESX hosts do not use Windows Active Directory domains.
- A Citrix XenServer host. XenServer hosts are managed in the same way whether or not they are configured to use Windows Active Directory.
From the perspective of virtualization platform and operating system, the types of hosts that System Center 2019 - VMM supports include:
- Hyper-V hosts. A server running Windows Server 2008 or later with the Hyper-V role enabled.
- VMware ESX hosts. A VMware ESX host running proprietary software, including a hypervisor, that is managed by a VMware vCenter Server running Windows.
- Citrix XenServer hosts. A Citrix XenServer server running proprietary software, including a hypervisor.
System Center 2019 - VMM manages these three types of hosts, even though each host type implements virtualization in a different way. The following sections describe each type of host in more detail. You can review Preparing your environment for System Center 2019 - Virtual Machine Managerhttp://go.microsoft.com/fwlink/?LinkId=799436 in the Microsoft TechNet library at http://go.microsoft.com/fwlink/?LinkId=799436.
Before You Add a Hyper-V Host
- Review Managing Hyper-V hosts and host clusters with VMMhttp://go.microsoft.com/fwlink/?LinkID=799438 in the Microsoft TechNet library at http://go.microsoft.com/fwlink/?LinkID=799438.
- The Add-SCVMHost cmdlet enables the Hyper-V server role for you, but you must first configure the Virtualization option in the BIOS manually.
Before You Add a Windows-Based Perimeter Network Host
To manage a Windows-based host in a perimeter network:
- Install the VMM agent locally on the perimeter network host.
- When you run VMM Setup and choose the option indicating that this host is on a perimeter network, the wizard prompts you to: -- Provide an encryption key for the security file. -- Specify where you want to store the security file.
- After you have installed the local agent, obtain the security file from the folder in which it is stored. The default location is C:\Program Files\Microsoft System Center 2016\Virtual Machine Manager, and the name of the security file is SecurityFile.txt
- Copy the security file to a location that is accessible to the computer on which a VMM console is installed.
- When you use Add-SCVMHost to add the perimeter network host, you must specify the same encryption key and point to the local security file by using the EncryptionKey and SecurityFile parameters. Followng is an example format for these parameters:
-SecurityFile "C:\SecurityFile.txt" -EncryptionKey $Key
Example 2 outlines the cmdlets to use to add a perimeter network host.
Before You Add a VMware ESX Host
- Review System Requirements for System Center Technical Previewhttp://go.microsoft.com/fwlink/?LinkID=799442 in the Microsoft TechNet Library at http://go.microsoft.com/fwlink/?LinkID=799442.
Before You Add a Citrix XenServer Host
- Review System Requirements for System Center Technical Previewhttp://go.microsoft.com/fwlink/?LinkId=799442 in the Microsoft TechNet library at http://go.microsoft.com/fwlink/?LinkId=799442.
Examples
Example 1: Add a host in the same domain as the VMM server
PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "RunAsAcct01"
PS C:\> Add-SCVMHost "VMHost01.Contoso.com" -Description "This is a new host" -RemoteConnectEnabled $True -RemoteConnectPort 5900 -Credential $RunAsAccountThe first command gets the Run As account object named HostComputer RunAsAccount and stores the object in the $RunAsAccount variable.The required credentials for this operation are either a local Administrator account or a domain account with administrator rights on the computer that you want to add as a host.
The second command adds the host object named VMHost01 in the Contoso domain to VMM as a managed host, specifies a description, enables remote connections, and specifies that TCP port 5900 will be used for remote connections to VMHost01. As the last command is processed, $RunAsAccount provides credentials to Add-SCVMHost.
Example 2: Add a host located in a perimeter network to VMM
PS C:\> $Key = Get-SCCredential
PS C:\> Add-SCVMHost "VMHost02" -Description "This is my new perimeter network host" -RemoteConnectEnabled $FALSE -PerimeterNetworkHost -SecurityFile "C:\SecurityFile.txt" -EncryptionKey $KeyThe first command prompts you for a user name and password and stores the credentials in $Key. The user name can be any user name, but the password must be the same encryption key that was used when the VMM agent was installed on this computer. The VMM agent must be installed locally on a computer located in a perimeter network by choosing the local agent option when you run Setup. You specify the encryption key for the security file on the Security File Folder page of the System Center 2019 Virtual Machine Manager Agent Setup wizard.
The second command adds a host object that represents the computer named VMHost02 to the VMM database as a managed host. The command adds a description, disables remote connections, and specifies that this host is located in a perimeter network. This command uses the credentials stored in $Key to decrypt the contents of SecurityFile.txt (which, in this example, is located at C:\) and then uses the contents of SecurityFile.txt to authenticate the new host.
Example 3: Add a host located in a non-trusted domain to VMM
PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "RunAsAccount02"
PS C:\> Add-SCVMHost "VMHost03.NonTrustedDomain.com" -VMMServer "VMMServer01.Contoso.com" -NonTrustedDomainHost -Credential $RunAsAccountThe first command gets the Run As account object named RunAsAccount02 and stores the object in the $RunAsAccount variable. The required credentials for this operation are an account with administrator rights to add a host located in the non-trusted domain to the VMM server in the Contoso.com domain.
The second command adds VMHost03, located in a domain that is not trusted by Contoso.com, to the VMM database as a managed host. As this command is processed, $RunAsAccont provides credentials to Add-SCVMHost.
Example 4: Add a VMware ESX host to VMM
PS C:\> $HostGroup = Get-SCVMHostGroup "HostGroup02"
PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "ESX Host Computer Acct"
PS C:\> $VirtMgr = Get-SCVirtualizationManager -ComputerName "VirtMgrServer02.Contoso.com"
PS C:\> Add-SCVMHost -ComputerName "ESXHost01.Contoso.com" -Credential $RunAsAccount -VirtualizationManager $VirtMgr -VMHostGroup $HostGroupThe first command gets the host group object named HostGroup02 and stores the object in the $HostGroup variable.
The second command gets the Run As account object named ESX Host Computer Acct and stores the object in the $RunAsAccount variable.
The third command gets the virtualization manager object named VirtMgrServer02 and stores the object in the $VirtMgr variable.
The last command adds ESX Host01 to HostGroup02. The command provides the credentials in the form of a Run As account stored in $RunAsAccount, which is required to add this host to VMM.
Example 5: Add a Citrix XenServer host to VMM
PS C:\> $HostGroup = Get-SCVMHostGroup "HostGroup04"
PS C:\> $RunAsAccount = Get-SCRunAsAccount -Name "XenServer Run As Acct"
PS C:\> $Certificate = Get-SCCertificate -ComputerName "XenServerHost01.Contoso.com"
PS C:\> Add-SCVMHost -ComputerName "XenServerHost01.Contoso.com" -Credential $RunAsAccount -VMHostGroup $HostGroup -XenServerHost -Certificate $Certificate -EnableSecureMode $True -TCPPort 5989The first command gets the host group object named HostGroup04 and stores the object in the $HostGroup variable.
The second command gets the Run As account object named XenServer Host Computer Acct and stores the object in the $RunAsAccount variable. The required credentials for this operation are an account with root credentials on the XenServer host.
The third command gets the certificate object for XenServerHost01 and stores the object in the $Certificate variable.
The last command adds a XenServer as a host to HostGroup04 in VMM and provides the credentials in the form of a Run As account stored in $RunAsAccount, which is required to add this host to VMM.
Parameters
-AvailableForPlacement
Indicates whether the VMM placement process will consider this host or this volume on a host to be eligible as a possible location on which to deploy virtual machines. If this parameter is set to $False, you can choose to deploy virtual machines on this host or volume anyway. The default value is True. This parameter does not apply to VMware ESX hosts.
When you specify this parameter with network adapters, if set to $False, then placement will not consider the logical networks configured on this network adapter to determine if the host is suitable for connecting a virtual machine.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BaseDiskPaths
Specifies the paths to base disks.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Certificate
Specifies a security certificate object.
| Type: | ClientCertificate |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are:
- FQDN
- IPv4 or IPv6 address
- NetBIOS name
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CPUPercentageReserve
Specifies the percentage of CPU to reserve for the use of the operating system on the physical host computer.
If you do not use this parameter to specify the reserve, the default setting for the host group is used: 10 percent. The VMM placement process will not recommend that a virtual machine be placed on a host unless its resource requirements can be met without using host reserves.
| Type: | UInt16 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies a credential object or, for some cmdlets, a Run As account object that contains the user name and password of an account that has permission to perform this action. Or, in the case of Restart-SCJob, has permission to complete a restarted task.
For more information about the PSCredential object, type Get-Help Get-Credential.
For more information about Run As accounts, type Get-Help New-SCRunAsAccount.
| Type: | VMMCredential |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specifies a description for the host.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiskSpaceReserveMB
Specifies the amount of disk space, in megabytes (MB), to reserve for the use of the operating system on the physical host computer.
If you do not use this parameter to specify the reserve, the default setting for the host group is used: 100 MB. The VMM placement process will not recommend that a virtual machine be placed on a host unless its resource requirements can be met without using host reserves.
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableLiveMigration
Indicates whether live migration is enabled on the host.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableSecureMode
Indicates whether VMM communicates with VMware ESX hosts and Citrix XenServer hosts in secure mode. The default value is $True.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EncryptionKey
Specifies credentials to be used as an encryption key when you add a Hyper-V host located in a perimeter network to VMM.
Example format: -SecurityFile "C:\SecurityFile.txt" -EncryptionKey $Key
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsDedicatedToNetworkVirtualizationGateway
Indicates whether the host is dedicated to a network virtualization gateway.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LiveMigrationMaximum
Specifies the maximum number of simultaneous live migrations.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LiveStorageMigrationMaximum
Specifies the maximum number of simultaneous live storage migrations.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaintenanceHost
This parameter is obsolete. Use AvailableForPlacement instead.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxDiskIOReservation
Specifies the maximum disk I/O per second (IOPS) on the physical host computer.
If you do not use this parameter to specify the reserve, the default setting for the host group is used: 10000. The VMM placement process will not recommend that a virtual machine be placed on a host unless its resource requirements can be met without using host reserves.
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MemoryReserveMB
Specifies the amount of memory, in megabytes (MB), to reserve for the use of the host operating system on the physical host computer.
If you do not use this parameter to specify the reserve, the default setting for the host group is used: 256 MB. The VMM placement process will not recommend that a virtual machine be placed on a host unless its resource requirements can be met without using host reserves.
| Type: | UInt64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MigrationAuthProtocol
Specifies the authorization protocol used for migration. Valid values are: CredSSP, Kerberos.
| Type: | MigrationAuthProtocolType |
| Accepted values: | CredSSP, Kerberos |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MigrationPerformanceOption
Specifies the migration performance option type. Valid values are:
- Standard
- UseCompression
- UseSmbTransport
| Type: | MigrationPerformanceOptionType |
| Accepted values: | Standard, UseCompression, UseSmbTransport |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MigrationSubnet
Specifies an array of subnets to use for migration.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NetworkPercentageReserve
Specifies the percentage of network capacity to reserve for the use of the host operating system on the physical host computer.
If you do not use this parameter to specify the reserve, the default setting for the host group is used: 10 percent. The VMM placement process will not recommend that a virtual machine be placed on a host unless its resource requirements can be met without using host reserves.
| Type: | UInt16 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NonTrustedDomainHost
Indicates that the host to be added to VMM belongs to a non-trusted domain.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PerimeterNetworkHost
Indicates that this host is located in a perimeter network.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Reassociate
Reassociates a host currently managed by one VMM server with another VMM server.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoteConnectEnabled
Enables, when set to $True, a connection on a host server that lets users connect to their virtual machines remotely.
This parameter only applies to virtual machines on Hyper-V hosts. It is not applicable to virtual machines on VMware ESX hosts or Citrix XenServer hosts.
| Type: | Boolean |
| Aliases: | VMRCEnabled |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoteConnectPort
Specifies a default value for the TCP port to use when a remote user connects to a virtual machine. Typically, the default port for a Hyper-V host is 2179.
This parameter does not apply to VMware ESX hosts or Citrix XenServer hosts.
| Type: | UInt32 |
| Aliases: | VMRCPort |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecurityFile
Specifies the path to a file that contains the certificate and credentials to use for authentication of a Hyper-V host located in a perimeter network.
This parameter does not apply to VMware ESX hosts or Citrix XenServer hosts.
Example format: -SecurityFile "C:\SecurityFile.txt" -EncryptionKey $Key
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SshPublicKey
Specifies the public key used by Secure Shell (SSH) communications.
| Type: | ClientSshPublicKey |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SshPublicKeyFile
Specifies the path to the public key file for establishing a secured SSH channel with the target hosts.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SshTcpPort
Specifies the TCP port number used by the SSH protocol.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TCPPort
Specifies a numeric value that represents a TCP port.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseAnyMigrationSubnet
Indicates whether any subnet can be used for migration.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualizationManager
Specifies a virtualization manager object managed by VMM.
| Type: | VirtualizationManager |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMHostCluster
Specifies a VMM host cluster object.
| Type: | HostCluster |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMHostGroup
Specifies a virtual machine host group object.
| Type: | HostGroup |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMPaths
Specifies a set of default paths (as strings separated by the pipeline operator) on a host where virtual machine files can be stored.
Example format: -VMPaths "C:\Folder1|C:\Folder2|C:\Folder3"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-XenServerHost
Indicates that the specified host is a Citrix XenServer host.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Host
This cmdlet returns a Host object.