Class AddHostRequest

java.lang.Object
com.morpheusdata.request.AddHostRequest

public class AddHostRequest extends Object
Since:
1.4.2
  • Field Details

    • serverType

      public ComputeServerType serverType
      The type of host to provision. Resolved by id to a persisted ComputeServerType; pass a reference carrying at least the id. Required.
    • serverName

      public String serverName
      Optional display name for the new host. If not provided, a name is auto-generated.
    • hostname

      public String hostname
      Optional hostname for the new host. Defaults to serverName if not provided.
    • plan

      public ServicePlan plan
      The service plan (sizing) to provision the host with. Passed through by id as a reference to a persisted ServicePlan.
    • config

      public Map<String,Object> config
      Additional provider-specific configuration passed straight through to the provisioner. May include settings such as customOptions, or a nested server map whose entries are applied directly onto the server config. Free-form; not schema-validated.
    • siteId

      public Long siteId
      Optional id of the group/site to provision the host into. null lets the cloud choose its default placement.
    • volumes

      public List<StorageVolume> volumes
      Storage volumes to provision and attach to the new host.

      These are typed configuration templates, not references to persisted StorageVolume rows: only the descriptive fields are read (name, rootVolume, maxStorage, and the type/datastore ids) to describe the volumes the provisioner should create. No existing StorageVolume record is looked up or required for the volume itself.

    • networkInterfaces

      public List<ComputeServerInterface> networkInterfaces
      Network interfaces to provision on the new host.

      Like volumes, these are typed configuration templates rather than persisted ComputeServerInterface rows: only the descriptive fields are read (name, ipMode, any static addresses, and the network/networkGroup/ networkPool ids) to describe the NICs the provisioner should create. No existing ComputeServerInterface record is looked up or required for the interface itself.

    • securityGroupIds

      public List<Long> securityGroupIds
      Ids of security groups to apply to the new host. Each id is passed through to the provisioner as a reference to a persisted security group.
    • licenseCheck

      public boolean licenseCheck
      Whether to perform license and connectivity checks before provisioning. Set to false to skip these checks. Defaults to true.
    • pool

      public CloudPool pool
      Optional resource pool/cluster to provision the host into. Passed through by id as a reference to a persisted CloudPool. null is valid for clouds that do not scope hosts to a resource pool/cluster.
  • Constructor Details

    • AddHostRequest

      public AddHostRequest()