telephony_default_ip_restrictions

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

Overview

Name	telephony_default_ip_restrictions
Type	Resource
Id	ovh.me.telephony_default_ip_restrictions

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
subnet	string (ipv4-block)	The IPv4 subnet you want to allow (example: 192.0.2.0/24)
type	string	The protocol you want to restrict (sip/mgcp) (mgcp, sip)

list

Default IP restriction of a VoIP line

Name	Datatype	Description
id	integer
subnet	string (ipv4-block)	The IPv4 subnet you want to allow (example: 192.0.2.0/24)
type	string	The protocol you want to restrict (sip/mgcp) (mgcp, sip)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get this object properties
list	select		x_pagination_mode	The default SIP IP restictions for your future VoIP lines
create	insert	subnet, type		Create a default IP restriction for your future VoIP lines
delete	delete	id		Delete a default IP restriction for your future VoIP lines

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"}})
id	integer
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 this object properties

SELECT
id,
subnet,
type
FROM ovh.me.telephony_default_ip_restrictions
WHERE id = '{{ id }}' -- required
;

list

The default SIP IP restictions for your future VoIP lines

SELECT
id,
subnet,
type
FROM ovh.me.telephony_default_ip_restrictions
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a default IP restriction for your future VoIP lines

INSERT INTO ovh.me.telephony_default_ip_restrictions (
subnet,
type
)
SELECT 
'{{ subnet }}' /* required */,
'{{ type }}' /* required */
RETURNING
id,
subnet,
type
;

Manifest

# Description fields are for documentation purposes
- name: telephony_default_ip_restrictions
props:
  - name: subnet
    value: "{{ subnet }}"
    description: |
      The IPv4 subnet you want to allow
  - name: type
    value: "{{ type }}"
    description: |
      The protocol you want to restrict (sip/mgcp)
    valid_values: ['mgcp', 'sip']

DELETE examples

delete

Delete a default IP restriction for your future VoIP lines

DELETE FROM ovh.me.telephony_default_ip_restrictions
WHERE id = '{{ id }}' --required
;