Server Arrays
Contents
Server Arrays
Server arrays represent a set of servers.
List Server Arrays
GET /v3/cloud/server_arrays
This action provides information about the existing server arrays.
Inputs
None
Returns
An array of server arrays with the following fields:
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning,inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles which the server array uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
Show Server Array
GET /v3/cloud/server_arrays/:id
This action returns information about the server array identified by the given id.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles which the server array uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
Create Server Array
POST /v3/cloud/server_arrays
This action creates a server array with the given parameters.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| name | String | Logical name of the server array. | Yes |
| size | Integer | The number of initial servers in the server array. Value by default is 0. | No |
| workspace_id | String | Identifier of the workspace to which the server array belongs. | Yes before 7.3, no from 7.3 onwards. |
| template_id | String | Identifier of the template which the server array uses. | Yes |
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | Yes |
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | Yes |
| firewall_profile_id | String | Identifier of the firewall profile to which the server array belongs.It will take firewall profile from workspace if it is not given (the default firewall profile from 7.3 onwards). | No |
| ssh_profile_id | String | Identifier of the ssh profile to which the server array belongs.It will take ssh profile from workspace if it is not given (the default ssh profile from 7.3 onwards). | No |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles to which the server array will belong. On version 9 onwards, that's the default way to set ssh profiles to a server array. If ssh_profile_id and ssh_profile_ids are given, ssh_profile_id will not be taken into account. | No |
| subnet_id | String | Identifier of the subnet to which the server array belongs. It will not be on any subnet managed by IMCO if not given. | No |
| privateness | Boolean | If the server array is private, the value is true. If it's public, this value can be false or nil. | No |
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | No |
| label_ids | Array of strings | List of ids corresponding to the labels to assign to the server array. | No |
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles the server uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
Update Server Array
PUT /v3/cloud/server_arrays/:id
This action updates the server array with the given id with the given parameters.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| name | String | Logical name of the server array. | No |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles to which the server array will belong. | No |
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | No |
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles the server uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
Boot Server Array
PUT /v3/cloud/server_arrays/:id/boot
This action boots all the servers in the server array with the given id. The server array must be in an inactive state.
Inputs
None
Return
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles the server uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
Shut down Server Array
PUT /v3/cloud/server_arrays/:id/shutdown
This action shuts down all the servers in the server array identified by the id parameter. The server must be in bootstrap.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles the server uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
Destroy Server Array
DELETE /v3/cloud/server_arrays/:id
This action destroys the server array with the given id.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| force | Boolean | If set to true, the server array is emptied and then destroyed, all in the same operation. If set to false or not provided, this operation will only be allowed if the server array is empty. | No |
Returns
None
Empty Server Array
PUT /v3/cloud/server_arrays/:id/empty
This action empties all servers in server array with the given id.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles the server uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
List servers in Server Array
GET /v3/cloud/server_arrays/:servers_array_id/servers
This action list all the servers in server array with the given id.
Inputs
None
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles the server uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |
Enlarge Server Array
POST /v3/cloud/server_arrays/:servers_array_id/servers
This action adds servers in server array with the given id.
Inputs
| Field | Type | Description | Required | Deprecation notices |
|---|---|---|---|---|
| size_increase | Integer | The number of servers to add to the array, a number between 1 and 5. | Yes | |
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | No | Ignored from 7.2 onwards. |
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | No | Ignored from 7.2 onwards. |
Returns
| Field | Type | Description | Deprecation notices | Notes |
|---|---|---|---|---|
| id | String | Identifier of the server array | ||
| name | String | Logical name of the server array | ||
| state | String | State of the server array. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled. | ||
| size | String | The number of servers in the server array. | ||
| server_plan_id | String | Identifier of the server plan with which the server array is deployed. | ||
| cloud_account_id | String | Identifier of the cloud account in which the server array is deployed. | ||
| workspace_id | String | Identifier of the workspace to which the server array belongs. | No longer available from 7.3 onwards. | |
| template_id | String | Identifier of the template which the server array uses. | ||
| firewall_profile_id | String | Identifier of the firewall profile applied on the server array. | ||
| ssh_profile_id | String | Identifier of the ssh profile which the server array uses. First of ssh_profile_ids. | Deprecated from version 9 onwards. | |
| ssh_profile_ids | Array of string | Identifiers of the ssh profiles the server uses. | Available from version 9 onwards. | |
| subnet_id | String | Identifier of the subnet to which the server array belongs. | ||
| vpc_id | String | Identifier of the VPC to which the server array belongs. | ||
| privateness | Boolean | Flag indicating whether the server will get only a private IP | ||
| variable_value_ids | Object | An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards. | ||
| label_ids | Array of strings | List of ids corresponding to the labels the server array has assigned. | ||
| resource_type | String | An identifier for the type of resource, specifically "server_array". |