Host.java

// Licensed to the Apache Software Foundation (ASF) under one
// 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.
package com.cloud.host;

import com.cloud.cpu.CPU;
import com.cloud.hypervisor.Hypervisor.HypervisorType;
import com.cloud.resource.ResourceState;
import com.cloud.utils.fsm.StateObject;
import org.apache.cloudstack.api.Identity;
import org.apache.cloudstack.ha.HAResource;
import org.apache.cloudstack.kernel.Partition;

import java.util.Date;

/**
 *  Host represents one particular host server.
 */
public interface Host extends StateObject<Status>, Identity, Partition, HAResource {
    public enum Type {
        Storage(false), Routing(false), SecondaryStorage(false), SecondaryStorageCmdExecutor(false), ConsoleProxy(true), ExternalFirewall(false), ExternalLoadBalancer(
                false), ExternalVirtualSwitchSupervisor(false), PxeServer(false), BaremetalPxe(false), BaremetalDhcp(false), TrafficMonitor(false), NetScalerControlCenter(false),

        ExternalDhcp(false), SecondaryStorageVM(true), LocalSecondaryStorage(false), L2Networking(false);
        boolean _virtual;

        private Type(boolean virtual) {
            _virtual = virtual;
        }

        public boolean isVirtual() {
            return _virtual;
        }

        public static String[] toStrings(Host.Type... types) {
            String[] strs = new String[types.length];
            for (int i = 0; i < types.length; i++) {
                strs[i] = types[i].toString();
            }
            return strs;
        }
    }

    String HOST_UEFI_ENABLE = "host.uefi.enable";
    String HOST_KVM_DISK_ONLY_VM_SNAPSHOT_NVRAM = "host.kvm.diskonlyvmsnapshot.nvram";
    String HOST_VOLUME_ENCRYPTION = "host.volume.encryption";
    String HOST_RBD_VOLUME_ENCRYPTION = "host.volume.encryption.rbd";
    String HOST_INSTANCE_CONVERSION = "host.instance.conversion";
    String HOST_VDDK_SUPPORT = "host.vddk.support";
    String HOST_VDDK_LIB_DIR = "vddk.lib.dir";
    String HOST_VDDK_VERSION = "host.vddk.version";
    String HOST_VDDK_BLOCKCOPY_SUPPORT = "host.vddk.blockcopy.support";
    String HOST_VDDK_BLOCKCOPY_INPLACE_FINALIZATION_SUPPORT = "host.vddk.blockcopy.inplace.finalization.support";
    String HOST_VDDK_BLOCKCOPY_RBD_SUPPORT = "host.vddk.blockcopy.rbd.support";
    String HOST_QEMU_IMG_VERSION = "host.qemu.img.version";
    String HOST_QEMU_NBD_VERSION = "host.qemu.nbd.version";
    String HOST_QEMU_IO_VERSION = "host.qemu.io.version";
    String HOST_OVFTOOL_VERSION = "host.ovftool.version";
    String HOST_VIRTV2V_VERSION = "host.virtv2v.version";
    String HOST_VIRTV2V_INPLACE_VERSION = "host.virtv2v.inplace.version";
    String HOST_VDDK_RBD_DIRECT_IMPORT_SUPPORT = "host.vddk.rbd.direct.import.support";
    String HOST_VIRTV2V_INPLACE_SUPPORT = "host.virtv2v.inplace.support";
    String HOST_QEMU_RBD_SUPPORT = "host.qemu.rbd.support";
    String HOST_SSH_PORT = "host.ssh.port";
    String HOST_CDROM_MAX_COUNT = "host.cdrom.max.count";
    String HOST_VLAN_FILTERING_ENABLED = "vlan.filtering.enabled";
    String HOST_VLAN_TRUNK_XML_SUPPORTED = "vlan.trunk.xml.supported";
    String HOST_GUEST_BRIDGE_STP_ENABLED = "guest.bridge.stp.enabled";
    String HOST_MIGRATION_IP = "host.migration.ip";
    String GUEST_OS_CATEGORY_ID = "guest.os.category.id";
    String GUEST_OS_RULE = "guest.os.rule";
    String HOST_CPU_MAX_SPEED_MHZ = "host.cpu.max.speed.mhz";

    int DEFAULT_SSH_PORT = 22;

    /**
     * @return name of the machine.
     */
    String getName();

    /**
     * @return the type of host.
     */
    Type getType();

    /**
     * @return the date the host first registered
     */
    Date getCreated();

    /**
     * @return current state of this machine.
     */
    Status getStatus();

    /**
     * @return the ip address of the host.
     */
    String getPrivateIpAddress();

    /**
     * @return the ip address of the host.
     */
    String getStorageUrl();

    /**
     * @return the ip address of the host attached to the storage network.
     */
    String getStorageIpAddress();

    /**
     * @return the mac address of the host.
     */
    String getGuid();

    /**
     * @return total amount of memory.
     */
    Long getTotalMemory();

    /**
     * @return # of cpu sockets in a machine.
     */
    Integer getCpuSockets();

    /**
     * @return # of cores in a machine.  Note two cpus with two cores each returns 4.
     */
    Integer getCpus();

    /**
     * @return speed of each cpu in mhz.
     */
    Long getSpeed();

    /**
     * @return the proxy port that is being listened at the agent host
     */
    Integer getProxyPort();

    /**
     * @return the pod.
     */
    Long getPodId();

    /**
     * @return availability zone.
     */
    long getDataCenterId();

    /**
     * @return parent path.  only used for storage server.
     */
    String getParent();

    /**
     * @return storage ip address.
     */
    String getStorageIpAddressDeux();

    /**
     * @return type of hypervisor
     */
    HypervisorType getHypervisorType();

    /**
     * @return disconnection date
     */
    Date getDisconnectedOn();

    /**
     * @return version
     */
    String getVersion();

    /*
     * @return total size
     */
    long getTotalSize();

    /*
     * @return capabilities
     */
    String getCapabilities();

    /*
     * @return last pinged time
     */
    long getLastPinged();

    /*
     * @return management server id
     */
    Long getManagementServerId();

    Long getLastManagementServerId();

    /*
     *@return removal date
     */
    Date getRemoved();

    Long getClusterId();

    String getPublicIpAddress();

    String getPublicNetmask();

    String getPrivateNetmask();

    String getStorageNetmask();

    String getStorageMacAddress();

    String getPublicMacAddress();

    String getPrivateMacAddress();

    String getStorageNetmaskDeux();

    String getStorageMacAddressDeux();

    String getHypervisorVersion();

    boolean isInMaintenanceStates();

    boolean isDisabled();

    ResourceState getResourceState();

    CPU.CPUArch getArch();

    String getStorageAccessGroups();
}