5.11.24 Set traffic shaping policy for the port group
Function
This plugin sets the traffic shaping policy for a port group of the standard virtual switch (vNetwork standard switch or vSphere standard switch) in a VMware vSphere environment.
You can specify one of the following policies:
- Inheritance
The traffic shaping policy set for the standard virtual switch is applied to the port group. If the policy of the standard virtual switch is changed, the change is also applied to the port group.
- Override
A traffic shaping policy unique to the port group is set. In this case, you need to specify all the following properties:
- Average bandwidth (kbit/s) (VMware.sendAverageBandwidth property)
- Burst size (KB) (VMware.sendBurstSize property)
- Peak bandwidth (kbit/s) (VMware.sendPeakBandwidth property)
- Disable
Traffic shaping on the port group is disabled. In this case, the traffic that goes through the port group is not limited.
This plugin requires the following servers:
- vCenter server
A server on which VMware vCenter Server is installed
- ESX server
A server on which VMware vSphere ESXi is installed
- vCenter control server (execution target server)
A server on which VMware vSphere PowerCLI is installed. The plugin is transferred to and executed on this server by JP1/AO.
The following describes the average bandwidth (kbit/s) (VMware.sendAverageBandwidth property).
- Specify the average bandwidth (kbit/s) for the traffic that goes through the port group.
- You need to specify this property if you specify "override" for the traffic shaping policy (VMware.trafficShapingPolicy property). If "inheritance" or "disable" is specified, the specification of this property is ignored.
- You can specify an integer value in the range from 1 to 9007199254740991.
The following describes the burst size (KB) (VMware.sendBurstSize property).
- Specify the burst size (KB) for the traffic that goes through the port group.
- You need to specify this property if you specify "override" for the traffic shaping policy (VMware.trafficShapingPolicy property). If "inheritance" or "disable" is specified, the specification of this property is ignored.
- You can specify an integer value in the range from 1 to 9007199254740991.
The following describes the peak bandwidth (kbit/s) (VMware.sendPeakBandwidth property).
- Specify the peak bandwidth (kbit/s) for the traffic that goes through the port group.
- You need to specify this property if you specify "override" for the traffic shaping policy (VMware.trafficShapingPolicy property). If "inheritance" or "disable" is specified, the specification of this property is ignored.
- You can specify an integer value in the range from 1 to 9007199254740991.
- You cannot specify a value smaller than the average bandwidth (kbit/s) (VMware.sendAverageBandwidth property).
Use situation
This plugin can be used to set the traffic shaping policy for a port group of the standard virtual switch.
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products for the system, prerequisite products for the execution-target system, prerequisite products on the execution-target server, and the supported OSs for the prerequisite products for the execution-target server.
Prerequisite products for the system:
JP1/Automatic Operation 11-10 or later
Prerequisite products for the execution-target system:
(1) Prerequisite product for the vCenter server
- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
(2) Prerequisite product for VMware vSphere ESX to manage virtual servers
- VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
Conditions for using the prerequisite products for the execution-target system:
(1) VMware vSphere ESX must be managed by VMware vCenter Server.
(2) Conditions for settings on VMware vCenter Server
- A port group must be set up. To set up the port group on the virtual server, specify a port group on the network that uses the standard virtual switch (vNetwork standard switch or vSphere standard switch).
- The VMware-related name shown below is case sensitive in VMware, but the specified name is not case sensitive in the vSphere PowerCLI instance that is executed by this plugin.
Therefore, this plugin cannot be used in an environment in which duplicate names with different case letters are used.
- Port group name
Prerequisite products on the execution-target server:
- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release 1, 5.5 Release 2, 5.5 Release 1, 5.1 Release 2, 5.0
- VMware PowerCLI 6.5 Release1
- VMware PowerCLI 6.5.1, 6.5.4
- VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0
Supported OSs for the prerequisite products for the execution-target server:
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
- Windows Server 2019 Standard/Datacenter
Cautions
(1) Do not specify a string containing a double-quotation mark (") or single quotation mark (') for a property of this plugin.
(2) For the peak bandwidth (kbit/s) (VMware.sendPeakBandwidth property), you cannot specify a value smaller than the average bandwidth (kbit/s) (VMware.sendAverageBandwidth property). If you specify a smaller value, this plugin ends abnormally.
(3) If you specify "override" for the traffic shaping policy (VMware.trafficShapingPolicy property), you need to specify the average bandwidth (kbit/s) (VMware.sendAverageBandwidth property), burst size (KB) (VMware.sendBurstSize property), and peak bandwidth (kbit/s) (VMware.sendPeakBandwidth property). If one of these items is not specified, this plugin ends abnormally.
Execution privilege
(1) Users who connect to VMware vCenter Server must have system administrator permissions.
Version
02.11.00
Plug-in tags
Modify VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetPGTrafficShapingPolicy
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error details.) Unidentified error
41: Error (An error was detected in the component.) Property not entered (An error was detected in the component script.)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
VMware.vCenterServerName |
Host name of the vCenter server |
Specify the host name or IP address of the destination vCenter server. IPv6 addresses are not supported. |
-- |
Input |
R |
|
VMware.userName |
User name for connecting to the VMware vCenter Server |
Specify the user name for connecting to the VMware vCenter Server. |
-- |
Input |
R |
|
VMware.password |
Password for connecting to the VMware vCenter Server |
Specify the password for connecting to the VMware vCenter Server. |
-- |
Input |
R |
|
VMware.portNumber |
Port number for connecting to the VMware vCenter server |
Specify the number of the port for connecting to VMware vCenter Server (for the VMware vCenter Server Web service). |
443 |
Input |
O |
|
VMware.protocol |
Protocol for connecting to the VMware vCenter server |
Specify either HTTP or HTTPS as the protocol for connecting to VMware vCenter Server. |
https |
Input |
R |
|
VMware.vmHostName |
Host name of the ESX server |
Specify the host name of the ESX server. |
-- |
Input |
R |
|
VMware.targetPortGroup |
Port group name |
Specifies the port group name of the standard virtual switch for which you want to set the traffic shaping policy. |
-- |
Input |
R |
|
VMware.trafficShapingPolicy |
Traffic shaping policy |
For the traffic shaping policy of the standard virtual switch's port group, specify "inheritance" to inherit the existing policy, "override" to perform traffic shaping specific to the port group, or "disable" to disable traffic shaping. |
override |
Input |
R |
|
VMware.sendAverageBandwidthKb |
Average bandwidth (kbit/s) |
Specifies the average bandwidth (kbit/s) for the traffic that passes through the port group. |
-- |
Input |
O |
|
VMware.sendBurstSizeKB |
Burst size (KB) |
Specifies the burst size (in KB) for the traffic that passes through the port group. |
-- |
Input |
O |
|
VMware.sendPeakBandwidthKb |
Peak bandwidth (kbit/s) |
Specifies the peak bandwidth (kbit/s) for the traffic that passes through the port group. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |