Set-SCVMConfiguration
Set-SCVMConfiguration
Modifies the virtual machine configuration for a computer tier.
構文
Parameter Set: Update
Set-SCVMConfiguration [-VMConfiguration] <BaseVMConfiguration> [-AvailabilitySetNames <0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CostCenter <String> ] [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-NoConnectedHost] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PinVMHost <Boolean> ] [-PinVMLocation <Boolean> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Tag <String> ] [-VMLocation <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: Cloud
Set-SCVMConfiguration [-VMConfiguration] <BaseVMConfiguration> -Cloud <Cloud> [-AvailabilitySetNames <0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CostCenter <String> ] [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-NoConnectedHost] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PinVMHost <Boolean> ] [-PinVMLocation <Boolean> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Tag <String> ] [-VMLocation <String> ] [ <CommonParameters>]
Parameter Set: VMHost
Set-SCVMConfiguration [-VMConfiguration] <BaseVMConfiguration> -VMHost <Host> [-AvailabilitySetNames <0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CostCenter <String> ] [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-NoConnectedHost] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PinVMHost <Boolean> ] [-PinVMLocation <Boolean> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Tag <String> ] [-VMLocation <String> ] [ <CommonParameters>]
Parameter Set: VMHostGroup
Set-SCVMConfiguration [-VMConfiguration] <BaseVMConfiguration> [-AvailabilitySetNames <0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CostCenter <String> ] [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-NoConnectedHost] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PinVMHost <Boolean> ] [-PinVMLocation <Boolean> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Tag <String> ] [-VMHostGroup <HostGroup> ] [-VMLocation <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
詳細説明
The Set-SCVMConfiguration cmdlet modifies the virtual machine configuration for a computer tier. The virtual machine configuration describes how the virtual machine will be configured when the service is deployed.
パラメーター
-AvailabilitySetNames<0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]>
Specifies a list of availability set names.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CapabilityProfile<CapabilityProfile>
Specifies a capability profile object.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Cloud<Cloud>
Specifies a private cloud object.
エイリアス |
none |
必須? |
true |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ComputerName<String>
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are:
-- FQDN
-- IPv4 or IPv6 address
-- NetBIOS name
NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CostCenter<String>
Specifies the cost center for a virtual machine so that you can collect data about the allocation of virtual machines, or resources allocated to virtual machines, to make use of in your billing system.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Description<String>
States a description for the specified object.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Name<String>
Specifies the name of a VMM object.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-NoConnectedHost
Removes the host from a virtual machine configuration.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-OnBehalfOfUser<System.String>
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PinVMHost<Boolean>
Indicates whether the virtual machine host chosen by the user is retained during service deployment configuration.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PinVMLocation<Boolean>
Indicates whether the virtual machine location chosen by the user is retained during service deployment configuration.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Tag<String>
Specifies a word or phrase to associate with an object so that you can search for all objects with the specified set of tags. You can search for a subset of tags, or you can search for the full set of tags.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-VMConfiguration<BaseVMConfiguration>
Specifies a virtual machine configuration object.
エイリアス |
none |
必須? |
true |
位置は? |
1 |
既定値 |
none |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
-VMHost<Host>
Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts.
For more information about each type of host, type Get-Help Add-SCVMHost -detailed
. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.
エイリアス |
none |
必須? |
true |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-VMHostGroup<HostGroup>
Specifies a virtual machine host group object.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-VMLocation<String>
Specifies the path to a virtual machine.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- VMConfiguration
例
Example Example 1:. Update the virtual machine configuration for a machine tier prior to deploying the service.:
The first command gets the service configuration object named Service01, and then stores the object in the $ServiceConfig variable.
The second command gets the computer tier configuration for the service configuration stored in $ServiceConfig, and then stores the object in the $TierConfig variable.
The third command gets the virtual machine configuration for the computer tier configuration stored in $TierConfig, and then stores the variable in the $VMConfig variable.
The last command sets the description property of the first virtual machine configuration object stored in $VMConfig, and displays the properties of the virtual machine configuration.
PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $TierConfig = Get-SCComputerTierConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> $VMConfig = Get-SCVMConfiguration -ComputerTierConfiguration $TierConfig
PS C:\> Set-SCVMConfiguration -VMConfiguration $VMConfig[0] -Description "This is the updated virtual machine configuration"
Example Example 2:. Configure the virtual machine configuration object for a machine tier to pin the host for a virtual machine.:
The first command gets the service configuration object named Service01, and then stores the object in the $ServiceConfig variable.
The second command gets the computer tier configuration object for the service configuration stored in $ServiceConfig, and then stores the object in the $TierConfig variable.
The third command gets the virtual machine configuration objects for the computer tier configuration stored in $TierConfig, and then stores the objects in the $VMConfig variable.
The last command sets the PinVMHost property to $True for the first virtual machine configuration object stored in $VMConfig. Therefore, when the service is deployed, the host for the virtual machine created with this configuration will not be changed.
PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $TierConfig = Get-SCComputerTierConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> $VMConfig = Get-SCVMConfiguration -ComputerTierConfiguration $TierConfig
PS C:\> Set-SCVMConfiguration -VMConfiguration $VMConfig[0] -PinVMHost $True
Example Example 3:. Configure the virtual machine configuration object for a service in a private cloud.:
The first command gets the service configuration object named Service01, and then stores the object in the $ServiceConfig variable.
The second command gets the computer tier configuration for the service configuration stored in $ServiceConfig, and then stores the object in the $TierConfig variable.
The third command gets the virtual machine configuration objects for the computer tier configuration stored in $TierConfig, and then stores the objects in the $VMConfig variable.
The fourth command gets the private cloud object named Production, and then stores the object in the $Cloud variable.
The last command updates the description for the second virtual machine configuration object stored in $VMConfig for the private cloud stored in $Cloud.
PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $TierConfig = Get-SCComputerTierConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> $VMConfig = Get-SCVMConfiguration -ComputerTierConfiguration $TierConfig
PS C:\> $Cloud = Get-SCCloud -Name "Production"
PS C:\> Set-SCVMConfiguration -VMConfiguration $VMConfig[1] -Cloud $Cloud -Description "This is the new virtual machine configuration"