Set-SCVMSubnet
Set-SCVMSubnet
Updates a virtual machine subnet.
Syntax
Parameter Set: Default
Set-SCVMSubnet [-VMSubnet] <VMSubnet> [-Description <String> ] [-JobVariable <String> ] [-MaxNumberOfPorts <UInt32]> ] [-Name <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PortACL <PortACL> ] [-PROTipID <Guid]> ] [-RemoveMaxNumberOfPorts] [-RemovePortACL] [-RunAsynchronously] [-SubnetVLan <SubnetVLan[]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Set-SCVMSubnet cmdlet updates the properties of a virtual machine subnet.
To get a virtual machine subnet object to update, use the Get-SCVMSubnet cmdlet.
For more information about virtual machine subnets, type Get-Help New-SCVMSubnet -detailed.
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 |
-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 |
-MaxNumberOfPorts<UInt32]>
Specifies the maximum number of ports supported by the VM subnet.
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 |
-OnBehalfOfUser<System.String>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PortACL<PortACL>
Specifies a port Access Control List (ACL) value that this cmdlet assigns to the virtual machine subnet.
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 |
-RemoveMaxNumberOfPorts
Removes the value set on the VM subnet for the maximum number of ports supported by the VM subnet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemovePortACL
Indicates that this cmdlet removes any configured port ACL from the virtual machine subnet.
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 |
-SubnetVLan<SubnetVLan[]>
Specifies one or more IP subnet and VLAN sets.
For information about creating a SubnetVLan, type Get-Help New-SCSubNetVLan.
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 |
-VMSubnet<VMSubnet>
Specifies a VM subnet object.
To obtain a VM subnet object, use the Get-SCVMSubnet cmdlet.
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.
Examples
Example 1: Change the subnet VLan for a VM subnet
The first command creates a subnet VLan object, and then stores the object in the $SubnetVLan variable.
The second command gets the virtual machine subnet object named VMSubnet01, and uses the pipeline operator to pass the object to Set-SCVMSubnet. That cmdlet updates its subnet VLan to 192.168.4.0/24.
PS C:\> $SubnetVLan = New-SCSubnetVLan -Subnet "192.168.4.0/24"
PS C:\> Get-SCVMSubnet -Name "VMSubnet01" | Set-SCVMSubnet -SubnetVLan $SubNetVLan