com.vmware.vim25.mo.HostProfileManager 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 HostProfileManager extends ProfileManager {
    public HostProfileManager(ServerConnection sc, ManagedObjectReference mor) {
        super(sc, mor);
    }

    //SDK4.1 signature for back compatibility
    public Task applyHostConfig_Task(HostSystem host, HostConfigSpec configSpec) throws HostConfigFailed, InvalidState, RuntimeFault, RemoteException {
        return applyHostConfig_Task(host, configSpec, null);
    }

    //SDK5.0 signature
    public Task applyHostConfig_Task(HostSystem host, HostConfigSpec configSpec, ProfileDeferredPolicyOptionParameter[] userInputs) throws HostConfigFailed, InvalidState, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().applyHostConfig_Task(getMOR(), host.getMOR(), configSpec, userInputs);
        return new Task(getServerConnection(), taskMor);
    }

    /**
     * @since SDK5.0
     */
    public Task checkAnswerFileStatus_Task(HostSystem[] hosts) throws RuntimeFault, RemoteException {
        ManagedObjectReference[] hostMors = MorUtil.createMORs(hosts);
        ManagedObjectReference taskMor = getVimService().checkAnswerFileStatus_Task(getMOR(), hostMors);
        return new Task(getServerConnection(), taskMor);
    }

    //SDK4.1 signature for back compatibility
    public ApplyProfile createDefaultProfile(String profileType) throws RuntimeFault, RemoteException {
        return createDefaultProfile(profileType, null, null);
    }

    //SDK5.0 signature
    public ApplyProfile createDefaultProfile(String profileType, String profileTypeName, Profile profile) throws RuntimeFault, RemoteException {
        return getVimService().createDefaultProfile(getMOR(), profileType, profileTypeName,
            profile == null ? null : profile.getMOR());
    }

    /**
     * @since SDK5.0
     */
    public Task exportAnswerFile_Task(HostSystem host) throws RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().exportAnswerFile_Task(getMOR(), host.getMOR());
        return new Task(getServerConnection(), taskMor);
    }

    /**
     * @deprecated as of SDK5.5, use generateHostProfileTaskList_Task() instead
     */
    public HostProfileManagerConfigTaskList generateConfigTaskList(HostConfigSpec configSpec, HostSystem host) throws RuntimeFault, RemoteException {
        return getVimService().generateConfigTaskList(getMOR(), configSpec, host.getMOR());
    }

    /**
     * @since SDK5.5
     */
    public Task generateHostProfileTaskList_Task(HostConfigSpec configSpec, HostSystem host) throws RuntimeFault, RemoteException {
        ManagedObjectReference mor = getVimService().generateHostProfileTaskList_Task(getMOR(), configSpec, host.getMOR());
        return new Task(getServerConnection(), mor);
    }

    /**
     * @since SDK5.0
     */
    public AnswerFileStatusResult[] queryAnswerFileStatus(HostSystem[] hosts) throws RuntimeFault, RemoteException {
        ManagedObjectReference[] hostMors = MorUtil.createMORs(hosts);
        return getVimService().queryAnswerFileStatus(getMOR(), hostMors);
    }

    //SDK4.1 signature for back compatibility
    public ProfileMetadata[] queryHostProfileMetadata(String[] profileName) throws RuntimeFault, RemoteException {
        return getVimService().queryHostProfileMetadata(getMOR(), profileName, null);
    }

    //SDK5.0 signature
    public ProfileMetadata[] queryHostProfileMetadata(String[] profileNames, Profile profile) throws RuntimeFault, RemoteException {
        return getVimService().queryHostProfileMetadata(getMOR(), profileNames,
            profile == null ? null : profile.getMOR());
    }

    /**
     * @since SDK5.0
     */
    public ProfileProfileStructure queryProfileStructure(Profile profile) throws RuntimeFault, RemoteException {
        return getVimService().queryProfileStructure(getMOR(), profile.getMOR());
    }

    /**
     * @since SDK5.0
     */
    public AnswerFile retrieveAnswerFile(HostSystem host) throws RuntimeFault, RemoteException {
        return getVimService().retrieveAnswerFile(getMOR(), host.getMOR());
    }


    /**
     * @since SDK5.1
     */
    public AnswerFile retrieveAnswerFileForProfile(HostSystem host, HostApplyProfile applyProfile) throws RuntimeFault, RemoteException {
        return getVimService().retrieveAnswerFileForProfile(getMOR(), host == null ? null : host.getMOR(), applyProfile);
    }

    /**
     * @since SDK5.0
     */
    public Task updateAnswerFile_Task(HostSystem host, AnswerFileCreateSpec configSpec) throws AnswerFileUpdateFailed, RuntimeFault, RemoteException {
        ManagedObjectReference taskMor = getVimService().updateAnswerFile_Task(getMOR(), host.getMOR(), configSpec);
        return new Task(getServerConnection(), taskMor);
    }
}