| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
When you use a portgroup for network access, the Server will create a port according to Config.type.
Properties
Name | Type | Description |
---|---|---|
config | DVPortgroupConfigInfo |
Configuration of the portgroup.
|
key | xsd:string |
Generated UUID of the portgroup.
|
portKeys* | xsd:string[] |
Port keys for the set of ports in the portgroup.
|
Properties inherited from Network | ||
host, name, summary, vm | ||
Properties inherited from ManagedEntity | ||
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState | ||
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
DVPortgroupRollback_Task, ReconfigureDVPortgroup_Task |
Methods inherited from Network |
DestroyNetwork |
Methods inherited from ManagedEntity |
Destroy_Task, Reload, Rename_Task |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
entityBackup
parameter, the returned
configuration specification represents the exported portgroup configuration.
If the entityBackup
matches the current portgroup
configuration, the method does not return a configuration specification.
entityBackup
is not specified, the returned configuration
specification represents a previous state of the portgroup, if available.
When you use a VMware distributed virtual switch, each time you reconfigure
the switch, the Server saves the switch configuration before applying the updates.
If the vCenter Server is restarted, the saved configuration is not preserved
and the method does not return a configuration specification.
To use the rollback method, you must have the DVPortgroup.Read privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualPortgroup used to make the method call. |
entityBackup* P | EntityBackupConfig |
The backup of Distributed Virtual PortGroup entity.
Since vSphere API 5.1 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | Returns a Task object with which to monitor the operation. If the distributed virtual portgroup configuration has changed, the Task.Info.result property contains the DVPortgroupConfigSpec object. |
Faults
Type | Description |
---|---|
DvsFault | Thrown if operation fails. |
RollbackFailure | Thrown if there is no configuration specified in entityBackup and the previous configuration does not exist either |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
To reconfigure a DistributedVirtualPortgroup, use a DVPortgroupConfigSpec to set the portgroup properties.
If you use a VmwareDistributedVirtualSwitch, you can perform the following portgroup reconfiguration:
The following privileges are required to reconfigure a portgroup.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the DistributedVirtualPortgroup used to make the method call. |
spec P | DVPortgroupConfigSpec |
Configuration data for the portgroup.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
ConcurrentAccess | |
DuplicateName | |
DvsFault | Thrown if spec is not valid. |
DvsNotAuthorized | Thrown if login-session's extension key does not match the switch's configured extensionKey. |
InvalidName | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |