com.vmware.vim25.mo.DistributedVirtualSwitch Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yavijava Show documentation
Java library for VMware vSphere
There is a newer version: 6.0.05
/*================================================================================
Copyright (c) 2012 Steve Jin. All Rights Reserved.
Copyright (c) 2008 VMware, Inc. All Rights Reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.

* Neither the name of VMware, Inc. nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior 
written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL VMWARE, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
================================================================================*/

package com.vmware.vim25.mo;

import com.vmware.vim25.*;
import com.vmware.vim25.mo.util.MorUtil;

import java.rmi.RemoteException;

/**
 * The managed object class corresponding to the one defined in VI SDK API reference.
 *
 * @author Steve JIN (http://www.doublecloud.org)
 * @since 4.0
 */

public class DistributedVirtualSwitch extends ManagedEntity {

    public DistributedVirtualSwitch(ServerConnection sc, ManagedObjectReference mor) {
        super(sc, mor);
    }

    public DVSCapability getCapability() {
        return (DVSCapability) getCurrentProperty("capability");
    }

    public DVSConfigInfo getConfig() {
        return (DVSConfigInfo) getCurrentProperty("config");
    }

    /**
     * @since SDK4.1
     */
    public DVSNetworkResourcePool[] getNetworkResourcePool() {
        return (DVSNetworkResourcePool[]) getCurrentProperty("networkResourcePool");
    }

    public DistributedVirtualPortgroup[] getPortgroup() {
        ManagedObjectReference[] pgMors = (ManagedObjectReference[]) getCurrentProperty("portgroup");
        if (pgMors == null) {
            return new DistributedVirtualPortgroup[]{};
        }

        DistributedVirtualPortgroup[] dvpgs = new DistributedVirtualPortgroup[pgMors.length];
        for (int i = 0; i < pgMors.length; i++) {
            dvpgs[i] = new DistributedVirtualPortgroup(getServerConnection(), pgMors[i]);
        }
        return dvpgs;
    }

    public DVSSummary getSummary() {
        return (DVSSummary) getCurrentProperty("summary");
    }

    public String getUuid() {
        return (String) getCurrentProperty("uuid");
    }

    /**
     * @since SDK5.1
     */
    public DVSRuntimeInfo getRuntime() {
        return (DVSRuntimeInfo) getCurrentProperty("runtime");
    }

