packs

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

Overview

Name	packs
Type	Resource
Id	ovh.pack_xdsl.packs

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
pack_name	string	Name of the xdsl pack (wire: packName)
capabilities	object	Capabilities of the pack
description	string	Customer pack description
iam	object	IAM resource metadata
offer_description	string	Name of the offer (wire: offerDescription)
offer_price	object	Price of the offer (wire: offerPrice)

list

Pack of xDSL services

Name	Datatype	Description
pack_name	string	Name of the xdsl pack (wire: packName)
capabilities	object	Capabilities of the pack
description	string	Customer pack description
iam	object	IAM resource metadata
offer_description	string	Name of the offer (wire: offerDescription)
offer_price	object	Price of the offer (wire: offerPrice)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pack_name		Get an xDSL pack. Returns the pack name, its offer description and price, the customer description and the pack capabilities.
list	select		iam_tags, x_pagination_mode	List xDSL packs. Returns the names of the xDSL packs of the account. Each name is the packName used by the other pack calls.
update	update	pack_name		Update an xDSL pack. Changes the settings that can be modified: the customer description of the pack.
address_move_move_offer	exec	packName, acceptContracts, eligibilityReference, keepCurrentNumber, modem, offerName, otp, productCode		Move an xDSL pack to another address. Starts the move to the new address with the chosen offer, modem, installation details and services to keep or delete. Returns an asynchronous task.
address_move_offers	exec	packName, eligibilityReference		Search the address move offers of an xDSL pack. Returns, as an asynchronous task, the offers available at the new address for the given eligibility reference.
address_move_services_to_delete_unpack_terms	exec	packName, eligibilityReference, offerName		List the services to delete to move an xDSL pack. Returns, by service type, the number of services to delete and their unpack terms for the offer at the new address.
cancel_resiliation	exec	packName		Cancel the resiliation of an xDSL pack. Cancels the ongoing resiliation of the pack. Check first that it can be canceled with canCancelResiliation.
change_contact	exec	packName		Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
migration_migrate	exec	packName, acceptContracts, modem, offerName		Migrate an xDSL pack to another offer. Starts the migration to the selected offer with its options, modem, installation details and services to keep or delete. Returns the task that performs it.
migration_offers	exec	packName		Search the migration offers of an xDSL pack. Returns, as an asynchronous task, the offers the pack can migrate to and, for fiber, the buildings to choose from.
migration_services_to_delete_unpack_terms	exec	packName, offerName		List the services to delete to migrate an xDSL pack. Returns, by service type, the number of services to delete and their unpack terms for the target offer.
promotion_code_generate	exec	packName		Generate a promotion code for an xDSL pack. Creates a new promotion code for the pack. Returns the task that performs it.
resiliate	exec	packName, resiliationSurvey		Resiliate an xDSL pack. Requests the resiliation of the pack at the given date with a resiliation survey, keeping the listed services. Returns the resiliation follow-up.
voip_line_options_custom_shipping_address	exec	packName, address, cityName, firstName, lastName, zipCode		Create a shipping address for a VoIP line order. Adds an address from a name, street address, zip code and city, and returns its shipping ID.

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

Get an xDSL pack. Returns the pack name, its offer description and price, the customer description and the pack capabilities.

SELECT
pack_name,
capabilities,
description,
iam,
offer_description,
offer_price
FROM ovh.pack_xdsl.packs
WHERE pack_name = '{{ pack_name }}' -- required
;

list

List xDSL packs. Returns the names of the xDSL packs of the account. Each name is the packName used by the other pack calls.

SELECT
pack_name,
capabilities,
description,
iam,
offer_description,
offer_price
FROM ovh.pack_xdsl.packs
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update an xDSL pack. Changes the settings that can be modified: the customer description of the pack.

UPDATE ovh.pack_xdsl.packs
SET 
description = '{{ description }}'
WHERE 
pack_name = '{{ pack_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

address_move_move_offer

Move an xDSL pack to another address. Starts the move to the new address with the chosen offer, modem, installation details and services to keep or delete. Returns an asynchronous task.

EXEC ovh.pack_xdsl.packs.address_move_move_offer 
@packName='{{ packName }}' --required 
@@json=
'{
"acceptContracts": {{ acceptContracts }}, 
"building": "{{ building }}", 
"buildingReference": "{{ buildingReference }}", 
"contactPhone": "{{ contactPhone }}", 
"door": "{{ door }}", 
"eligibilityReference": "{{ eligibilityReference }}", 
"engageMonths": {{ engageMonths }}, 
"floor": "{{ floor }}", 
"installationType": "{{ installationType }}", 
"keepCurrentNumber": {{ keepCurrentNumber }}, 
"meeting": "{{ meeting }}", 
"modem": "{{ modem }}", 
"mondialRelayId": {{ mondialRelayId }}, 
"moveOutDate": "{{ moveOutDate }}", 
"nicShipping": "{{ nicShipping }}", 
"offerName": "{{ offerName }}", 
"ontShippingContact": "{{ ontShippingContact }}", 
"options": "{{ options }}", 
"otp": {{ otp }}, 
"otpReference": "{{ otpReference }}", 
"productCode": "{{ productCode }}", 
"residence": "{{ residence }}", 
"stair": "{{ stair }}", 
"subServicesToDelete": "{{ subServicesToDelete }}", 
"subServicesToKeep": "{{ subServicesToKeep }}"
}'
;

