Modify Switch

This Automation Manager object configures a virtual switch.

Input Parameters

Name	Type	Required	Description
Name	String	Yes	Specifies the name of the virtual switch to be configured.
Type	Selector	Yes	Converts a virtual switch from one type to another. Allowed values are Internal or Private. You can convert an internal or private virtual switch to an external virtual switch, by including either the NetAdapterInterfaceDescription or NetAdapterName parameter in the command. If you do this, the external virtual switch is configured to allow the management operating system to share access to the physical network adapter.
Default Flow Min Bandwidth Absolute	Number	No	Specifies the minimum bandwidth, in bits per second, that is allocated to a special category called “default flow.” Any traffic sent by a virtual network adapter that is connected to this virtual switch and does not have minimum bandwidth allocated is filtered into this category. Specify a value for this parameter only if the minimum bandwidth mode on this virtual switch is absolute (see the New-VMSwitch cmdlet). By default, the virtual switch allocates 10% of the total bandwidth, which depends on the physical network adapter it binds to, to this category. For example, if a virtual switch binds to a 1 GbE network adapter, this special category can use at least 100 Mbps. If the value is not a multiple of 8, the value is rounded down to the nearest number that is a multiple of 8. For example, a value input as 1234567 is converted to 1234560.
Default Flow Min Bandwidth Weight	Number	No	Specifies the minimum bandwidth, in relative weight, that is allocated to a special category called “default flow”. Any traffic sent by a virtual network adapter that is connected to this virtual switch and doesn’t have minimum bandwidth allocated is filtered into this category. Specify a value for this parameter only if the minimum bandwidth mode on this virtual switch is weight (see the New-VMSwitch cmdlet). By default, this special category has a weight of 1.
Host NIC Name	String	No	Specifies notes to be associated with the virtual switch.
Allow Management OS	Boolean	No	Specifies if the management OS can use the physical network adapter that is bound to the external virtual switch.

Output Parameters

Name	Type	Description
Result	Number	Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name	Type	Required	Example
Name	String	Yes	Guest001
Type	String	No	1
Default Flow Min Bandwidth Absolute	String	No	10000000
Default Flow Min Bandwidth Weight	Number	No	0
Host NIC Name	Number	No	NAME
Allow Management OS	Boolean	No	TRUE