servers
Creates, updates, deletes, gets or lists a servers resource.
Overview​
| Name | servers |
| Type | Resource |
| Id | ovh.email_mxplan.servers |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
task_pending_id | integer | Task pending id (wire: taskPendingId) |
current_disk_usage | integer | Current disk usage in MB (wire: currentDiskUsage) |
disk_size | integer | Total disk size in MB (wire: diskSize) |
ip | string (ipv4) | ipV4 (example: 192.0.2.0) |
ip_v6 | string (ipv6) | ipV6 (example: 2001:41d0:1:1994::1) (wire: ipV6) |
is_a_valid | boolean | If true your dns A record is valid (wire: isAValid) |
is_aaaa_valid | boolean | If true your dns AAAA record is valid (wire: isAaaaValid) |
is_ptr_v6_valid | boolean | If true your dns ptrV6 record is valid (wire: isPtrV6Valid) |
is_ptr_valid | boolean | If true your dns ptr record is valid (wire: isPtrValid) |
state | string | Server state (configurationPending, notConfigured, ok) |
version | integer | Server version |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service | Get the server. Returns the state, IPv4 and IPv6 addresses, version and disk usage of the server, and whether its A, AAAA and PTR DNS records are valid. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
service | string | The internal name of your mxplan organization |
SELECT examples​
- get
Get the server. Returns the state, IPv4 and IPv6 addresses, version and disk usage of the server, and whether its A, AAAA and PTR DNS records are valid.
SELECT
task_pending_id,
current_disk_usage,
disk_size,
ip,
ip_v6,
is_a_valid,
is_aaaa_valid,
is_ptr_v6_valid,
is_ptr_valid,
state,
version
FROM ovh.email_mxplan.servers
WHERE service = '{{ service }}' -- required
;