Set-SCVMMServer

Set-SCVMMServer

Changes properties of the VMM management server.

Syntax

Parameter Set: Default
Set-SCVMMServer [-AutomaticLogicalNetworkCreationEnabled <Boolean> ] [-AutomaticVirtualNetworkCreationEnabled <Boolean]> ] [-BackupLogicalNetworkMatch <LogicalNetworkMatchOption> {Disabled | FirstDNSSuffixLabel | DNSSuffix | NetworkConnectionName | VirtualNetworkSwitchName} ] [-CEIPOptIn <Boolean> ] [-JobVariable <String> ] [-LibraryRefresherEnabled <Boolean> ] [-LibraryRefresherFrequency <UInt16> ] [-LogicalNetworkMatch <LogicalNetworkMatchOption> {Disabled | FirstDNSSuffixLabel | DNSSuffix | NetworkConnectionName | VirtualNetworkSwitchName} ] [-PortACL <PortACL> ] [-PROTipID <Guid]> ] [-RemovePortACL] [-RunAsynchronously] [-VMConnectDefaultPort <UInt32> ] [-VMConnectGatewayCertificatePassword <SecureString> ] [-VMConnectGatewayCertificatePath <String> ] [-VMConnectHostIdentificationMode <VMConnectHostIDMode]> ] [-VMConnectHyperVCertificatePassword <SecureString> ] [-VMConnectHyperVCertificatePath <String> ] [-VMConnectTimeToLiveInMinutes <Int32]> ] [-VMMServer <ServerConnection> ] [-VMRCAccessAccount <String> ] [-VMRCDefaultPort <UInt32> ] [-VMSubnetIDRangeEnd <UInt32> ] [-VMSubnetIDRangeStart <UInt32> ] [ <CommonParameters>]

Detailed Description

The Set-SCVMMServer cmdlet changes one or more properties of the Virtual Machine Manager (VMM) management server. VMM settings that you can change with the Set-SCVMMServer cmdlet include the following:

-- Configure Federated Authentication

You can use the parameters provided with Set-SCVMMServer to configure Federated Authentication. Federated authentication allows a user to connect to the console of a virtual machine without having credentials on the Hyper-V host computer. Use the New-SCVMConnectFedAuth cmdlet to issue Federated Authentication tokens.

-- Microsoft Customer Experience Improvement Program (CEIP) Participation

You can use Set-SCVMMServer to specify whether to enable Service Quality Metrics (SQM) for this VMM management server.

-- Library Settings

You can use Set-SCVMMServer to specify whether the Virtual Machine Manager library refresher is enabled and, if so, how often objects in the library are refreshed.

-- Remote Control

You can use Set-SCVMMServer to configure the default remote control port to use when connecting to virtual machines (VMConnect).

-- Contact for Self-Service Users

You can use Set-SCVMMServer to specify the e-mail address of an administrator who supports self-service users.

-- Network Settings

You can use the Set-VMMServer cmdlet to configure how to match logical networks. You can also enable creation of logical and virtual networks automatically.

-- Guest Agent Settings

You can use Set-SCVMMServer to select the method used to communicate with the VMM guest agent: FQDN or IP Address.

Parameters

-AutomaticLogicalNetworkCreationEnabled<Boolean>

Indicates whether logical networks are created automatically. When set to $True, a new logical network is created, based on the logical network matching settings, if the host network network adapter is not associated with a logical network.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AutomaticVirtualNetworkCreationEnabled<Boolean]>

Indicates whether virtual networks are created automatically. When set to $True, if a host has one network adapter for placement associated with a logical network, but no virtual networks attached to the adapter, a new virtual network is created.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-BackupLogicalNetworkMatch<LogicalNetworkMatchOption>

Specifies the network matching method to use if the primary network matching method is not available.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CEIPOptIn<Boolean>

Enables Service Quality Metrics (SQM) for this server and thus participation in the Microsoft Customer Experience Improvement Program (CEIP), which collects information about problems customers encounter in order to improve the software in a later release.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-LibraryRefresherEnabled<Boolean>

Indicates, when set to $True, that VMM library objects are refreshed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-LibraryRefresherFrequency<UInt16>

Specifies, in hours, the frequency at which objects in the VMM library are refreshed. The default value is 1 hour.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-LogicalNetworkMatch<LogicalNetworkMatchOption>

Specifies the logical network matching method to use for automatically creating logical networks. Valid values are:

-- Disabled
-- FirstDNSSuffixLabel
-- DNSSuffix
-- NetworkConnectionName
-- VirtualNetworkSwitchName

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PortACL<PortACL>

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RemovePortACL

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMConnectDefaultPort<UInt32>

Specifies the default value for the TCP port used for Virtual Machine Connection (VMConnect) sessions on all Hyper-V hosts managed by this VMM server. Typically, the default port is 2179, but you can use this parameter to change the default. This parameter does not apply to VMware ESX Server hosts or Citrix XenServer hosts.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMConnectGatewayCertificatePassword<SecureString>

Specifies, as a secure string, the gateway certificate password. A value must be provided for this parameter when the VMConnectGatewayCertificatePath parameter is used.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMConnectGatewayCertificatePath<String>

Specifies the path to a private key certificate (.pfx file).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMConnectHostIdentificationMode<VMConnectHostIDMode]>

Specifies how the Hyper-V host is identified. Valid values are:

-- FQDN
-- IPv4
-- IPv6
-- HostName

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMConnectHyperVCertificatePassword<SecureString>

Specifies, as a secure string, the Hyper-V certificate password. A value must be provided for this parameter when the VMConnectHyperVCertificatePath parameter is used.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMConnectHyperVCertificatePath<String>

Specifies the path to a private key certificate (.pfx file).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMConnectTimeToLiveInMinutes<Int32]>

Specifies, in minutes, the validity period for which the tokens are issues. Valid values are 1 to 60.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMRCAccessAccount<String>

Specifies the account to use when connecting to a virtual machine by using Virtual Machine Remote Control (VMRC).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMRCDefaultPort<UInt32>

Specifies the default port to use when connecting to a virtual machine by using Virtual Machine Remote Control (VMRC).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMSubnetIDRangeEnd<UInt32>

Specifies the ending ID for a VM subnet ID range.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VMSubnetIDRangeStart<UInt32>

Specifies the starting ID for a VM subnet ID range.

Aliases	none
Required?	false
Position?	named
Default Value	none
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.

• VMMServer

Examples

Example 1: Set the frequency at which the library is refreshed

This command enables library refreshing for VMMServer01 and sets the refreshing frequency rate to every 24 hours.

PS C:\> Set-SCVMMServer -VMMServer "VMMServer01.Contoso.com" -LibraryRefresherEnabled $True -LibraryRefresherFrequency 24

Example 2: Opt out of the Customer Experience Improvement Program

This command opts out of participation in the CEIP by setting the CEIPOptIn parameter to $False on VMMServer01.

PS C:\> Set-SCVMMServer -VMMServer "VMMServer01.Contoso.com" -CEIPOptIn $False

Example 3: Specify a self-service contact e-mail address

This command sets the self-service contact e-mail address to AdminHelp@Contoso.com on VMMServer01.

PS C:\> Set-SCVMMServer -VMMServer "VMMServer01.Contoso.com" -SelfServiceContactEmail "AdminHelp@Contoso.com"

Related topics

Get-SCVMMServer

New-SCVMConnectFedAuth