accesses

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

Overview

Name	accesses
Type	Resource
Id	ovh.xdsl.accesses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
access_name	string	(wire: accessName)
pack_name	string	Pack name, if access is in a pack (wire: packName)
access_type	string	Possible copper or fiber technologies (adsl, ftte, ftth, ftto, sdsl, vdsl) (wire: accessType)
address	object	All components of an address
capabilities	object	Describe the capabilities of the Access
description	string
iam	object	IAM resource metadata
ipv_6_enabled	boolean	(wire: ipv6Enabled)
lns_rate_limit	integer	Rate limit on the LNS in kbps - Only available if canApplyLnsRateLimit capability is set to true - Must be a multiple of 64 - Min value 64 / Max value 100032 (wire: lnsRateLimit)
mail_sending	string	Status of mail sending on the Access (blockedForSpam, disabled, enabled) (wire: mailSending)
modem_profile	string	Get modem profile connection linked to the access (A, B, C, D) (wire: modemProfile)
monitoring	boolean	Whether or not this access is monitored
mttr	string	Get the Mean Time To Repair (MTTR) of the access (10ho, 20m_10ho, 20m_4ho, 4hno, 4ho, 5m_10ho, 5m_4ho, dplus1, none)
nra	string
pairs_number	integer	(wire: pairsNumber)
provider	string	The provider (axione, bouygues, ft, ftBySfr, kosc, koscDeg, ovh, sfr)
provider_infra	string	The provider of the infrastructure, if applicable (wire: providerInfra)
role	string	Available access roles (backup, main)
status	string	Status of the access (active, cancelled, close, deleting, doing, migration, slamming, terminated, upgradeOffer)

list

XDSL Access

Name	Datatype	Description
access_name	string	(wire: accessName)
pack_name	string	Pack name, if access is in a pack (wire: packName)
access_type	string	Possible copper or fiber technologies (adsl, ftte, ftth, ftto, sdsl, vdsl) (wire: accessType)
address	object	All components of an address
capabilities	object	Describe the capabilities of the Access
description	string
iam	object	IAM resource metadata
ipv_6_enabled	boolean	(wire: ipv6Enabled)
lns_rate_limit	integer	Rate limit on the LNS in kbps - Only available if canApplyLnsRateLimit capability is set to true - Must be a multiple of 64 - Min value 64 / Max value 100032 (wire: lnsRateLimit)
mail_sending	string	Status of mail sending on the Access (blockedForSpam, disabled, enabled) (wire: mailSending)
modem_profile	string	Get modem profile connection linked to the access (A, B, C, D) (wire: modemProfile)
monitoring	boolean	Whether or not this access is monitored
mttr	string	Get the Mean Time To Repair (MTTR) of the access (10ho, 20m_10ho, 20m_4ho, 4hno, 4ho, 5m_10ho, 5m_4ho, dplus1, none)
nra	string
pairs_number	integer	(wire: pairsNumber)
provider	string	The provider (axione, bouygues, ft, ftBySfr, kosc, koscDeg, ovh, sfr)
provider_infra	string	The provider of the infrastructure, if applicable (wire: providerInfra)
role	string	Available access roles (backup, main)
status	string	Status of the access (active, cancelled, close, deleting, doing, migration, slamming, terminated, upgradeOffer)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the access type, address, status, provider, NRA, pack name, IPv6 and mail sending status, monitoring, LNS rate limit, mean time to repair and capabilities.
list	select		iam_tags, x_pagination_mode	Returns the names of the xDSL accesses of the account. Each name is the serviceName used by the other xDSL calls.
update	update	service_name		Changes the settings that can be modified: the customer description, the monitoring and the LNS rate limit.
address_move_extra_ip_range_move	exec	serviceName		Starts the move of the extra IP range of the access to its new access after an address move. Returns the task that performs the change.
apply_template_to_modem	exec	serviceName, templateName		Applies a modem template to the modem of the access, except the parameters the template ignores. Returns the task that performs the change.
cancel_resiliation	exec	serviceName		Cancels the ongoing resiliation of the access. Check first that it can be canceled with canCancelResiliation.
change_contact	exec	serviceName		Starts a procedure to change the admin, tech or billing contact of the access. Returns the IDs of the contact change tasks.
ipv6	exec	serviceName, enabled		Turns IPv6 on or off for the access. Returns the task that performs the change.
log_url	exec	serviceName, kind		Generates a temporary URL to read the logs of one kind. The URL expires.
mail_sending	exec	serviceName, status		Allows or blocks outgoing email (SMTP) from the access. Returns the task that performs the change.
order_meeting	exec	serviceName, endDate, startDate, uiCode		Books one of the time slots returned by searchOrderMeetings for the access and relaunches its order.
request_ppp_login_mail	exec	serviceName		Renews the PPP password of the access and sends the PPP login information to the email address of the admin contact.
request_total_deconsolidation	exec	serviceName		Switches the access to total deconsolidation, porting its line number with its RIO code unless noPortability is set. Returns the task that performs the change.
resiliate	exec	serviceName, resiliationSurvey		Requests the resiliation of the access at the given date with a resiliation survey. Returns the resiliation status, effective date and whether the modem must be returned.
search_order_meetings	exec	serviceName		Returns, as an asynchronous task, the available time slots for the line creation meeting of the access order.
send_order_to_provider	exec	serviceName		Sends to the provider an order in waitingCustomer status. Only applies to orders whose modem was sent before anything was forwarded to the provider.
update_invalid_or_missing_rio	exec	serviceName, relaunchWithoutPortability		Sets the RIO code of an order in error because of a missing or invalid RIO, or relaunches the order without number portability.

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"}})
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
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

