Set-SCVMHostGroup
Set-SCVMHostGroup
Changes the properties of a host group in VMM.
Syntax
Parameter Set: Default
Set-SCVMHostGroup [-VMHostGroup] <HostGroup> [-Description <String> ] [-EnableUnencryptedFileTransfer <Boolean]> ] [-InheritNetworkSettings <Boolean]> ] [-JobGroup <Guid]> ] [-JobVariable <String> ] [-Name <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed 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.
Parameters
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-EnableUnencryptedFileTransfer<Boolean]>
Indicates whether 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.
Aliases |
AllowUnencryptedTransfers |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InheritNetworkSettings<Boolean]>
Indicates whether the network settings for a host group will have the same values as those specified for its parent.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobGroup<Guid]>
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.
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 |
-Name<String>
Specifies the name of a VMM object.
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 |
-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 |
-VMHostGroup<HostGroup>
Specifies a virtual machine host group object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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.
- HostGroup
Notes
- This cmdlet requires a VMM host group object, which can be retrieved by using the Get-SCVMHostGroup cmdlet.
Examples
Example 1: Change the inherit network settings property for an existing host group
The first command gets the host group named HostGroup01, and then 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.
PS C:\> $VMHostGroup = Get-SCVMHostGroup -Name "VMHostGroup01"
PS C:\> Set-SCVMHostGroup -VMHostGroup $VMHostGroup -InheritNetworkSettings $False