service_servers

Creates, updates, deletes, gets or lists a service_servers resource.

Overview

Name	service_servers
Type	Resource
Id	ovh.email_exchange.service_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)
commercial_version	string	Exchange commercial version (2010, 2013, 2016, 2019, SE) (wire: commercialVersion)
current_disk_usage	integer	Current disk usage in MB (wire: currentDiskUsage)
disk_size	integer	Total disk size in MB (wire: diskSize)
individual_2010	boolean	If true server is 2010 individual offer (wire: individual2010)
ip	string	ipV4
ip_v6	string	ipV6 (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)
owa_mfa	boolean	Indicates if Multi Factor Authentication is activated on Outlook Web Access interface (wire: owaMfa)
state	string	Server state (configurationError, configurationPending, notConfigured, ok)
version	integer	ExchangeServer version

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	exchange_service, organization_name		Get the server. Returns the Exchange version, state, IP addresses, disk usage, DNS record checks and Outlook Web Access MFA status of the server.
update	update	exchange_service, organization_name		Update the server. Updates the server settings: set owaMfa to enable or disable MFA on the Outlook Web Access interface.

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"}})
exchange_service	string	The internal name of your exchange service (wire: exchangeService)
organization_name	string	The internal name of your exchange organization (wire: organizationName)

SELECT examples

get

Get the server. Returns the Exchange version, state, IP addresses, disk usage, DNS record checks and Outlook Web Access MFA status of the server.

SELECT
task_pending_id,
commercial_version,
current_disk_usage,
disk_size,
individual_2010,
ip,
ip_v6,
is_a_valid,
is_aaaa_valid,
is_ptr_v6_valid,
is_ptr_valid,
owa_mfa,
state,
version
FROM ovh.email_exchange.service_servers
WHERE exchange_service = '{{ exchange_service }}' -- required
AND organization_name = '{{ organization_name }}' -- required
;

UPDATE examples

update

Update the server. Updates the server settings: set owaMfa to enable or disable MFA on the Outlook Web Access interface.

UPDATE ovh.email_exchange.service_servers
SET 
owa_mfa = {{ owa_mfa }}
WHERE 
exchange_service = '{{ exchange_service }}' --required
AND organization_name = '{{ organization_name }}' --required;