Set-SCVMNetwork

Set-SCVMNetwork

Updates a virtual machine network.

Syntax

Parameter Set: Default
Set-SCVMNetwork [-VMNetwork] <VMNetwork> [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-Owner <String> ] [-PortACL <PortACL> ] [-PROTipID <Guid]> ] [-RemovePortACL] [-RunAsynchronously] [-UserRole <UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Set-SCVMNetwork cmdlet updates 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".

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

-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

-Owner<String>

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

Example format: -Owner "Contoso\PattiFul"

Example format: -Owner "PattiFul@Contoso"

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 network.

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

-RemovePortACL

Indicates that this cmdlet removes any configured port ACL from the virtual machine network.

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

-UserRole<UserRole>

Specifies a user role object.

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

-VMNetwork<VMNetwork>

Specifies a VM network object.

To get a VM network object, use the Get-SCVMNetwork 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 Example 1: Add a description to a virtual machineVM network.virtual machine

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. That cmdlet updates the description for the virtual machine network object.

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

Related topics

Get-SCVMNetwork

New-SCVMNetwork

Remove-SCVMNetwork