Set-SCVMNetwork

Modifies a virtual machine network.

Syntax

Set-SCVMNetwork
   [-UserRole <UserRole>]
   [-VMMServer <ServerConnection>]
   [-VMNetwork] <VMNetwork>
   [-Name <String>]
   [-Description <String>]
   [-Owner <String>]
   [-PortACL <PortACL>]
   [-RemovePortACL]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Set-SCVMNetwork cmdlet modifies the properties of a virtual machine network.

To get a virtual machine network object to update, use the Get-SCVMNetwork cmdlet.

For more information about virtual machine networks, type Get-Help New-SCVMNetwork -Detailed.

Examples

Example 1: Add a description to a virtual machine network

PS C:\> Get-SCVMNetwork -Name "VMNetwork01" | Set-SCVMNetwork -Description "The first VM network"

This command gets the virtual machine network object named VMNetwork01 by using the Get-SCVMNetwork cmdlet and then uses the pipeline operator to pass the object to Set-SCVMNetwork, which modifies the description for the virtual machine network object.

Required Parameters

-VMNetwork

Specifies a virtual machine network object.

To get a virtual machine network object, use the Get-SCVMNetwork cmdlet.

Type:VMNetwork
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-Description

Specifies a description for a virtual machine network.

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of a Virtual Machine Manager (VMM) object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Owner

Specifies the owner of a VMM object in the form of a valid domain user account.

  • Example format: -Owner "Contoso\PattiFuller"
  • Example format: -Owner "PattiFuller@Contoso"
Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-PortACL

Specifies a port access control list (ACL).

Type:PortACL
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RemovePortACL

Indicates that this operation removes the port ACL.

Type:SwitchParameter
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserRole

Specifies a user role object.

Type:UserRole
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False