Returns the access type, address, status, provider, NRA, pack name, IPv6 and mail sending status, monitoring, LNS rate limit, mean time to repair and capabilities.

SELECT
access_name,
pack_name,
access_type,
address,
capabilities,
description,
iam,
ipv_6_enabled,
lns_rate_limit,
mail_sending,
modem_profile,
monitoring,
mttr,
nra,
pairs_number,
provider,
provider_infra,
role,
status
FROM ovh.xdsl.accesses
WHERE service_name = '{{ service_name }}' -- required
;

list

Returns the names of the xDSL accesses of the account. Each name is the serviceName used by the other xDSL calls.

SELECT
access_name,
pack_name,
access_type,
address,
capabilities,
description,
iam,
ipv_6_enabled,
lns_rate_limit,
mail_sending,
modem_profile,
monitoring,
mttr,
nra,
pairs_number,
provider,
provider_infra,
role,
status
FROM ovh.xdsl.accesses
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Changes the settings that can be modified: the customer description, the monitoring and the LNS rate limit.

UPDATE ovh.xdsl.accesses
SET 
description = '{{ description }}',
lns_rate_limit = {{ lns_rate_limit }},
monitoring = {{ monitoring }}
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

address_move_extra_ip_range_move

Starts the move of the extra IP range of the access to its new access after an address move. Returns the task that performs the change.

EXEC ovh.xdsl.accesses.address_move_extra_ip_range_move 
@serviceName='{{ serviceName }}' --required
;

apply_template_to_modem

Applies a modem template to the modem of the access, except the parameters the template ignores. Returns the task that performs the change.

EXEC ovh.xdsl.accesses.apply_template_to_modem 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"templateName": "{{ templateName }}"
}'
;

cancel_resiliation

Cancels the ongoing resiliation of the access. Check first that it can be canceled with canCancelResiliation.

EXEC ovh.xdsl.accesses.cancel_resiliation 
@serviceName='{{ serviceName }}' --required
;

change_contact

Starts a procedure to change the admin, tech or billing contact of the access. Returns the IDs of the contact change tasks.

EXEC ovh.xdsl.accesses.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

ipv6

Turns IPv6 on or off for the access. Returns the task that performs the change.

EXEC ovh.xdsl.accesses.ipv6 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"enabled": {{ enabled }}
}'
;

log_url

Generates a temporary URL to read the logs of one kind. The URL expires.

EXEC ovh.xdsl.accesses.log_url 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"kind": "{{ kind }}"
}'
;

mail_sending

Allows or blocks outgoing email (SMTP) from the access. Returns the task that performs the change.

EXEC ovh.xdsl.accesses.mail_sending 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"status": "{{ status }}"
}'
;

order_meeting

Books one of the time slots returned by searchOrderMeetings for the access and relaunches its order.

EXEC ovh.xdsl.accesses.order_meeting 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"endDate": "{{ endDate }}", 
"startDate": "{{ startDate }}", 
"uiCode": "{{ uiCode }}"
}'
;

request_ppp_login_mail

Renews the PPP password of the access and sends the PPP login information to the email address of the admin contact.

EXEC ovh.xdsl.accesses.request_ppp_login_mail 
@serviceName='{{ serviceName }}' --required
;

request_total_deconsolidation

Switches the access to total deconsolidation, porting its line number with its RIO code unless noPortability is set. Returns the task that performs the change.

EXEC ovh.xdsl.accesses.request_total_deconsolidation 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"noPortability": {{ noPortability }}, 
"rio": "{{ rio }}"
}'
;

resiliate

Requests the resiliation of the access at the given date with a resiliation survey. Returns the resiliation status, effective date and whether the modem must be returned.

EXEC ovh.xdsl.accesses.resiliate 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"resiliationDate": "{{ resiliationDate }}", 
"resiliationSurvey": "{{ resiliationSurvey }}"
}'
;

search_order_meetings

Returns, as an asynchronous task, the available time slots for the line creation meeting of the access order.

EXEC ovh.xdsl.accesses.search_order_meetings 
@serviceName='{{ serviceName }}' --required
;

send_order_to_provider

Sends to the provider an order in waitingCustomer status. Only applies to orders whose modem was sent before anything was forwarded to the provider.

EXEC ovh.xdsl.accesses.send_order_to_provider 
@serviceName='{{ serviceName }}' --required
;

update_invalid_or_missing_rio

Sets the RIO code of an order in error because of a missing or invalid RIO, or relaunches the order without number portability.

EXEC ovh.xdsl.accesses.update_invalid_or_missing_rio 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"relaunchWithoutPortability": {{ relaunchWithoutPortability }}, 
"rio": "{{ rio }}"
}'
;