As mentioned above, you will need to find the suitable public
peering service product offering, which would include properties
such as specific LAN instance and bandwidth. The list of product
offerings can be obtained using the
product_offerings_list
operation with an applied filter: GET /product-offerings?type=exchange_lan
The complete list of required properties is specified in the
response of the product product_offerings_read endpoint.
Next you will need to create a Network Service Config (NSC) which
will represent your public peering service. In order to do that,
you will require several properties as described in the
network_service_configs_create operation.
We list here the steps to obtain all the required properties.
The type for the NSC must match the type of the network
service which in this case is exchange_lan.
The product_offering ID is the same as the previously
selected product offering response.
Likewise, the network_service ID is available in the
previously selected product offering response under
exchange_lan_network_service.
You will also need account IDs (managing_account,
consuming_account, billing_account). If you are creating the
service for yourself they will all match. Otherwise the
consuming_account will be your sub-customer account ID and the
billing_account could either be your or your sub-customer
account ID depending on the billing policy of the exchange.
Next you will need to specify on which connection the service will reside. On how to obtain a connection ID please refer to Connection.
The connection needs to be in the same
handover_metro_area_network specified in the product offering.
When creating an NSC will also require a vlan config. Please see the Service VLAN section on how to specify it.
Specific services require specific contacts to be assigned to
specific roles in that service context. Effectively being
responsible for certain aspects of the service lifecycle (E.g:
NOC contact supposedly reachable 24/7 for emergencies). You can
find the required role assignments for a NSC in the corresponding
network_services_read
response in the nsc_required_contact_roles property.
Once you found out the required role assignment you need to either pick from existing or create the corresponding role assignments and specify their role assignments IDs during the creation of the NSC.
Finally, for public peering services, you will also require a MAC
address. You can list mac addresses using
macs_list
or register a new mac address via
macs_create.
Once you have selected a suitable MAC address you can use the MAC address ID during the creation of the NSC.
{
"type": "exchange_lan",
"network_service": "<network_service_id>",
"managing_account": "<my_account_id>",
"billing_account": "<my_account_id>",
"consuming_account": "<customer_account_id>",
"product_offering": "<product_offering_id>",
"external_ref": "IX:Service:23042",
"purchase_order": "Project: DC Moon",
"contract_ref": "contract:31824",
"role_assignments": ["<noc_role_assignment_id>"],
"connection": "string",
"vlan_config": {
"vlan_type": "dot1q",
"vlan": 23,
"vlan_ethertype": "0x8100"
},
"capacity": null,
"asns": [
4294967295
],
"macs": [
"<mac_address_id>"
],
"listed": true
}
{
"type": "exchange_lan",
"state": "error",
"status": [
{
"severity": 2,
"tag": "network_feature_config_required",
"message": "This service requires a route server network feature id: 2342.",
"attrs": {
"network_feature": "2342"
},
"timestamp": "2019-08-24T14:15:22Z"
}
],
"current_billing_start_date": "2019-08-24",
"id": "ff4e3e4-5f6a-4b7b-8c8c-9d9d9d9d9d9d",
"network_service": "string",
"managing_account": "<my_account_id>",
"consuming_account": "<customer_account_id>",
"external_ref": "IX:Service:23042",
"purchase_order": "Project: DC Moon",
"contract_ref": "contract:31824",
"billing_account": "string",
"role_assignments": [
"c-impl:123",
"c-noc:331"
],
"connection": "string",
"network_feature_configs": [
"12356",
"43829"
],
"vlan_config": {
"vlan_type": "dot1q",
"vlan": 23,
"vlan_ethertype": "0x8100"
},
"capacity": 1,
"asns": [
4294967295
],
"macs": [
"<mac_address_id>"
],
"ips": [
"<new_ip_address_id>"
],
"listed": true,
"product_offering": "<product_offering_id>"
}
Some exchanges might require you to create a Network Feature Config (NFC) alongside the NSC.
You can find the required Network Features to configure for
a specific NSC with the
network_features_list
operation and providing the ID of the network service and required as
filters: GET /network-features?required=true&network_service=<network_service_id>
If an NFC is required the corresponding NSC will stay in an error
state until the NFC has been created. On how to create an NFC
please refer to setting up a Route Server
Session.
Depending on each exchange level of automation the provisioning
of the service may or may not be on demand. Because of that you
may need to poll the state of the newly created service using the
network_service_configs_read
operation.
[
{
"type": "route_server",
"id": "string",
"name": "string",
"required": true,
"nfc_required_contact_roles": [
"role:noc", "role:implementation"
],
"flags": [
{
"name": "RPKI-HARD-FILTER",
"description": "RPKI reject invalid filtering is available",
"mandatory": true
}
],
"network_service": "string",
"asn": 0,
"fqdn": "rs1.example.ix",
"looking_glass_url": "https://lg.example.ix/rs1",
"address_families": [
"af_inet"
],
"session_mode": "public",
"available_bgp_session_types": [
"passive"
],
"ip_v4": "192.42.23.1",
"ip_v6": "2001:23:42::1"
}
]
You may want to update the peering IP FQDN, in order to do so you
will need to find the IP address the exchange assigned for your
public peering service, using the
ips_list
operation, filtering by network service config ID:
GET /ips?network_service_config=<nsc_id>
And then you will need to update the FQDN property with
ips_partial_update.