// or more contributor license agreements.  See the NOTICE file

// distributed with this work for additional information

// regarding copyright ownership.  The ASF licenses this file

// to you under the Apache License, Version 2.0 (the

// "License"); you may not use this file except in compliance

// with the License.  You may obtain a copy of the License at

//

//   http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing,

// software distributed under the License is distributed on an

// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

// KIND, either express or implied.  See the License for the

// specific language governing permissions and limitations

// under the License.

    private static final Logger s_logger = Logger.getLogger(HypervisorHostHelper.class);

    private static final int DEFAULT_LOCK_TIMEOUT_SECONDS = 600;

    private static final String s_policyNamePrefix = "cloud.policy.";

    // make vmware-base loosely coupled with cloud-specific stuff, duplicate VLAN.UNTAGGED constant here

    private static final String UNTAGGED_VLAN_NAME = "untagged";

    public static VirtualMachineMO findVmFromObjectContent(VmwareContext context,

            ObjectContent[] ocs, String name, String instanceNameCustomField) {

        if(ocs != null && ocs.length > 0) {

            for(ObjectContent oc : ocs) {

                String vmNameInvCenter = null;

                String vmInternalCSName = null;

                List<DynamicProperty> objProps = oc.getPropSet();

                if(objProps != null) {

                    for(DynamicProperty objProp : objProps) {

                        if(objProp.getName().equals("name")) {

                            vmNameInvCenter = (String)objProp.getVal();

                        } else if(objProp.getName().contains(instanceNameCustomField)) {

                            if(objProp.getVal() != null)

                                vmInternalCSName = ((CustomFieldStringValue)objProp.getVal()).getValue();

                        }

                        if ( (vmNameInvCenter != null && name.equalsIgnoreCase(vmNameInvCenter))

                                || (vmInternalCSName != null && name.equalsIgnoreCase(vmInternalCSName)) ) {

                            VirtualMachineMO vmMo = new VirtualMachineMO(context, oc.getObj());

                            return vmMo;

                        }

                    }

                }

            }

        }

        return null;

    }

    public static ManagedObjectReference findDatastoreWithBackwardsCompatibility(VmwareHypervisorHost hyperHost, String uuidName) throws Exception {

        ManagedObjectReference morDs = hyperHost.findDatastore(uuidName.replace("-", ""));

        if(morDs == null)

            morDs = hyperHost.findDatastore(uuidName);

        return morDs;

    }

    public static DatastoreMO getHyperHostDatastoreMO(VmwareHypervisorHost hyperHost, String datastoreName) throws Exception {

        ObjectContent[] ocs = hyperHost.getDatastorePropertiesOnHyperHost(new String[] { "name"} );

        if(ocs != null && ocs.length > 0) {

            for(ObjectContent oc : ocs) {

                List<DynamicProperty> objProps = oc.getPropSet();

                if(objProps != null) {

                    for(DynamicProperty objProp : objProps) {

                        if(objProp.getVal().toString().equals(datastoreName))

                            return new DatastoreMO(hyperHost.getContext(), oc.getObj());

                    }

                }

            }

        }

        return null;

    }

    public static String getPublicNetworkNamePrefix(String vlanId) {

        if (UNTAGGED_VLAN_NAME.equalsIgnoreCase(vlanId)) {

            return "cloud.public.untagged";

        } else {

            return "cloud.public." + vlanId;

        }

    }

    public static String composeCloudNetworkName(String prefix, String vlanId, String svlanId, Integer networkRateMbps, String vSwitchName) {

        StringBuffer sb = new StringBuffer(prefix);

        if(vlanId == null || UNTAGGED_VLAN_NAME.equalsIgnoreCase(vlanId)) {

            sb.append(".untagged");

        } else {

            sb.append(".").append(vlanId);

            if (svlanId != null) {

                sb.append(".").append("s" + svlanId);

            }

        }

        if(networkRateMbps != null && networkRateMbps.intValue() > 0)

            sb.append(".").append(String.valueOf(networkRateMbps));

        else

            sb.append(".0");

        sb.append(".").append(VersioningContants.PORTGROUP_NAMING_VERSION);

        sb.append("-").append(vSwitchName);

        return sb.toString();

    }

    public static Map<String, String> getValidatedVsmCredentials(VmwareContext context) throws Exception {

        Map<String, String> vsmCredentials = context.getStockObject("vsmcredentials");

        String msg;

        if (vsmCredentials == null || vsmCredentials.size() != 3) {

            msg = "Failed to retrieve required credentials of Nexus VSM from database.";

            s_logger.error(msg);

            throw new Exception(msg);

        }

        String vsmIp = vsmCredentials.containsKey("vsmip") ? vsmCredentials.get("vsmip") : null;

        String vsmUserName = vsmCredentials.containsKey("vsmusername") ? vsmCredentials.get("vsmusername") : null;

        String vsmPassword = vsmCredentials.containsKey("vsmpassword") ? vsmCredentials.get("vsmpassword") : null;

        if (vsmIp == null || vsmIp.isEmpty() || vsmUserName == null || vsmUserName.isEmpty() || vsmPassword == null

                || vsmPassword.isEmpty()) {

            msg = "Detected invalid credentials for Nexus 1000v.";

            s_logger.error(msg);

            throw new Exception(msg);

        }

        return vsmCredentials;

    }

    public static void createPortProfile(VmwareContext context, String ethPortProfileName, String networkName,

            Integer vlanId, Integer networkRateMbps, long peakBandwidth, long burstSize,

            String gateway, boolean configureVServiceInNexus) throws Exception {

        Map<String, String> vsmCredentials = getValidatedVsmCredentials(context);

        String vsmIp = vsmCredentials.get("vsmip");

        String vsmUserName = vsmCredentials.get("vsmusername");

        String vsmPassword = vsmCredentials.get("vsmpassword");

        String msg;

        NetconfHelper netconfClient;

        try {

            s_logger.info("Connecting to Nexus 1000v: " + vsmIp);

            netconfClient = new NetconfHelper(vsmIp, vsmUserName, vsmPassword);

            s_logger.info("Successfully connected to Nexus 1000v : " + vsmIp);

        } catch (CloudRuntimeException e) {

            msg = "Failed to connect to Nexus 1000v " + vsmIp + " with credentials of user " + vsmUserName

                    + ". Exception: " + e.toString();

            s_logger.error(msg);

            throw new CloudRuntimeException(msg);

        }

        String policyName = s_policyNamePrefix;

        int averageBandwidth = 0;

        if (networkRateMbps != null) {

            averageBandwidth = networkRateMbps.intValue();

            policyName += averageBandwidth;

        }

        try {

            // TODO(sateesh): Change the type of peakBandwidth & burstRate in

            // PolicyMap to long.

            if (averageBandwidth > 0) {

                s_logger.debug("Adding policy map " + policyName);

                netconfClient.addPolicyMap(policyName, averageBandwidth, (int) peakBandwidth, (int) burstSize);

            }

        } catch (CloudRuntimeException e) {

            msg = "Failed to add policy map of " + policyName + " with parameters " + "committed rate = "

                    + averageBandwidth + "peak bandwidth = " + peakBandwidth + "burst size = " + burstSize

                    + ". Exception: " + e.toString();

            s_logger.error(msg);

            if (netconfClient != null) {

                netconfClient.disconnect();

                s_logger.debug("Disconnected Nexus 1000v session.");

            }

            throw new CloudRuntimeException(msg);

        }

        List<Pair<OperationType, String>> params = new ArrayList<Pair<OperationType, String>>();

        if (vlanId != null) {

            // No need to update ethernet port profile for untagged vlans

            params.add(new Pair<OperationType, String>(OperationType.addvlanid, vlanId.toString()));

            try {

                s_logger.info("Updating Ethernet port profile " + ethPortProfileName + " with VLAN " + vlanId);

                netconfClient.updatePortProfile(ethPortProfileName, SwitchPortMode.trunk, params);

                s_logger.info("Added " + vlanId + " to Ethernet port profile " + ethPortProfileName);

            } catch (CloudRuntimeException e) {

                msg = "Failed to update Ethernet port profile " + ethPortProfileName + " with VLAN " + vlanId

                        + ". Exception: " + e.toString();

                s_logger.error(msg);

                if(netconfClient != null) {

                    netconfClient.disconnect();

                    s_logger.debug("Disconnected Nexus 1000v session.");

                }

                throw new CloudRuntimeException(msg);

            }

        }

        try {

            if (vlanId == null) {

                s_logger.info("Adding port profile configured over untagged VLAN.");

                netconfClient.addPortProfile(networkName, PortProfileType.vethernet, BindingType.portbindingstatic, SwitchPortMode.access, 0);

            } else {

                if (!configureVServiceInNexus) {

                    s_logger.info("Adding port profile configured over VLAN : " + vlanId.toString());

                    netconfClient.addPortProfile(networkName, PortProfileType.vethernet, BindingType.portbindingstatic, SwitchPortMode.access, vlanId.intValue());

                } else {

                    String tenant = "vlan-" + vlanId.intValue();

                    String vdc = "root/" + tenant + "/VDC-" + tenant;

                    String esp = "ESP-" + tenant;

                    s_logger.info("Adding vservice node in Nexus VSM for VLAN : " + vlanId.toString());

                    netconfClient.addVServiceNode(vlanId.toString(), gateway);

                    s_logger.info("Adding port profile with vservice details configured over VLAN : " + vlanId.toString());

                    netconfClient.addPortProfile(networkName, PortProfileType.vethernet, BindingType.portbindingstatic, SwitchPortMode.access, vlanId.intValue(), vdc, esp);

                }

            }

        } catch (CloudRuntimeException e) {

            msg = "Failed to add vEthernet port profile " + networkName + "." + ". Exception: " + e.toString();

            s_logger.error(msg);

            if(netconfClient != null) {

                netconfClient.disconnect();

                s_logger.debug("Disconnected Nexus 1000v session.");

            }

            throw new CloudRuntimeException(msg);

        }

        try {

            if (averageBandwidth > 0) {

                s_logger.info("Associating policy map " + policyName + " with port profile " + networkName + ".");

                netconfClient.attachServicePolicy(policyName, networkName);

            }

        }

        catch(CloudRuntimeException e) {

            msg = "Failed to associate policy map " + policyName + " with port profile " + networkName

                    + ". Exception: " + e.toString();

            s_logger.error(msg);

            throw new CloudRuntimeException(msg);

        } finally {

            if (netconfClient != null) {

                netconfClient.disconnect();

                s_logger.debug("Disconnected Nexus 1000v session.");

            }

        }

    }

    public static void updatePortProfile(VmwareContext context, String ethPortProfileName, String vethPortProfileName,

            Integer vlanId, Integer networkRateMbps, long peakBandwidth, long burstRate) throws Exception {

        NetconfHelper netconfClient = null;

        Map<String, String> vsmCredentials = getValidatedVsmCredentials(context);

        String vsmIp = vsmCredentials.get("vsmip");

        String vsmUserName = vsmCredentials.get("vsmusername");

        String vsmPassword = vsmCredentials.get("vsmpassword");

        String msg;

        try {

            netconfClient = new NetconfHelper(vsmIp, vsmUserName, vsmPassword);

        } catch (CloudRuntimeException e) {

            msg = "Failed to connect to Nexus 1000v " + vsmIp + " with credentials of user " + vsmUserName

                    + ". Exception: " + e.toString();

            s_logger.error(msg);

            throw new CloudRuntimeException(msg);

        }

        PortProfile portProfile = netconfClient.getPortProfileByName(vethPortProfileName);

        int averageBandwidth = 0;

        String policyName = s_policyNamePrefix;

        if (networkRateMbps != null) {

            averageBandwidth = networkRateMbps.intValue();

            policyName += averageBandwidth;

        }

        if (averageBandwidth > 0) {

            PolicyMap policyMap = netconfClient.getPolicyMapByName(portProfile.inputPolicyMap);

            if (policyMap.committedRate == averageBandwidth && policyMap.peakRate == peakBandwidth

                    && policyMap.burstRate == burstRate) {

                s_logger.debug("Detected that policy map is already applied to port profile " + vethPortProfileName);

                if (netconfClient != null) {

                    netconfClient.disconnect();

                    s_logger.debug("Disconnected Nexus 1000v session.");

                }

                return;

            } else {

                try {

                    // TODO(sateesh): Change the type of peakBandwidth &

                    // burstRate in PolicyMap to long.

                    s_logger.info("Adding policy map " + policyName);

                    netconfClient.addPolicyMap(policyName, averageBandwidth, (int) peakBandwidth, (int) burstRate);

                } catch (CloudRuntimeException e) {

                    msg = "Failed to add policy map of " + policyName + " with parameters " + "committed rate = "

                            + averageBandwidth + "peak bandwidth = " + peakBandwidth + "burst size = " + burstRate

                            + ". Exception: " + e.toString();

                    s_logger.error(msg);

                    if (netconfClient != null) {

                        netconfClient.disconnect();

                        s_logger.debug("Disconnected Nexus 1000v session.");

                    }

                    throw new CloudRuntimeException(msg);

                }

                try {

                    s_logger.info("Associating policy map " + policyName + " with port profile " + vethPortProfileName

                            + ".");

                    netconfClient.attachServicePolicy(policyName, vethPortProfileName);

                } catch (CloudRuntimeException e) {

                    msg = "Failed to associate policy map " + policyName + " with port profile " + vethPortProfileName

                            + ". Exception: " + e.toString();

                    s_logger.error(msg);

                    if (netconfClient != null) {

                        netconfClient.disconnect();

                        s_logger.debug("Disconnected Nexus 1000v session.");

                    }

                    throw new CloudRuntimeException(msg);

                }

            }

        }

        if (vlanId == null) {

            s_logger.info("Skipping update operation over ethernet port profile " + ethPortProfileName

                    + " for untagged VLAN.");

            if (netconfClient != null) {

                netconfClient.disconnect();

                s_logger.debug("Disconnected Nexus 1000v session.");

            }

            return;

        }

        String currentVlan = portProfile.vlan;

        String newVlan = Integer.toString(vlanId.intValue());

        if (currentVlan.equalsIgnoreCase(newVlan)) {

            if (netconfClient != null) {

                netconfClient.disconnect();

                s_logger.debug("Disconnected Nexus 1000v session.");

            }

            return;

        }

        List<Pair<OperationType, String>> params = new ArrayList<Pair<OperationType, String>>();

        params.add(new Pair<OperationType, String>(OperationType.addvlanid, newVlan));

        try {

            s_logger.info("Updating vEthernet port profile with VLAN " + vlanId.toString());

            netconfClient.updatePortProfile(ethPortProfileName, SwitchPortMode.trunk, params);

        } catch (CloudRuntimeException e) {

            msg = "Failed to update ethernet port profile " + ethPortProfileName + " with parameters "

                    + params.toString() + ". Exception: " + e.toString();

            s_logger.error(msg);

            if (netconfClient != null) {

                netconfClient.disconnect();

                s_logger.debug("Disconnected Nexus 1000v session.");

            }

            throw new CloudRuntimeException(msg);

        }

        try {

            netconfClient.updatePortProfile(vethPortProfileName, SwitchPortMode.access, params);

        } catch (CloudRuntimeException e) {

            msg = "Failed to update vEthernet port profile " + vethPortProfileName + " with parameters "

                    + params.toString() + ". Exception: " + e.toString();

            s_logger.error(msg);

            if (netconfClient != null) {

                netconfClient.disconnect();

                s_logger.debug("Disconnected Nexus 1000v session.");

            }

            throw new CloudRuntimeException(msg);

        }

    }

    /**

     * @param ethPortProfileName

     * @param namePrefix

     * @param hostMo

     * @param vlanId

     * @param networkRateMbps

     * @param networkRateMulticastMbps

     * @param timeOutMs

     * @param vSwitchType

     * @param numPorts

     * @return

     * @throws Exception

     */

    public static Pair<ManagedObjectReference, String> prepareNetwork(String physicalNetwork, String namePrefix,

            HostMO hostMo, String vlanId, String secondaryvlanId, Integer networkRateMbps, Integer networkRateMulticastMbps, long timeOutMs,

            VirtualSwitchType vSwitchType, int numPorts, String gateway, boolean configureVServiceInNexus, BroadcastDomainType broadcastDomainType) throws Exception {

        ManagedObjectReference morNetwork = null;

        VmwareContext context = hostMo.getContext();

        ManagedObjectReference dcMor = hostMo.getHyperHostDatacenter();

        DatacenterMO dataCenterMo = new DatacenterMO(context, dcMor);

        DistributedVirtualSwitchMO dvSwitchMo = null;

        ManagedObjectReference morEthernetPortProfile = null;

        String ethPortProfileName = null;

        ManagedObjectReference morDvSwitch = null;

        String dvSwitchName = null;

        boolean bWaitPortGroupReady = false;

        boolean createGCTag = false;

        String vcApiVersion;

        String minVcApiVersionSupportingAutoExpand;

        boolean autoExpandSupported;

        String networkName;

        Integer vid = null;

        Integer spvlanid = null;  // secondary pvlan id

        /** This is the list of BroadcastDomainTypes we can actually

         * prepare networks for in this function.

         */

        BroadcastDomainType[] supportedBroadcastTypes =

                new BroadcastDomainType[] { BroadcastDomainType.Lswitch,

                BroadcastDomainType.LinkLocal,

                BroadcastDomainType.Native,

                BroadcastDomainType.Pvlan,

                BroadcastDomainType.Storage,

                BroadcastDomainType.UnDecided,

                BroadcastDomainType.Vlan };

        if (!Arrays.asList(supportedBroadcastTypes).contains(broadcastDomainType)) {

            throw new InvalidParameterException("BroadcastDomainType " + broadcastDomainType +

                    " it not supported on a VMWare hypervisor at this time.");

        }

        if (broadcastDomainType == BroadcastDomainType.Lswitch) {

            if (vSwitchType == VirtualSwitchType.NexusDistributedVirtualSwitch) {

                throw new InvalidParameterException("Nexus Distributed Virtualswitch is not supported with BroadcastDomainType " +

                        broadcastDomainType);

            }

            /**

             * Nicira NVP requires all vms to be connected to a single port-group.

             * A unique vlan needs to be set per port. This vlan is specific to

             * this implementation and has no reference to other vlans in CS

             */

            networkName = "br-int"; // FIXME Should be set via a configuration item in CS

            // No doubt about this, depending on vid=null to avoid lots of code below

            vid = null;

        } else {

            networkName = composeCloudNetworkName(namePrefix, vlanId, secondaryvlanId, networkRateMbps, physicalNetwork);

            if(vlanId != null && !UNTAGGED_VLAN_NAME.equalsIgnoreCase(vlanId)) {

                createGCTag = true;

                vid = Integer.parseInt(BroadcastDomainType.getValue(vlanId));

            }

            if (secondaryvlanId != null) {

                spvlanid = Integer.parseInt(BroadcastDomainType.getValue(secondaryvlanId));

            }

        }

        if (vSwitchType == VirtualSwitchType.VMwareDistributedVirtualSwitch) {

            DVSTrafficShapingPolicy shapingPolicy;

            DVSSecurityPolicy secPolicy;

            vcApiVersion = getVcenterApiVersion(context);

            minVcApiVersionSupportingAutoExpand = "5.0";

            autoExpandSupported = isFeatureSupportedInVcenterApiVersion(vcApiVersion, minVcApiVersionSupportingAutoExpand);

            dvSwitchName = physicalNetwork;

            // TODO(sateesh): Remove this after ensuring proper default value for vSwitchName throughout traffic types

            // and switch types.

            if (dvSwitchName == null) {

                s_logger.warn("Detected null dvSwitch. Defaulting to dvSwitch0");

                dvSwitchName = "dvSwitch0";

            }

            morDvSwitch = dataCenterMo.getDvSwitchMor(dvSwitchName);

            if (morDvSwitch == null) {

                String msg = "Unable to find distributed vSwitch " + dvSwitchName;

                s_logger.error(msg);

                throw new Exception(msg);

            } else {

                s_logger.debug("Found distributed vSwitch " + dvSwitchName);

            }

            if (broadcastDomainType == BroadcastDomainType.Lswitch) {

                if (!dataCenterMo.hasDvPortGroup(networkName)) {

                    throw new InvalidParameterException("NVP integration port-group " + networkName + " does not exist on the DVS " + dvSwitchName);

                }

                bWaitPortGroupReady = false;

            } else {

                dvSwitchMo = new DistributedVirtualSwitchMO(context, morDvSwitch);

                shapingPolicy = getDVSShapingPolicy(networkRateMbps);

                secPolicy = createDVSSecurityPolicy();

                // First, if both vlan id and pvlan id are provided, we need to

                // reconfigure the DVSwitch to have a tuple <vlan id, pvlan id> of

                // type isolated.

                if (vid != null && spvlanid != null) {

                    setupPVlanPair(dvSwitchMo, morDvSwitch, vid, spvlanid);

                }

                // Next, create the port group. For this, we need to create a VLAN spec.

                createPortGroup(physicalNetwork, networkName, vid, spvlanid, dataCenterMo, shapingPolicy, secPolicy, dvSwitchMo, numPorts, autoExpandSupported);

                bWaitPortGroupReady = true;

            }

        } else if (vSwitchType == VirtualSwitchType.NexusDistributedVirtualSwitch) {

            ethPortProfileName = physicalNetwork;

            // TODO(sateesh): Remove this after ensuring proper default value for vSwitchName throughout traffic types

            // and switch types.

            if (ethPortProfileName == null) {

                s_logger.warn("Detected null ethrenet port profile. Defaulting to epp0.");

                ethPortProfileName = "epp0";

            }

            morEthernetPortProfile = dataCenterMo.getDvPortGroupMor(ethPortProfileName);

            if (morEthernetPortProfile == null) {

                String msg = "Unable to find Ethernet port profile " + ethPortProfileName;

                s_logger.error(msg);

                throw new Exception(msg);

            } else {

                s_logger.info("Found Ethernet port profile " + ethPortProfileName);

            }

            long averageBandwidth = 0L;

            if (networkRateMbps != null && networkRateMbps.intValue() > 0) {

                averageBandwidth = networkRateMbps.intValue() * 1024L * 1024L;

            }

            // We chose 50% higher allocation than average bandwidth.

            // TODO(sateesh): Optionally let user specify the peak coefficient

            long peakBandwidth = (long) (averageBandwidth * 1.5);

            // TODO(sateesh): Optionally let user specify the burst coefficient

            long burstSize = 5 * averageBandwidth / 8;

            if (!dataCenterMo.hasDvPortGroup(networkName)) {

                s_logger.info("Port profile " + networkName + " not found.");

                createPortProfile(context, physicalNetwork, networkName, vid, networkRateMbps, peakBandwidth, burstSize, gateway, configureVServiceInNexus);

                bWaitPortGroupReady = true;

            } else {

                s_logger.info("Port profile " + networkName + " found.");

                updatePortProfile(context, physicalNetwork, networkName, vid, networkRateMbps, peakBandwidth, burstSize);

            }

        }

        // Wait for dvPortGroup on vCenter

        if (bWaitPortGroupReady)

            morNetwork = waitForDvPortGroupReady(dataCenterMo, networkName, timeOutMs);

        else

            morNetwork = dataCenterMo.getDvPortGroupMor(networkName);

        if (morNetwork == null) {

            String msg = "Failed to create guest network " + networkName;

            s_logger.error(msg);

            throw new Exception(msg);

        }

        if(createGCTag) {

            NetworkMO networkMo = new NetworkMO(hostMo.getContext(), morNetwork);

            networkMo.setCustomFieldValue(CustomFieldConstants.CLOUD_GC_DVP, "true");

            s_logger.debug("Added custom field : " + CustomFieldConstants.CLOUD_GC_DVP);

        }

        return new Pair<ManagedObjectReference, String>(morNetwork, networkName);

    }

    public static String getVcenterApiVersion(VmwareContext serviceContext) throws Exception {

        String vcApiVersion = null;

        if (serviceContext != null) {

            vcApiVersion = serviceContext.getServiceContent().getAbout().getApiVersion();

        }

        return vcApiVersion;

    }

    public static boolean isFeatureSupportedInVcenterApiVersion(String vCenterApiVersion, String minVcenterApiVersionForFeature) {

        return vCenterApiVersion.compareTo(minVcenterApiVersionForFeature) >= 0 ? true : false;

    }

    private static void setupPVlanPair(DistributedVirtualSwitchMO dvSwitchMo, ManagedObjectReference morDvSwitch,

            Integer vid, Integer spvlanid) throws Exception {

        Map<Integer, HypervisorHostHelper.PvlanType> vlanmap = dvSwitchMo.retrieveVlanPvlan(vid, spvlanid, morDvSwitch);

        if (!vlanmap.isEmpty()) {

            // Then either vid or pvlanid or both are already being used. Check how.

            // First the primary pvlan id.

            if (vlanmap.containsKey(vid) && !vlanmap.get(vid).equals(HypervisorHostHelper.PvlanType.promiscuous)) {

                // This VLAN ID is already setup as a non-promiscuous vlan id on the DVS. Throw an exception.

                String msg = "Specified primary PVLAN ID " + vid + " is already in use as a " + vlanmap.get(vid).toString() + " VLAN on the DVSwitch";

                s_logger.error(msg);

                throw new Exception(msg);

            }

            // Next the secondary pvlan id.

            if (spvlanid.equals(vid)) {

                if (vlanmap.containsKey(spvlanid) && !vlanmap.get(spvlanid).equals(HypervisorHostHelper.PvlanType.promiscuous)) {

                    String msg = "Specified secondary PVLAN ID " + spvlanid + " is already in use as a " + vlanmap.get(spvlanid).toString() + " VLAN in the DVSwitch";

                    s_logger.error(msg);

                    throw new Exception(msg);

                }

            } else {

                if (vlanmap.containsKey(spvlanid) && !vlanmap.get(spvlanid).equals(HypervisorHostHelper.PvlanType.isolated)) {

                    // This PVLAN ID is already setup as a non-isolated vlan id on the DVS. Throw an exception.

                    String msg = "Specified secondary PVLAN ID " + spvlanid + " is already in use as a " + vlanmap.get(spvlanid).toString() + " VLAN in the DVSwitch";

                    s_logger.error(msg);

                    throw new Exception(msg);

                }

            }

        }

        // First create a DVSconfig spec.

        VMwareDVSConfigSpec dvsSpec = new VMwareDVSConfigSpec();

        // Next, add the required primary and secondary vlan config specs to the dvs config spec.

        if (!vlanmap.containsKey(vid)) {

            VMwareDVSPvlanConfigSpec ppvlanConfigSpec = createDVPortPvlanConfigSpec(vid, vid, PvlanType.promiscuous, PvlanOperation.add);

            dvsSpec.getPvlanConfigSpec().add(ppvlanConfigSpec);

        }

        if ( !vid.equals(spvlanid) && !vlanmap.containsKey(spvlanid)) {

            VMwareDVSPvlanConfigSpec spvlanConfigSpec = createDVPortPvlanConfigSpec(vid, spvlanid, PvlanType.isolated, PvlanOperation.add);

            dvsSpec.getPvlanConfigSpec().add(spvlanConfigSpec);

        }

        if (dvsSpec.getPvlanConfigSpec().size() > 0) {

            // We have something to configure on the DVS... so send it the command.

            // When reconfiguring a vmware DVSwitch, we need to send in the configVersion in the spec.

            // Let's retrieve this switch's configVersion first.

            String dvsConfigVersion = dvSwitchMo.getDVSConfigVersion(morDvSwitch);

            dvsSpec.setConfigVersion(dvsConfigVersion);

            // Reconfigure the dvs using this spec.

            try {

                dvSwitchMo.updateVMWareDVSwitchGetTask(morDvSwitch, dvsSpec);

            } catch (AlreadyExistsFaultMsg e) {

                s_logger.info("Specified vlan id (" + vid + ") private vlan id (" + spvlanid + ") tuple already configured on VMWare DVSwitch");

                // Do nothing, good if the tuple's already configured on the dvswitch.

            } catch (Exception e) {

                // Rethrow the exception

                s_logger.error("Failed to configure vlan/pvlan tuple on VMware DVSwitch: " + vid + "/" + spvlanid + ", failure message: ", e);

                throw e;

            }

        }

    }

    private static void createPortGroup(String physicalNetwork, String networkName, Integer vid, Integer spvlanid, DatacenterMO dataCenterMo,

            DVSTrafficShapingPolicy shapingPolicy, DVSSecurityPolicy secPolicy, DistributedVirtualSwitchMO dvSwitchMo, int numPorts, boolean autoExpandSupported) throws Exception{

        VmwareDistributedVirtualSwitchVlanSpec vlanSpec = null;

        VmwareDistributedVirtualSwitchPvlanSpec pvlanSpec = null;

        VMwareDVSPortSetting dvsPortSetting = null;

        DVPortgroupConfigSpec dvPortGroupSpec;

        // Next, create the port group. For this, we need to create a VLAN spec.

        // NOTE - VmwareDistributedVirtualSwitchPvlanSpec extends VmwareDistributedVirtualSwitchVlanSpec.

        if (vid == null || spvlanid == null) {

            vlanSpec = createDVPortVlanIdSpec(vid);

            dvsPortSetting = createVmwareDVPortSettingSpec(shapingPolicy, secPolicy, vlanSpec);

        } else if (spvlanid != null) {

            // Create a pvlan spec. The pvlan spec is different from the pvlan config spec

            // that we created earlier. The pvlan config spec is used to configure the switch

            // with a <primary vlanId, secondary vlanId> tuple. The pvlan spec is used

            // to configure a port group (i.e., a network) with a secondary vlan id. We don't

            // need to mention more than the secondary vlan id because one secondary vlan id

            // can be associated with only one primary vlan id. Give vCenter the secondary vlan id,

            // and it will find out the associated primary vlan id and do the rest of the

            // port group configuration.

            pvlanSpec = createDVPortPvlanIdSpec(spvlanid);

            dvsPortSetting = createVmwareDVPortSettingSpec(shapingPolicy, secPolicy, pvlanSpec);

        }

        dvPortGroupSpec = createDvPortGroupSpec(networkName, dvsPortSetting, numPorts, autoExpandSupported);

        if (!dataCenterMo.hasDvPortGroup(networkName)) {

            s_logger.info("Distributed Virtual Port group " + networkName + " not found.");

            // TODO(sateesh): Handle Exceptions

            try {

                dvSwitchMo.createDVPortGroup(dvPortGroupSpec);

            } catch (Exception e) {

                String msg = "Failed to create distributed virtual port group " + networkName + " on dvSwitch " + physicalNetwork;

                throw new Exception(msg);

            }

        } else {

            s_logger.info("Found Distributed Virtual Port group " + networkName);

            // TODO(sateesh): Handle Exceptions

            DVPortgroupConfigInfo dvPortgroupInfo = dataCenterMo.getDvPortGroupSpec(networkName);

            if (!isSpecMatch(dvPortgroupInfo, vid, shapingPolicy)) {

                s_logger.info("Updating Distributed Virtual Port group " + networkName);

                dvPortGroupSpec.setDefaultPortConfig(dvsPortSetting);

                dvPortGroupSpec.setConfigVersion(dvPortgroupInfo.getConfigVersion());

                ManagedObjectReference morDvPortGroup = dataCenterMo.getDvPortGroupMor(networkName);

                try {

                    dvSwitchMo.updateDvPortGroup(morDvPortGroup, dvPortGroupSpec);

                } catch (Exception e) {

                    String msg = "Failed to update distributed virtual port group " + networkName + " on dvSwitch " + physicalNetwork;

                    throw new Exception(msg);

                }

            }

        }

    }

    public static ManagedObjectReference waitForDvPortGroupReady(

            DatacenterMO dataCenterMo, String dvPortGroupName, long timeOutMs) throws Exception {

        ManagedObjectReference morDvPortGroup = null;

        // if DvPortGroup is just created, we may fail to retrieve it, we

        // need to retry

        long startTick = System.currentTimeMillis();

        while (System.currentTimeMillis() - startTick <= timeOutMs) {

            morDvPortGroup = dataCenterMo.getDvPortGroupMor(dvPortGroupName);

            if (morDvPortGroup != null) {

                break;

            }

            s_logger.info("Waiting for dvPortGroup " + dvPortGroupName + " to be ready");

            Thread.sleep(1000);

        }

        return morDvPortGroup;

    }

    public static boolean isSpecMatch(DVPortgroupConfigInfo configInfo, Integer vid, DVSTrafficShapingPolicy shapingPolicy) {

        DVSTrafficShapingPolicy currentTrafficShapingPolicy;

        currentTrafficShapingPolicy = configInfo.getDefaultPortConfig().getInShapingPolicy();

        assert(currentTrafficShapingPolicy != null);

        LongPolicy averageBandwidth = currentTrafficShapingPolicy.getAverageBandwidth();

        LongPolicy burstSize = currentTrafficShapingPolicy.getBurstSize();

        LongPolicy peakBandwidth = currentTrafficShapingPolicy.getPeakBandwidth();

        BoolPolicy isEnabled = currentTrafficShapingPolicy.getEnabled();

        if (!isEnabled.equals(shapingPolicy.getEnabled())) {

            return false;

        }

        if(averageBandwidth != null && !averageBandwidth.equals(shapingPolicy.getAverageBandwidth())) {

            if(s_logger.isInfoEnabled()) {

                s_logger.info("Average bandwidth setting in shaping policy doesn't match with existing setting.");

            }

            return false;

        } else if(burstSize != null && !burstSize.equals(shapingPolicy.getBurstSize())) {

            if(s_logger.isInfoEnabled()) {

                s_logger.info("Burst size setting in shaping policy doesn't match with existing setting.");

            }

            return false;

        } else if(peakBandwidth != null && !peakBandwidth.equals(shapingPolicy.getPeakBandwidth())) {

            if(s_logger.isInfoEnabled()) {

                s_logger.info("Peak bandwidth setting in shaping policy doesn't match with existing setting.");

            }

            return false;

        }

        return true;

    }

    public static DVPortgroupConfigSpec createDvPortGroupSpec(String dvPortGroupName, DVPortSetting portSetting, int numPorts, boolean autoExpandSupported) {

        DVPortgroupConfigSpec spec = new DVPortgroupConfigSpec();

        spec.setName(dvPortGroupName);

        spec.setDefaultPortConfig(portSetting);

        spec.setPortNameFormat("vnic<portIndex>");

        spec.setType("earlyBinding");

        spec.setNumPorts(numPorts);

        spec.setAutoExpand(autoExpandSupported);

        return spec;

    }

    public static VMwareDVSPortSetting createVmwareDVPortSettingSpec(DVSTrafficShapingPolicy shapingPolicy, DVSSecurityPolicy secPolicy, VmwareDistributedVirtualSwitchVlanSpec vlanSpec) {

        VMwareDVSPortSetting dvsPortSetting = new VMwareDVSPortSetting();

        dvsPortSetting.setVlan(vlanSpec);

        dvsPortSetting.setSecurityPolicy(secPolicy);

        dvsPortSetting.setInShapingPolicy(shapingPolicy);

        dvsPortSetting.setOutShapingPolicy(shapingPolicy);

        return dvsPortSetting;

    }

    public static DVSTrafficShapingPolicy getDVSShapingPolicy(Integer networkRateMbps) {

        DVSTrafficShapingPolicy shapingPolicy = new DVSTrafficShapingPolicy();

        if (networkRateMbps == null || networkRateMbps.intValue() <= 0) {

            return shapingPolicy;

        }

        shapingPolicy = new DVSTrafficShapingPolicy();

        BoolPolicy isEnabled = new BoolPolicy();

        LongPolicy averageBandwidth = new LongPolicy();

        LongPolicy peakBandwidth = new LongPolicy();

        LongPolicy burstSize = new LongPolicy();

        isEnabled.setValue(true);

        averageBandwidth.setValue(networkRateMbps.intValue() * 1024L * 1024L);

        // We chose 50% higher allocation than average bandwidth.

        // TODO(sateesh): Also let user specify the peak coefficient

        peakBandwidth.setValue((long) (averageBandwidth.getValue() * 1.5));

        // TODO(sateesh): Also let user specify the burst coefficient

        burstSize.setValue(5 * averageBandwidth.getValue() / 8);

        shapingPolicy.setEnabled(isEnabled);

        shapingPolicy.setAverageBandwidth(averageBandwidth);

        shapingPolicy.setPeakBandwidth(peakBandwidth);

        shapingPolicy.setBurstSize(burstSize);

        return shapingPolicy;

    }

    public static VmwareDistributedVirtualSwitchPvlanSpec createDVPortPvlanIdSpec(int pvlanId) {

        VmwareDistributedVirtualSwitchPvlanSpec pvlanIdSpec = new VmwareDistributedVirtualSwitchPvlanSpec();

        pvlanIdSpec.setPvlanId(pvlanId);

        return pvlanIdSpec;

    }

    public enum PvlanOperation {

        add,

        edit,

        remove

    }

    public enum PvlanType {

        promiscuous,

        isolated,

        community,  // We don't use Community

    }

    public static VMwareDVSPvlanConfigSpec createDVPortPvlanConfigSpec(int vlanId, int secondaryVlanId, PvlanType pvlantype, PvlanOperation operation) {

        VMwareDVSPvlanConfigSpec pvlanConfigSpec = new VMwareDVSPvlanConfigSpec();

        VMwareDVSPvlanMapEntry map = new VMwareDVSPvlanMapEntry();

        map.setPvlanType(pvlantype.toString());

        map.setPrimaryVlanId(vlanId);

        map.setSecondaryVlanId(secondaryVlanId);

        pvlanConfigSpec.setPvlanEntry(map);

        pvlanConfigSpec.setOperation(operation.toString());

        return pvlanConfigSpec;

    }

    public static VmwareDistributedVirtualSwitchVlanIdSpec createDVPortVlanIdSpec(Integer vlanId) {

        VmwareDistributedVirtualSwitchVlanIdSpec vlanIdSpec = new VmwareDistributedVirtualSwitchVlanIdSpec();

        vlanIdSpec.setVlanId(vlanId == null ? 0 : vlanId.intValue());

        return vlanIdSpec;

    }

    public static DVSSecurityPolicy createDVSSecurityPolicy() {

        DVSSecurityPolicy secPolicy = new DVSSecurityPolicy();

        BoolPolicy allow = new BoolPolicy();

        allow.setValue(true);

        secPolicy.setForgedTransmits(allow);

        secPolicy.setAllowPromiscuous(allow);

        secPolicy.setMacChanges(allow);

        return secPolicy;

    }

    public static Pair<ManagedObjectReference, String> prepareNetwork(String vSwitchName, String namePrefix,

            HostMO hostMo, String vlanId, Integer networkRateMbps, Integer networkRateMulticastMbps,

            long timeOutMs, boolean syncPeerHosts, BroadcastDomainType broadcastDomainType, String nicUuid) throws Exception {

        HostVirtualSwitch vSwitch;

        if (vSwitchName == null) {

            s_logger.info("Detected vswitch name as undefined. Defaulting to vSwitch0");

            vSwitchName = "vSwitch0";

        }

        vSwitch = hostMo.getHostVirtualSwitchByName(vSwitchName);

        if (vSwitch == null) {

            String msg = "Unable to find vSwitch" + vSwitchName;

            s_logger.error(msg);

            throw new Exception(msg);

        }

        boolean createGCTag = false;

        String networkName;

        Integer vid = null;

        /** This is the list of BroadcastDomainTypes we can actually

         * prepare networks for in this function.

         */

        BroadcastDomainType[] supportedBroadcastTypes =

                new BroadcastDomainType[] { BroadcastDomainType.Lswitch,

                BroadcastDomainType.LinkLocal,

                BroadcastDomainType.Native,

                BroadcastDomainType.Pvlan,

                BroadcastDomainType.Storage,

                BroadcastDomainType.UnDecided,

                BroadcastDomainType.Vlan };

        if (!Arrays.asList(supportedBroadcastTypes).contains(broadcastDomainType)) {

            throw new InvalidParameterException("BroadcastDomainType " + broadcastDomainType +

                    " it not supported on a VMWare hypervisor at this time.");

        }

        if (broadcastDomainType == BroadcastDomainType.Lswitch) {

            /**

             * Nicira NVP requires each vm to have its own port-group with a dedicated

             * vlan. We'll set the name of the pg to the uuid of the nic.

             */

            networkName = nicUuid;

            // No doubt about this, depending on vid=null to avoid lots of code below

            vid = null;

        } else {

            networkName = composeCloudNetworkName(namePrefix, vlanId, null, networkRateMbps, vSwitchName);

            if(vlanId != null && !UNTAGGED_VLAN_NAME.equalsIgnoreCase(vlanId) ) {

                createGCTag = true;

                vid = Integer.parseInt(vlanId);

            }

        }

        HostNetworkSecurityPolicy secPolicy = null;

        if (namePrefix.equalsIgnoreCase("cloud.private")) {

            secPolicy = new HostNetworkSecurityPolicy();

            secPolicy.setAllowPromiscuous(Boolean.TRUE);

            secPolicy.setForgedTransmits(Boolean.TRUE);

            secPolicy.setMacChanges(Boolean.TRUE);

        }

        HostNetworkTrafficShapingPolicy shapingPolicy = null;

        if(networkRateMbps != null && networkRateMbps.intValue() > 0) {

            shapingPolicy = new HostNetworkTrafficShapingPolicy();

            shapingPolicy.setEnabled(true);

            shapingPolicy.setAverageBandwidth(networkRateMbps.intValue()*1024L*1024L);

            //

            // TODO : people may have different opinion on how to set the following

            //

            // give 50% premium to peek

            shapingPolicy.setPeakBandwidth((long)(shapingPolicy.getAverageBandwidth()*1.5));

            // allow 5 seconds of burst transfer

            shapingPolicy.setBurstSize(5*shapingPolicy.getAverageBandwidth()/8);

        }

        boolean bWaitPortGroupReady = false;

        if (broadcastDomainType == BroadcastDomainType.Lswitch) {

            if (!hostMo.hasPortGroup(vSwitch, networkName)) {

                createNvpPortGroup(hostMo, vSwitch, networkName, shapingPolicy);

                bWaitPortGroupReady = true;

            } else {

                bWaitPortGroupReady = false;

            }

        } else {

            if (!hostMo.hasPortGroup(vSwitch, networkName)) {

                hostMo.createPortGroup(vSwitch, networkName, vid, secPolicy, shapingPolicy);

                bWaitPortGroupReady = true;

            } else {

                HostPortGroupSpec spec = hostMo.getPortGroupSpec(networkName);

                if(!isSpecMatch(spec, vid, shapingPolicy)) {

                    hostMo.updatePortGroup(vSwitch, networkName, vid, secPolicy, shapingPolicy);

                    bWaitPortGroupReady = true;

                }

            }

        }

        ManagedObjectReference morNetwork;

        if(bWaitPortGroupReady)

            morNetwork = waitForNetworkReady(hostMo, networkName, timeOutMs);

        else

            morNetwork = hostMo.getNetworkMor(networkName);

        if (morNetwork == null) {

            String msg = "Failed to create guest network " + networkName;

            s_logger.error(msg);

            throw new Exception(msg);

        }

        if(createGCTag) {

            NetworkMO networkMo = new NetworkMO(hostMo.getContext(), morNetwork);

            networkMo.setCustomFieldValue(CustomFieldConstants.CLOUD_GC, "true");

        }

        if(syncPeerHosts) {

            ManagedObjectReference morParent = hostMo.getParentMor();

            if(morParent != null && morParent.getType().equals("ClusterComputeResource")) {

                // to be conservative, lock cluster

                GlobalLock lock = GlobalLock.getInternLock("ClusterLock." + morParent.getValue());

                try {

                    if(lock.lock(DEFAULT_LOCK_TIMEOUT_SECONDS)) {

                        try {

                            List<ManagedObjectReference> hosts = (List<ManagedObjectReference>)hostMo.getContext().getVimClient().getDynamicProperty(morParent, "host");

                            if(hosts != null) {

                                for(ManagedObjectReference otherHost: hosts) {

                                    if(!otherHost.getValue().equals(hostMo.getMor().getValue())) {

                                        HostMO otherHostMo = new HostMO(hostMo.getContext(), otherHost);

                                        try {

                                            if(s_logger.isDebugEnabled())

                                                s_logger.debug("Prepare network on other host, vlan: " + vlanId + ", host: " + otherHostMo.getHostName());

                                            prepareNetwork(vSwitchName, namePrefix, otherHostMo, vlanId, networkRateMbps, networkRateMulticastMbps, timeOutMs, false, broadcastDomainType, nicUuid);

                                        } catch(Exception e) {

                                            s_logger.warn("Unable to prepare network on other host, vlan: " + vlanId + ", host: " + otherHostMo.getHostName());

                                        }

                                    }

                                }

                            }

                        } finally {

                            lock.unlock();

                        }

                    } else {

                        s_logger.warn("Unable to lock cluster to prepare guest network, vlan: " + vlanId);

                    }

                } finally {

                    lock.releaseRef();

                }

            }

        }

        s_logger.info("Network " + networkName + " is ready on vSwitch " + vSwitchName);

        return new Pair<ManagedObjectReference, String>(morNetwork, networkName);

    }

    private static boolean isSpecMatch(HostPortGroupSpec spec, Integer vlanId, HostNetworkTrafficShapingPolicy shapingPolicy) {

        // check VLAN configuration

        if(vlanId != null) {

            if(vlanId.intValue() != spec.getVlanId())

                return false;

        } else {

            if(spec.getVlanId() != 0)

                return false;

        }

        // check traffic shaping configuration

        HostNetworkTrafficShapingPolicy policyInSpec = null;

        if(spec.getPolicy() != null)

            policyInSpec = spec.getPolicy().getShapingPolicy();

        if(policyInSpec != null && shapingPolicy == null || policyInSpec == null && shapingPolicy != null)

            return false;

        if(policyInSpec == null && shapingPolicy == null)

            return true;

        // so far policyInSpec and shapingPolicy should both not be null

        if(policyInSpec.isEnabled() == null || !policyInSpec.isEnabled().booleanValue())

            return false;

        if(policyInSpec.getAverageBandwidth() == null || policyInSpec.getAverageBandwidth().longValue() != shapingPolicy.getAverageBandwidth().longValue())

            return false;

        if(policyInSpec.getPeakBandwidth() == null || policyInSpec.getPeakBandwidth().longValue() != shapingPolicy.getPeakBandwidth().longValue())

            return false;

        if(policyInSpec.getBurstSize() == null || policyInSpec.getBurstSize().longValue() != shapingPolicy.getBurstSize().longValue())

            return false;

        return true;

    }

    private static void createNvpPortGroup(HostMO hostMo, HostVirtualSwitch vSwitch, String networkName, HostNetworkTrafficShapingPolicy shapingPolicy) throws Exception {

        /**

         * No portgroup created yet for this nic

         * We need to find an unused vlan and create the pg

         * The vlan is limited to this vSwitch and the NVP vAPP,

         * so no relation to the other vlans in use in CloudStack.

         */

        String vSwitchName = vSwitch.getName();

        // Find all vlanids that we have in use

        List<Integer> usedVlans = new ArrayList<Integer>();

        for (HostPortGroup pg : hostMo.getHostNetworkInfo().getPortgroup()) {

            HostPortGroupSpec hpgs = pg.getSpec();

            if (vSwitchName.equals(hpgs.getVswitchName()))

                usedVlans.add(hpgs.getVlanId());

        }

        // Find the first free vlanid

        int nvpVlanId = 0;

        for (nvpVlanId = 1; nvpVlanId < 4095; nvpVlanId++) {

            if (! usedVlans.contains(nvpVlanId)) {

                break;

            }

        }

        if (nvpVlanId == 4095) {

            throw new InvalidParameterException("No free vlan numbers on " + vSwitchName + " to create a portgroup for nic " + networkName);

        }

        // Strict security policy

        HostNetworkSecurityPolicy secPolicy = new HostNetworkSecurityPolicy();

        secPolicy.setAllowPromiscuous(Boolean.FALSE);

        secPolicy.setForgedTransmits(Boolean.FALSE);

        secPolicy.setMacChanges(Boolean.FALSE);

        // Create a portgroup with the uuid of the nic and the vlanid found above

        hostMo.createPortGroup(vSwitch, networkName, nvpVlanId, secPolicy, shapingPolicy);

    }

    public static ManagedObjectReference waitForNetworkReady(HostMO hostMo,

            String networkName, long timeOutMs) throws Exception {

        ManagedObjectReference morNetwork = null;

        // if portGroup is just created, getNetwork may fail to retrieve it, we

        // need to retry

        long startTick = System.currentTimeMillis();

        while (System.currentTimeMillis() - startTick <= timeOutMs) {

            morNetwork = hostMo.getNetworkMor(networkName);

            if (morNetwork != null) {

                break;

            }

            s_logger.info("Waiting for network " + networkName + " to be ready");

            Thread.sleep(1000);

        }

        return morNetwork;

    }

    public static boolean createBlankVm(VmwareHypervisorHost host, String vmName, String vmInternalCSName,

            int cpuCount, int cpuSpeedMHz, int cpuReservedMHz, boolean limitCpuUse, int memoryMB, int memoryReserveMB, String guestOsIdentifier,

            ManagedObjectReference morDs, boolean snapshotDirToParent) throws Exception {

        if(s_logger.isInfoEnabled())

            s_logger.info("Create blank VM. cpuCount: " + cpuCount + ", cpuSpeed(MHz): " + cpuSpeedMHz + ", mem(Mb): " + memoryMB);

        // VM config basics

        VirtualMachineConfigSpec vmConfig = new VirtualMachineConfigSpec();

        vmConfig.setName(vmName);

        if (vmInternalCSName == null)

            vmInternalCSName = vmName;

        VmwareHelper.setBasicVmConfig(vmConfig, cpuCount, cpuSpeedMHz, cpuReservedMHz, memoryMB, memoryReserveMB, guestOsIdentifier, limitCpuUse);

        // Scsi controller

        VirtualLsiLogicController scsiController = new VirtualLsiLogicController();

        scsiController.setSharedBus(VirtualSCSISharing.NO_SHARING);

        scsiController.setBusNumber(0);

        scsiController.setKey(1);

        VirtualDeviceConfigSpec scsiControllerSpec = new VirtualDeviceConfigSpec();

        scsiControllerSpec.setDevice(scsiController);

        scsiControllerSpec.setOperation(VirtualDeviceConfigSpecOperation.ADD);

        VirtualMachineFileInfo fileInfo = new VirtualMachineFileInfo();

        DatastoreMO dsMo = new DatastoreMO(host.getContext(), morDs);

        fileInfo.setVmPathName(String.format("[%s]", dsMo.getName()));

        vmConfig.setFiles(fileInfo);

        VirtualMachineVideoCard videoCard = new VirtualMachineVideoCard();

        videoCard.setControllerKey(100);

        videoCard.setUseAutoDetect(true);

        VirtualDeviceConfigSpec videoDeviceSpec = new VirtualDeviceConfigSpec();

        videoDeviceSpec.setDevice(videoCard);

        videoDeviceSpec.setOperation(VirtualDeviceConfigSpecOperation.ADD);

        vmConfig.getDeviceChange().add(scsiControllerSpec);

        vmConfig.getDeviceChange().add(videoDeviceSpec);

        if(host.createVm(vmConfig)) {

            // Here, when attempting to find the VM, we need to use the name

            // with which we created it. This is the only such place where

            // we need to do this. At all other places, we always use the

            // VM's internal cloudstack generated name. Here, we cannot use

            // the internal name because we can set the internal name into the

            // VM's custom field CLOUD_VM_INTERNAL_NAME only after we create

            // the VM.

            VirtualMachineMO vmMo = host.findVmOnHyperHost(vmName);

            assert(vmMo != null);

            vmMo.setCustomFieldValue(CustomFieldConstants.CLOUD_VM_INTERNAL_NAME, vmInternalCSName);

            int ideControllerKey = -1;

            while(ideControllerKey < 0) {

                ideControllerKey = vmMo.tryGetIDEDeviceControllerKey();

                if(ideControllerKey >= 0)

                    break;

                s_logger.info("Waiting for IDE controller be ready in VM: " + vmInternalCSName);

                Thread.sleep(1000);

            }

            return true;

        }

        return false;

    }

    public static VirtualMachineMO createWorkerVM(VmwareHypervisorHost hyperHost,

            DatastoreMO dsMo, String vmName) throws Exception {

        // Allow worker VM to float within cluster so that we will have better chance to

        // create it successfully

        ManagedObjectReference morCluster = hyperHost.getHyperHostCluster();

        if(morCluster != null)

            hyperHost = new ClusterMO(hyperHost.getContext(), morCluster);

        VirtualMachineMO workingVM = null;

        VirtualMachineConfigSpec vmConfig = new VirtualMachineConfigSpec();

        vmConfig.setName(vmName);

        vmConfig.setMemoryMB((long) 4);

        vmConfig.setNumCPUs(1);

        vmConfig.setGuestId(VirtualMachineGuestOsIdentifier.OTHER_GUEST.value());

        VirtualMachineFileInfo fileInfo = new VirtualMachineFileInfo();

        fileInfo.setVmPathName(dsMo.getDatastoreRootPath());