packs
Creates, updates, deletes, gets or lists a packs resource.
Overview​
| Name | packs |
| Type | Resource |
| Id | ovh.pack_siptrunk.packs |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
pack_name | string | Name of the SIP trunk pack (wire: packName) |
iam | object | IAM resource metadata |
Pack of SIP trunk services
| Name | Datatype | Description |
|---|---|---|
pack_name | string | Name of the SIP trunk pack (wire: packName) |
iam | object | IAM resource metadata |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | pack_name | Get this object properties | |
list | select | iam_tags, x_pagination_mode | List available services | |
change_contact | exec | packName | Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service. |
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"}}) |
packName | string | The internal name of your pack |
pack_name | string | The internal name of your pack (wire: packName) |
iam_tags | object | Filter resources on IAM tags (wire: iamTags) |
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
- list
Get this object properties
SELECT
pack_name,
iam
FROM ovh.pack_siptrunk.packs
WHERE pack_name = '{{ pack_name }}' -- required
;
List available services
SELECT
pack_name,
iam
FROM ovh.pack_siptrunk.packs
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- change_contact
Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
EXEC ovh.pack_siptrunk.packs.change_contact
@packName='{{ packName }}' --required
@@json=
'{
"contactAdmin": "{{ contactAdmin }}",
"contactBilling": "{{ contactBilling }}",
"contactTech": "{{ contactTech }}"
}'
;