address_move_offers

Search the address move offers of an xDSL pack. Returns, as an asynchronous task, the offers available at the new address for the given eligibility reference.

EXEC ovh.pack_xdsl.packs.address_move_offers 
@packName='{{ packName }}' --required 
@@json=
'{
"eligibilityReference": "{{ eligibilityReference }}"
}'
;

address_move_services_to_delete_unpack_terms

List the services to delete to move an xDSL pack. Returns, by service type, the number of services to delete and their unpack terms for the offer at the new address.

EXEC ovh.pack_xdsl.packs.address_move_services_to_delete_unpack_terms 
@packName='{{ packName }}' --required 
@@json=
'{
"eligibilityReference": "{{ eligibilityReference }}", 
"offerName": "{{ offerName }}", 
"options": "{{ options }}"
}'
;

cancel_resiliation

Cancel the resiliation of an xDSL pack. Cancels the ongoing resiliation of the pack. Check first that it can be canceled with canCancelResiliation.

EXEC ovh.pack_xdsl.packs.cancel_resiliation 
@packName='{{ packName }}' --required
;

change_contact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

EXEC ovh.pack_xdsl.packs.change_contact 
@packName='{{ packName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

migration_migrate

Migrate an xDSL pack to another offer. Starts the migration to the selected offer with its options, modem, installation details and services to keep or delete. Returns the task that performs it.

EXEC ovh.pack_xdsl.packs.migration_migrate 
@packName='{{ packName }}' --required 
@@json=
'{
"acceptContracts": {{ acceptContracts }}, 
"buildingReference": "{{ buildingReference }}", 
"contactPhone": "{{ contactPhone }}", 
"engageMonths": {{ engageMonths }}, 
"floor": "{{ floor }}", 
"installationType": "{{ installationType }}", 
"meeting": "{{ meeting }}", 
"modem": "{{ modem }}", 
"mondialRelayId": {{ mondialRelayId }}, 
"nicShipping": "{{ nicShipping }}", 
"offerName": "{{ offerName }}", 
"ontShippingContact": "{{ ontShippingContact }}", 
"options": "{{ options }}", 
"otp": {{ otp }}, 
"otpReference": "{{ otpReference }}", 
"productCode": "{{ productCode }}", 
"stair": "{{ stair }}", 
"subServicesToDelete": "{{ subServicesToDelete }}", 
"subServicesToKeep": "{{ subServicesToKeep }}"
}'
;

migration_offers

Search the migration offers of an xDSL pack. Returns, as an asynchronous task, the offers the pack can migrate to and, for fiber, the buildings to choose from.

EXEC ovh.pack_xdsl.packs.migration_offers 
@packName='{{ packName }}' --required 
@@json=
'{
"buildingReference": "{{ buildingReference }}"
}'
;

migration_services_to_delete_unpack_terms

List the services to delete to migrate an xDSL pack. Returns, by service type, the number of services to delete and their unpack terms for the target offer.

EXEC ovh.pack_xdsl.packs.migration_services_to_delete_unpack_terms 
@packName='{{ packName }}' --required 
@@json=
'{
"offerName": "{{ offerName }}", 
"options": "{{ options }}"
}'
;

promotion_code_generate

Generate a promotion code for an xDSL pack. Creates a new promotion code for the pack. Returns the task that performs it.

EXEC ovh.pack_xdsl.packs.promotion_code_generate 
@packName='{{ packName }}' --required
;

resiliate

Resiliate an xDSL pack. Requests the resiliation of the pack at the given date with a resiliation survey, keeping the listed services. Returns the resiliation follow-up.

EXEC ovh.pack_xdsl.packs.resiliate 
@packName='{{ packName }}' --required 
@@json=
'{
"resiliationDate": "{{ resiliationDate }}", 
"resiliationSurvey": "{{ resiliationSurvey }}", 
"servicesToKeep": "{{ servicesToKeep }}"
}'
;

voip_line_options_custom_shipping_address

Create a shipping address for a VoIP line order. Adds an address from a name, street address, zip code and city, and returns its shipping ID.

EXEC ovh.pack_xdsl.packs.voip_line_options_custom_shipping_address 
@packName='{{ packName }}' --required 
@@json=
'{
"address": "{{ address }}", 
"cityName": "{{ cityName }}", 
"firstName": "{{ firstName }}", 
"lastName": "{{ lastName }}", 
"zipCode": "{{ zipCode }}"
}'
;