email_pro_services

Creates, updates, deletes, gets or lists an email_pro_services resource.

Overview

Name	email_pro_services
Type	Resource
Id	ovh.pack_xdsl.email_pro_services

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	pack_name		List the Email Pro services of an xDSL pack. Returns the domains of the Email Pro services activated with the pack.
create	insert	pack_name, email, password		Create an Email Pro service in an xDSL pack. Activates an Email Pro account from an email address and a password. Returns the task that performs it.

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"}})
pack_name	string	The internal name of your pack (wire: packName)

SELECT examples

list

List the Email Pro services of an xDSL pack. Returns the domains of the Email Pro services activated with the pack.

SELECT
value
FROM ovh.pack_xdsl.email_pro_services
WHERE pack_name = '{{ pack_name }}' -- required
;

INSERT examples

create

Create an Email Pro service in an xDSL pack. Activates an Email Pro account from an email address and a password. Returns the task that performs it.

INSERT INTO ovh.pack_xdsl.email_pro_services (
email,
password,
pack_name
)
SELECT 
'{{ email }}' /* required */,
'{{ password }}' /* required */,
'{{ pack_name }}'
RETURNING
id,
function,
status,
update_date
;

Manifest

# Description fields are for documentation purposes
- name: email_pro_services
props:
  - name: pack_name
    value: "{{ pack_name }}"
    description: Required parameter for the email_pro_services resource.
  - name: email
    value: "{{ email }}"
    description: |
      The email address
  - name: password
    value: "{{ password }}"
    description: |
      The password