Set-SCVMHostGroup
Changes the properties of a host group in VMM.
Syntax
Set-SCVMHostGroup
[-VMHostGroup] <HostGroup>
[-Name <String>]
[-Description <String>]
[-EnableUnencryptedFileTransfer <Boolean>]
[-InheritNetworkSettings <Boolean>]
[-JobGroup <Guid>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] Description
The Set-SCVMHostGroup cmdlet changes one or more properties of a host group that contains hosts managed by Virtual Machine Manager (VMM). Properties that you can change include settings for name, description, and whether network settings are inherited from parent host groups.
Examples
Example 1: Change the inherit network settings property for an existing host group
PS C:\> $VMHostGroup = Get-SCVMHostGroup -Name "VMHostGroup01"
PS C:\> Set-SCVMHostGroup -VMHostGroup $VMHostGroup -InheritNetworkSettings $FalseThe first command gets the host group named HostGroup01 and stores it in the $VMHostGroup variable.
The second command changes the value of the inherit network settings to false for the host group stored in $VMHostGroup.
Parameters
-Description
Specifies a description for the host group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableUnencryptedFileTransfer
Indicates, when set to $True, that network file transfers do not require encryption. Allowing unencrypted network file transfers can improve performance if neither the source host nor the destination host requires encryption.
Use this parameter to:
- Enable unencrypted file transfers into, or out of, the library.
- Enable unencrypted file transfers into, out of, or within a host group.
| Type: | Boolean |
| Aliases: | AllowUnencryptedTransfers |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InheritNetworkSettings
Specifies, when set to $True, that the network settings for a host group will have the same values as those specified for its parent.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobGroup
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.
| Type: | Guid |
| 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 |
-Name
Specifies the name of a VMM object.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-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 |
-VMHostGroup
Specifies a virtual machine host group object.
| Type: | HostGroup |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
HostGroup
This cmdlet returns a HostGroup object.
Notes
- Requires a VMM host group object, which can be retrieved by using the Get-SCVMHostGroup cmdlet.