Commands

Documentation for `scw interlink`

The CLI documentation pages are currently under construction

The content is up to date. We're making improvements to the site over the next few weeks for a better experience.

This API allows you to manage your InterLink services.

Connection commands

Connection commands.

Usage:

Code
scw interlink connection

Link commands

Link commands.

Attach a routing policy

Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.

Usage:

Code
scw interlink link attach_policy <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link to attach a routing policy to	Required
routing-policy-id	ID of the routing policy to be attached	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Attach a VPC

Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.

Usage:

Code
scw interlink link attach_vpc <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link to attach VPC to	Required
vpc-id	ID of the VPC to attach	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Create a link

Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (facilitated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).

Usage:

Code
scw interlink link create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
name	Name of the link	Required
tags.{index}	List of tags to apply to the link
pop-id	PoP (location) where the link will be created	Required
bandwidth-mbps	Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection	Required
connection-id	If set, creates a self-hosted link using this dedicated physical connection. As the customer, specify the ID of the physical connection you already have for this link.
partner-id	If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth.
peer-asn	For self-hosted links we need the peer AS Number to establish BGP session. If not given, a default one will be assigned.
vlan	For self-hosted links only, it is possible to choose the VLAN ID. If the VLAN is not available (ie already taken or out of range), an error is returned.
routing-policy-v4-id	If set, attaches this routing policy containing IPv4 prefixes to the Link. Hence, a BGP IPv4 session will be created.
routing-policy-v6-id	If set, attaches this routing policy containing IPv6 prefixes to the Link. Hence, a BGP IPv6 session will be created.
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Delete a link

Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted.

Usage:

Code
scw interlink link delete <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Detach a routing policy

Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.

Usage:

Code
scw interlink link detach_policy <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link to detach a routing policy from	Required
routing-policy-id	ID of the routing policy to be detached	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Detach a VPC

Detach a VPC from an existing link.

Usage:

Code
scw interlink link detach_vpc <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link to detach the VPC from	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Disable route propagation

Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.

Usage:

Code
scw interlink link disable_propagation <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link on which to disable route propagation	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Enable route propagation

Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.

Usage:

Code
scw interlink link enable_propagation <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link on which to enable route propagation	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Get a link

Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link's various configuration details.

Usage:

Code
scw interlink link get <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link to get	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

List links

List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status.

Usage:

Code
scw interlink link list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Order in which to return results	One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `status_asc`, `status_desc`
project-id	Project ID to filter for
name	Link name to filter for
tags.{index}	Tags to filter for
status	Link status to filter for	One of: `unknown_link_status`, `configuring`, `failed`, `requested`, `refused`, `expired`, `provisioning`, `active`, `limited_connectivity`, `all_down`, `deprovisioning`, `deleted`, `locked`, `ready`
bgp-v4-status	BGP IPv4 status to filter for	One of: `unknown_bgp_status`, `up`, `down`, `disabled`
bgp-v6-status	BGP IPv6 status to filter for	One of: `unknown_bgp_status`, `up`, `down`, `disabled`
pop-id	Filter for links attached to this PoP (via connections)
bandwidth-mbps	Filter for link bandwidth (in Mbps)
partner-id	Filter for links hosted by this partner
vpc-id	Filter for links attached to this VPC
routing-policy-id	Filter for links using this routing policy
pairing-key	Filter for the link with this pairing_key
kind	Filter for hosted or self-hosted links	One of: `hosted`, `self_hosted`, `l2_hosted`, `l3_hosted`
connection-id	Filter for links self-hosted on this connection
organization-id	Organization ID to filter for
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`, `all`

Update a link

Update an existing link, specified by its link ID. Only its name and tags can be updated.

Usage:

Code
scw interlink link update <link-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
link-id	ID of the link to update	Required
name	Name of the link
tags.{index}	List of tags to apply to the link
peer-asn	For self-hosted links, AS Number to establish BGP session.
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Partner commands

Partner commands.

Get a partner

Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL.

Usage:

Code
scw interlink partner get <partner-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
partner-id	ID of partner to get	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

List available partners

List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the order_by field.

Usage:

Code
scw interlink partner list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Order in which to return results	One of: `name_asc`, `name_desc`
pop-ids.{index}	Filter for partners present (offering a connection) in one of these PoPs
l3-connectivity	Filter for partners supporting L3 connectivity
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`, `all`

PoP commands

PoP commands.

Get a PoP

Get a PoP for the given PoP ID. The response object includes the PoP's name and information about its physical location.

Usage:

Code
scw interlink pop get <pop-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
pop-id	ID of PoP to get	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

List PoPs

List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name.

Usage:

Code
scw interlink pop list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Order in which to return results	One of: `name_asc`, `name_desc`
name	PoP name to filter for
hosting-provider-name	Hosting provider name to filter for
partner-id	Filter for PoPs hosting an available shared connection from this partner
link-bandwidth-mbps	Filter for PoPs with a connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity.
dedicated-available	Filter for PoPs with a dedicated connection available for self-hosted links.
l3-connectivity-partners	Filter for PoPs with a shared connection available from a partner supporting L3 connectivity
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`, `all`

Routing policy commands

Routing policy commands.

Create a routing policy

Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer.

Usage:

Code
scw interlink routing-policy create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
name	Name of the routing policy	Required
tags.{index}	List of tags to apply to the routing policy
prefix-filter-in.{index}	IP prefixes to accept from the peer (ranges of route announcements to accept)
prefix-filter-out.{index}	IP prefix filters to advertise to the peer (ranges of routes to advertise)
is-ipv6	IP prefixes version of the routing policy
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Delete a routing policy

Delete an existing routing policy, specified by its routing policy ID.

Usage:

Code
scw interlink routing-policy delete <routing-policy-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
routing-policy-id	ID of the routing policy to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

Get routing policy

Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.

Usage:

Code
scw interlink routing-policy get <routing-policy-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
routing-policy-id	ID of the routing policy to get	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`

List routing policies

List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections).

Usage:

Code
scw interlink routing-policy list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Order in which to return results	One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`
project-id	Project ID to filter for
name	Routing policy name to filter for
tags.{index}	Tags to filter for
ipv6	Filter for the routing policies based on IP prefixes version
organization-id	Organization ID to filter for
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`, `all`

Update a routing policy

Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.

Usage:

Code
scw interlink routing-policy update <routing-policy-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
routing-policy-id	ID of the routing policy to update	Required
name	Name of the routing policy
tags.{index}	List of tags to apply to the routing policy
prefix-filter-in.{index}	IP prefixes to accept from the peer (ranges of route announcements to accept)
prefix-filter-out.{index}	IP prefix filters for routes to advertise to the peer (ranges of routes to advertise)
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `it-mil`, `nl-ams`, `pl-waw`