    public Task addDVPortgroup_Task(DVPortgroupConfigSpec[] spec) throws DvsFault, DuplicateName, InvalidName, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().addDVPortgroup_Task(getMOR(), spec);
        return new Task(getServerConnection(), taskMor);
    }

    /**
     * @since SDK5.1
     */
    public Task createDVPortgroup_Task(DVPortgroupConfigSpec spec) throws DvsFault, DuplicateName, InvalidName, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().createDVPortgroup_Task(getMOR(), spec);
        return new Task(getServerConnection(), taskMor);
    }

    /**
     * @since SDK5.1
     */
    public Task dVSRollback_Task(EntityBackupConfig spec) throws RollbackFailure, DvsFault, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().dVSRollback_Task(getMOR(), spec);
        return new Task(getServerConnection(), taskMor);
    }

    /**
     * @since SDK5.1
     */
    public DistributedVirtualPortgroup lookupDvPortGroup(String portgroupKey) throws NotFound, RuntimeFault, RemoteException {
        ManagedObjectReference mor = getVimService().lookupDvPortGroup(getMOR(), portgroupKey);
        return new DistributedVirtualPortgroup(getServerConnection(), mor);
    }

    /**
     * @since SDK5.1
     */
    public Task updateDVSHealthCheckConfig_Task(DVSHealthCheckConfig[] healthCheckConfig) throws DvsFault, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().updateDVSHealthCheckConfig_Task(getMOR(), healthCheckConfig);
        return new Task(getServerConnection(), taskMor);
    }

    /**
     * @since SDK5.0
     * @deprecated Use {@link #dvsReconfigureVmVnicNetworkResourcePool_Task dvsReconfigureVmVnicNetworkResourcePool_Task}
     */
    public void addNetworkResourcePool(DVSNetworkResourcePoolConfigSpec[] configSpec) throws DvsFault, InvalidName, RuntimeFault, RemoteException {
        getVimService().addNetworkResourcePool(getMOR(), configSpec);
    }

    /**
     * @since SDK4.1
     */
    public void enableNetworkResourceManagement(boolean enable) throws DvsFault, RuntimeFault, RemoteException {
        getVimService().enableNetworkResourceManagement(getMOR(), enable);
    }

    public String[] fetchDVPortKeys(DistributedVirtualSwitchPortCriteria criteria) throws RuntimeFault, RemoteException {
        return getVimService().fetchDVPortKeys(getMOR(), criteria);
    }

    public DistributedVirtualPort[] fetchDVPorts(DistributedVirtualSwitchPortCriteria criteria) throws RuntimeFault, RemoteException {
        return getVimService().fetchDVPorts(getMOR(), criteria);
    }

    public Task mergeDvs_Task(DistributedVirtualSwitch dvs) throws InvalidHostState, DvsFault, NotFound, ResourceInUse, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().mergeDvs_Task(getMOR(), dvs.getMOR());
        return new Task(getServerConnection(), taskMor);
    }

    public Task moveDVPort_Task(String[] portKey, String destinationPortgroupKey) throws DvsFault, NotFound, ConcurrentAccess, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().moveDVPort_Task(getMOR(), portKey, destinationPortgroupKey);
        return new Task(getServerConnection(), taskMor);
    }

    public Task performDvsProductSpecOperation_Task(String operation, DistributedVirtualSwitchProductSpec productSpec) throws TaskInProgress, InvalidState, DvsFault, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().performDvsProductSpecOperation_Task(getMOR(), operation, productSpec);
        return new Task(getServerConnection(), taskMor);
    }

    public int[] queryUsedVlanIdInDvs() throws RuntimeFault, RemoteException {
        return getVimService().queryUsedVlanIdInDvs(getMOR());
    }

    public Task reconfigureDvs_Task(DVSConfigSpec spec) throws DvsNotAuthorized, DvsFault, ConcurrentAccess, DuplicateName, InvalidState, InvalidName, NotFound, AlreadyExists, LimitExceeded, ResourceInUse, ResourceNotAvailable, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().reconfigureDvs_Task(getMOR(), spec);
        return new Task(getServerConnection(), taskMor);
    }

    public Task rectifyDvsHost_Task(HostSystem[] hosts) throws DvsFault, NotFound, RuntimeFault, RemoteException {
        ManagedObjectReference[] mors = MorUtil.createMORs(hosts);
        ManagedObjectReference mor = getVimService().rectifyDvsHost_Task(getMOR(), mors);
        return new Task(getServerConnection(), mor);
    }

    public void refreshDVPortState(String[] portKeys) throws DvsFault, NotFound, RuntimeFault, RemoteException {
        getVimService().refreshDVPortState(getMOR(), portKeys);
    }

    /**
     * @since SDK5.0
     */
    public void removeNetworkResourcePool(String[] key) throws DvsFault, NotFound, InvalidName, ResourceInUse, RuntimeFault, RemoteException {
        getVimService().removeNetworkResourcePool(getMOR(), key);
    }

    public void updateDvsCapability(DVSCapability capability) throws RuntimeFault, RemoteException {
        getVimService().updateDvsCapability(getMOR(), capability);
    }

    /**
     * @since SDK4.1
     */
    public void updateNetworkResourcePool(DVSNetworkResourcePoolConfigSpec[] configSpec) throws DvsFault, NotFound, InvalidName, RuntimeFault, RemoteException {
        getVimService().updateNetworkResourcePool(getMOR(), configSpec);
    }

    public Task reconfigureDVPort_Task(DVPortConfigSpec[] port) throws DvsFault, NotFound, ResourceInUse, ConcurrentAccess, RuntimeFault, RemoteException {
        ManagedObjectReference mor = getVimService().reconfigureDVPort_Task(getMOR(), port);
        return new Task(getServerConnection(), mor);
    }

    /**
     * Reconfigure the Virtual NIC network resource pool configuration.
     *
     * @param configSpec The Virtual NIC network resource pool configuration specification and operation type.
     * @return Returns a {@link com.vmware.vim25.mo.Task Task} with which to monitor the operation.
     * @throws ConcurrentAccess
     * @throws ConflictingConfiguration
     * @throws DvsFault
     * @throws DvsNotAuthorized
     * @throws InvalidName
     * @throws NotFound
     * @throws NotSupported
     * @throws ResourceInUse
     * @throws RuntimeFault
     * @throws RemoteException
     * @since 6.0
     */
    public Task dvsReconfigureVmVnicNetworkResourcePool_Task(DvsVmVnicResourcePoolConfigSpec[] configSpec) throws ConcurrentAccess, ConflictingConfiguration, DvsFault, DvsNotAuthorized, InvalidName, NotFound, NotSupported, ResourceInUse, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().dvsReconfigureVmVnicNetworkResourcePool_Task(getMOR(), configSpec);
        return new Task(getServerConnection(), taskMor);
    }

}