ClusterNodeVMDeploymentRequest (type)

{
  "additionalProperties": false, 
  "description": "Contains the deployment information for a cluster node VM soon to be deployed or already deployed by the Manager", 
  "id": "ClusterNodeVMDeploymentRequest", 
  "module_id": "ClusterNodeVMDeployment", 
  "properties": {
    "deployment_config": {
      "$ref": "ClusterNodeVMDeploymentConfig, 
      "description": "Info needed to configure a cluster node VM at deployment for a specific platform. May require different parameters depending on the method used to deploy the VM.", 
      "required": true, 
      "title": "Deployment config for cluster node VM"
    }, 
    "form_factor": {
      "$ref": "ClusterNodeVMFormFactor, 
      "default": "MEDIUM", 
      "description": "Specifies the desired \"size\" of the VM", 
      "required": false, 
      "title": "Form factor for cluster node VMs"
    }, 
    "roles": {
      "description": "List of cluster node role (or roles) which the VM should take on. They specify what type (or types) of cluster node which the new VM should act as. Currently both CONTROLLER and MANAGER must be provided, since this permutation is the only one supported now.", 
      "items": {
        "$ref": "ClusterNodeRole
      }, 
      "required": true, 
      "title": "Cluster node roles of the VM", 
      "type": "array"
    }, 
    "user_settings": {
      "$ref": "NodeUserSettings, 
      "description": "Username and password settings for the cluster node VM. Passwords must be at least 12 characters in length and contain at least one lowercase, one uppercase, one numerical, and one special character. Note: These settings will be honored only during VM deployment. Post-deployment, CLI must be used for changing the user settings and changes to these parameters will not have any effect.", 
      "required": true, 
      "sensitive": true, 
      "title": "User settings for the VM"
    }, 
    "vm_id": {
      "description": "ID of the VM maintained internally and used to recognize it. Note: This is automatically generated and cannot be modified.", 
      "readonly": true, 
      "required": false, 
      "title": "ID of VM used to recognize it", 
      "type": "string"
    }
  }, 
  "title": "Info for an auto-deployment request", 
  "type": "object"
}