voip_line_services

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

Overview

Name	voip_line_services
Type	Resource
Id	ovh.pack_xdsl.voip_line_services

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
billing_account	string	(wire: billingAccount)
domain	string

list

VOIP line services

Name	Datatype	Description
billing_account	string	(wire: billingAccount)
domain	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, pack_name		Get a VoIP line service of an xDSL pack. Returns the domain and the billing account of a VoIP line service activated with the pack.
list	select	pack_name	x_pagination_mode	List the VoIP line services of an xDSL pack. Returns the domains of the VoIP line services activated with the pack.
create	insert	pack_name, hardware_names		Create a VoIP line service in an xDSL pack. Orders VoIP lines with the given hardware, shipped to a shipping address or a Mondial Relay point. Returns the order.

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"}})
domain	string
pack_name	string	The internal name of your pack (wire: packName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a VoIP line service of an xDSL pack. Returns the domain and the billing account of a VoIP line service activated with the pack.

SELECT
billing_account,
domain
FROM ovh.pack_xdsl.voip_line_services
WHERE domain = '{{ domain }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;

list

List the VoIP line services of an xDSL pack. Returns the domains of the VoIP line services activated with the pack.

SELECT
billing_account,
domain
FROM ovh.pack_xdsl.voip_line_services
WHERE pack_name = '{{ pack_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a VoIP line service in an xDSL pack. Orders VoIP lines with the given hardware, shipped to a shipping address or a Mondial Relay point. Returns the order.

INSERT INTO ovh.pack_xdsl.voip_line_services (
hardware_names,
mondial_relay_id,
shipping_id,
pack_name
)
SELECT 
'{{ hardware_names }}' /* required */,
'{{ mondial_relay_id }}',
'{{ shipping_id }}',
'{{ pack_name }}'
RETURNING
order_id,
need_payment,
order_url,
task_ids
;

Manifest

# Description fields are for documentation purposes
- name: voip_line_services
props:
  - name: pack_name
    value: "{{ pack_name }}"
    description: Required parameter for the voip_line_services resource.
  - name: hardware_names
    value:
      - "{{ hardware_names }}"
    description: |
      List of names from hardwares call
  - name: mondial_relay_id
    value: "{{ mondial_relay_id }}"
    description: |
      Mondial relay ID
  - name: shipping_id
    value: "{{ shipping_id }}"
    description: |
      Shipping ID for the order