Set-SCVMHost

Reference

Module:: VirtualMachineManager

Modifies properties of a virtual machine host.

Syntax

Set-SCVMHost
   [-VMHost] <Host>
   [-BMCAddress <String>]
   [-BMCRunAsAccount <RunAsAccount>]
   [-BMCPort <UInt32>]
   [-BMCProtocol <OutOfBandManagementType>]
   [-BMCCustomConfigurationProvider <ConfigurationProvider>]
   [-ManagementAdapterMACAddress <String>]
   [-SMBiosGuid <Guid>]
   [-KeyProtectionServerUrl <String>]
   [-AttestationServerUrl <String>]
   [-CodeIntegrityPolicy <CodeIntegrityPolicy>]
   [-ApplyLatestCodeIntegrityPolicy]
   [-BypassMaintenanceModeCheck]
   [-MaintenanceHost <Boolean>]
   [-AvailableForPlacement <Boolean>]
   [-Description <String>]
   [-OverrideHostGroupReserves <Boolean>]
   [-CPUPercentageReserve <UInt16>]
   [-NetworkPercentageReserve <UInt16>]
   [-DiskSpaceReserveMB <UInt64>]
   [-MaxDiskIOReservation <UInt64>]
   [-MemoryReserveMB <UInt64>]
   [-VMPaths <String>]
   [-BaseDiskPaths <String>]
   [-RemoteConnectEnabled <Boolean>]
   [-RemoteConnectPort <UInt32>]
   [-SecureRemoteConnectEnabled <Boolean>]
   [-RemoteConnectCertificatePath <String>]
   [-RemoveRemoteConnectCertificate]
   [-EnableLiveMigration <Boolean>]
   [-LiveMigrationMaximum <UInt32>]
   [-LiveStorageMigrationMaximum <UInt32>]
   [-UseAnyMigrationSubnet <Boolean>]
   [-MigrationSubnet <String[]>]
   [-MigrationAuthProtocol <MigrationAuthProtocolType>]
   [-MigrationPerformanceOption <MigrationPerformanceOptionType>]
   [-VMHostManagementCredential <VMMCredential>]
   [-NumaSpanningEnabled <Boolean>]
   [-FibreChannelWorldWidePortNameMinimum <String>]
   [-FibreChannelWorldWidePortNameMaximum <String>]
   [-FibreChannelWorldWideNodeName <String>]
   [-IsDedicatedToNetworkVirtualizationGateway <Boolean>]
   [-JobGroup <Guid>]
   [-Custom1 <String>]
   [-Custom2 <String>]
   [-Custom3 <String>]
   [-Custom4 <String>]
   [-Custom5 <String>]
   [-Custom6 <String>]
   [-Custom7 <String>]
   [-Custom8 <String>]
   [-Custom9 <String>]
   [-Custom10 <String>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCVMHost cmdlet modifies one or more properties of a virtual machine host managed by Virtual Machine Manager (VMM). Settings that you can modify with the Set-SCVMHost cmdlet are summarized as follows:

Availability as a Host for Virtual Machines

You can specify whether a host is currently considered by the VMM placement process as a candidate on which to place virtual machines.

Host Reserve Settings

You can configure the following host reserve settings:

Percentage of CPU usage to set aside for use by the host.
Amount of disk space (MB) to set aside for use by the host.
Maximum number of disk I/O operations per second (IOPS) to set aside for use by the host.
Amount of memory (MB) to set aside for use by the host.
Percentage of network capacity to set aside for use by the host.

The VMM placement process will not recommend placing a virtual machine on a host unless the resource requirements of the virtual machine can be met without using the host reserves. If you do not specify reserve settings, VMM uses default settings.

Virtual Machine Paths

You can specify, as a set of default paths, locations on a host where virtual machine files can be stored.

Credential for Managing Hosts in a Perimeter Network or Non-Trusted Domain

You can specify the password for an account used to manage Hyper-V hosts that are located in a perimeter network or in a non-trusted domain.

Remote Connection Settings

You can configure remote connection settings for Hyper-V hosts (VMConnect) that enable users to connect to virtual machines remotely. This setting does not apply to virtual machines on VMware ESX hosts.

Examples

Example 1: Make a host available for placement

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01" 
PS C:\> Set-SCVMHost -VMHost $VMHost -AvailableForPlacement $True

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command makes VMHost01 available as a host for virtual machines. Setting the AvailableForPlacement parameter to True enables the VMM placement process to evaluate this host as a possible candidate on which to deploy virtual machines.

Example 2: Enable remote connections on a Hyper-V host

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01" 
PS C:\> Set-SCVMHost -VMHost $VMHost -RemoteConnectEnabled $True -RemoteConnectPort 5900

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command enables remote connections on VMHost01 and sets the port used for remote connections to 5900.

Enabling remote connections on a Hyper-V host allows users to remotely access and manage their virtual machines on the host.

Example 3: Update the virtual machine paths for a host

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01" 
PS C:\> Set-SCVMHost -VMHost $VMHost -VMPaths "C:\ProgramData\Microsoft\Windows\Hyper-V|D:\VirtualMachinePath"

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command updates the VMPaths property for the host stored in $VMHost by adding the path D:\VirtualMachinePath to the list of virtual machine paths on that host.

Example 4: Update the resource reserves for a host

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost01" 
PS C:\> Set-SCVMHost -VMHost $VMHost -CPUPercentageReserve 40 -DiskSpaceReserveMB 2048 -MaxDiskIOReservation 500 -MemoryReserveMB 1024 -NetworkPercentageReserve 40

The first command gets the host object named VMHost01 and stores the object in the $VMHost variable.

The second command updates the specified properties for VMHost01.

Example 5: Update the bare-metal computer username and password for a specified physical host

PS C:\> $VMHost = Get-SCVMHost -ComputerName "VMHost02"
PS C:\> $BMCRAA = Get-SCRunAsAccount -Name "BMCCreds"
PS C:\> Set-SCVMHost $VMHost -BMCRunAsAccount $BMCRAA
PS C:\> Read-SCVMHost -VMHost $VMHost -RefreshOutOfBandProperties

The first command gets the host object named VMHost02 and stores the object in the $VMHost variable.

The second command gets the Run As account object named BMCCreds and stores the object in the $BMCRAA variable.

The third command updates the host stored in $VMHost with the new Run As account stored in $BMCRAA.

The last command refreshes the host stored in $VMHost using its out-of-band interface, which updates the Run As account for the host.

Example 6: Update the certificates for XenServer hosts in a cluster

PS C:\> $VMHost = Get-VMHost -ComputerName "XenHost01" 
PS C:\> $Cert = Get-SCCertificate -Computername $VMHost.Name 
PS C:\> Set-SCVMHost -VMHost $VMHost -Certificate $Cert -EnableSecureMode $True

The first command gets the host object named XenHost01 and stores the object in the $VMhost variable.

The second gets the certificate object for XenHost01 and stores the object in the $Certificate variable.

The last command uses the certificate supplied in $Cert to enable VMM to communicate with XenHost01 in secure mode.

Parameters

-ApplyLatestCodeIntegrityPolicy

Indicates that this cmdlet causes the host to update its HVCI policy using the file location stored in CodeIntegrityPolicyPath.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AttestationServerUrl

Specifies the URL of the attestation server.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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 use this parameter with network adapters, if set to $False, then placement does 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

-BMCAddress

Specifies, or updates, the out-of-band baseboard management controller (BMC) address for a specific physical machine. This might be an IP address, the fully qualified domain name (FQDN), or the DNS prefix (which is usually the same name as the NetBIOS name).

Typically, the BMC address and its connection to the network are separate from the IP address associated with a standard network adapter. Alternatively, some computers do use a standard network adapter to provide a single address for the BMC and for the network adapter. However, the BMC address has a unique port and is thus uniquely identifiable on the network.

Example IPv4 format: -BMCAddress "10.0.0.21"
Example Ipv6 format: -BMCAddress "2001:4898:2a:3:657b:9c7a:e1f0:6829"
Example FQDN format: -BMCAddress "Computer01.Contoso.com"
Example NetBIOS format: -BMCAddress "Computer01"

Note: By default, VMM uses an IP address or FQDN for the BMCAddress. However, it is also possible to create a Windows PowerShell module that enables you to specify other types of addresses as the BMC address.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BMCCustomConfigurationProvider

Specifies, or updates, a configuration provider object for a baseboard management controller (BMC). A configuration provider is a plug-in to VMM that translates VMM PowerShell commands to API calls that are specific to a type of BMC. Use this parameter with the Custom BMCProtocol.

Type:	ConfigurationProvider
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BMCPort

Specifies, or updates, the out-of-band baseboard management controller (BMC) port for a specific physical machine. A BMC port is also known as a service processor port. Example default ports are 623 for IPMI and 443 for SMASH over WS-Man.

Type:	UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BMCProtocol

Specifies, or updates, the protocol that VMM uses to communicate with the out-of-band baseboard management controller (BMC). Valid values are:

IPMI
SMASH
Custom

A BMC (also known as a service processor or management controller) is a specialized controller on the motherboard of a server that acts an interface between the hardware and system management software. If the motherboard of a physical machine includes a BMC, when the machine is plugged in (whether it is powered off or powered on, and whether or not an operating system is installed), information about system hardware and the state of that system hardware health is available.

Example format: -BMCProtocol "Custom"

Note: The Custom protocol requires that you use the BMCCustomConfigurationProvider parameter.

Type:	OutOfBandManagementType
Accepted values:	None, IPMI, SMASH, Custom
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BMCRunAsAccount

Specifies the Run As account to use with the baseboard management controller (BMC) device.

Type:	RunAsAccount
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BypassMaintenanceModeCheck

Indicates that Code Integrity policy gets applied to the host even if the host is not in maintenance mode. By default, applying Code Integrity policy fails if the host is not in maintenance mode.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CodeIntegrityPolicy

Specifies the Code Integrity policy to be used to restrict the software that can run on the host.

Type:	CodeIntegrityPolicy
Position:	Named
Default value:	None
Required:	False
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