Provisioning nodes

Use the sections that follow to provision and add Edge Nodes (formerly Edge iNodes) and Cloud Connectors (formerly Virtual iNodes).

Get node profile IDs for your organization

Start out by getting the node profile IDs for your organization. The node profile ID is a required parameter for the API call to provision a node. To get the list of node profile IDs available for your organization, make the following GET request:

curl -X GET \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  'https://<your_company>.manage.iotium.io/api/v2/profile' \
  | jq '.results | .[]' | jq '{profile_id: .id, name: .name}'

The response includes the IDs and names of all the node profiles available for your organization:

{
  "profile_id": "<your_edge_ra_profile_id>",
  "name": "Edge Remote Access"
}
{
  "profile_id": "<your_virtual_edge_profile_id>",
  "name": "Virtual Edge"
}
{
  "profile_id": "<your_virtual_profile_id>",
  "name": "Virtual"
}
{
  "profile_id": "<your_edge_profile_id>",
  "name": "Edge"
}

Add a public key to the Secure Edge Portal

Before provisioning an Edge Node or Virtual Edge Node, make sure you have an SSH public key for accessing the node console. If you don't have an SSH key pair, see Managing SSH key authentication for a node.

To add your SSH public key to the Secure Edge Portal, make the following POST request with the request body parameters:

curl -X POST \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"name":"<your_ssh_key_name>", \
       "public_key":"<your_ssh_public_keyfile_content>"}' \
  'https://<your_company>.manage.iotium.io/api/v1/sshkey' \
  | jq '{ssh_key_id: .id, name: .name}'

The response includes the name and ID of the SSH key added to the Secure Edge Portal:

{
  "ssh_key_id": "<your_ssh_key_id>",
  "name": "<your_ssh_key_name>"
}

Get all public keys added for your organization

To get the list of all SSH keys added to the Secure Edge Portal for your organization, make the following GET request:

curl -X GET \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json"\
  'https://<your_company>.manage.iotium.io/api/v2/sshkey' \
  | jq '.results | .[]' | jq '{name: .name, ssh_key_id: .id}'

The response includes the names and IDs of all the SSH keys available for your organization:

{
  "name": "<your_ssh_key_1_name>",
  "ssh_key_id": "<your_ssh_key_1_id>"
}
{
  "name": "<your_ssh_key_2_name>"
  "ssh_key_id": "<your_ssh_key_2_id>"
}

Provision an Edge Node

Use information these sections to provision Edge Nodes.

Get available hardware serial numbers for your organization

Before provisioning an Edge Node, make sure the hardware serial number that matches the serial number label on your Edge Node is available in your Secure Edge Portal account. We've pre-populated the hardware serial numbers in the Secure Edge Portal for the hardware devices that we shipped to you.

To get the list of available hardware serial numbers for your organization, make the following GET request with the query string parameters:

curl -X GET \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  'https://<your_company>.manage.iotium.io/api/v2/pki?assigned=false' \
  |  jq '.results | .[]' | jq '{hardware_serial_number: .id}'

The response includes all the available (not already provisioned) hardware serial numbers for your organization:

{
  "hardware_serial_number": "<your_serial_number_1>"
}
{
  "hardware_serial_number": "<your_serial_number_2>"
}

Add an Edge Node

To add an Edge Node to the Secure Edge Portal, make the following POST request with the request body parameters:

curl -X POST \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"name":"<your_edge_inode_name>", \
       "profile_id":"<your_edge_profile_id>", \
       "hardware_serial_number":"<your_serial_number_1>", \
       "ssh_keys":["<your_ssh_key_id>"]}' \
  'https://<your_company>.manage.iotium.io/api/v1/node' \
  | jq '{node_id: .id, name: .name}'

The response includes the name and ID of the Edge Node added to the Secure Edge Portal:

{
  "node_id": "<your_edge_inode_id>",
  "name": "<your_edge_inode_name>"
}

Add the local network to be protected by the Edge Node

To add the local network to be protected by this Edge Node, make the following POST request with the request body parameters:

curl -X POST \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"name":"<your_edge_inode_network_name>", \
       "cidr":"192.168.0.0/28", \
       "reserved":{"start":"192.168.0.1", "end":"192.168.0.14"}, \
       "interface":"eth1", \
       "network_type":"STATIC", \
       "node_id":"<your_edge_inode_id>"}' \
  'https://<your_company>.manage.iotium.io/api/v1/network' \
  | jq '{id:.id, config:.config}'

The response includes the ID and the configured settings of the local network:

{
  "id": "<your_edge_inode_network_id>",
  "config": {
    "network": {
      "cidr": "192.168.0.0/28",
      "netmask": "255.255.255.240",
      "gateway": "192.168.0.1",
      "reserved": [
        {
          "start": "192.168.0.1",
          "end": "192.168.0.14"
        }
      ],
      "vlan_id": 0,
      "service_addressing": "AUTO"
    }
  }
}

Set the default destination for local network to Edge Node's WAN network

Any traffic from the local network with a destination outside the local network (for example,
traffic going to the internet or LAN) is sent to the default destination. The default destination is not set by default, which results in dropping the traffic. You can set the default destination to the IP address of a gateway in the local network, or the Edge iNode's WAN network, which sends the traffic through the node uplink.

Before setting the default destination to the Edge Node's WAN network, you have to get the ID of the WAN network. To get the list of all networks in the Edge Node, make the following GET request with the query string parameters:

curl -X GET \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  'https://<your_company>.manage.iotium.io/api/v2/network?node_id=<your_edge_inode_id>' \
  | jq '.results | .[]' | jq '{net_id:.id, name: .name}'

The response includes the name and ID of all networks in the Edge Node:

{
  "net_id": "<your_edge_inode_network_id>",
  "name": "<your_edge_inode_network_name>"
}
{
  "net_id": "<your_edge_wan_network_id>",
  "name": "WAN Network"
}

To set the default destination to the Edge Node'€™s WAN network, make the following PUT request with the request body parameters:

curl -X PUT \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"routes":[{"destination":"0.0.0.0/0","via":"<your_edge_wan_network_id>"}]}' \
  'https://<your_company>.manage.iotium.io/api/v1/network/<your_edge_inode_network_id>' \
  | jq '{default_destination: .routes}'

The response includes the route setting for the default destination:

{
  "default_destination": [
    {
      "dest": "0.0.0.0/0",
      "via": "<your_edge_wan_network_id>"
    }
  ]
}

Provision a Cloud Connector

Use this section to provision and add a Cloud Connector (formerly Virtual iNode).

Adding a Cloud Connector

To add a Cloud Connector  to the Secure Edge Portal, make the following POST request with the request body parameters:

curl -X POST \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  -d '{"name":"<your_virtual_inode_name>", \
       "profile_id":"<your_virtual_profile_id>"}' \
  'https://<your_company>.manage.iotium.io/api/v1/node' \
  | jq '{node_id: .id, name: .name, networks: .networks}'

The response includes the name and ID of the Cloud Connector, and name and ID of all the networks in the Cloud Connector:

{
  "node_id": "<your_virtual_inode_id>",
  "name": "<your_virtual_inode_name>",
  "networks": [
    {
      "id": "<your_virtual_wan_network_id>",
      "name": "WAN Network"
    },
    {
      "id": "<your_virtual_default_network_id>",
      "name": "default"
    }
  ]
}

Download Cloud Connector security credentials

To complete provisioning the Cloud Connector, download its security credentials, which you’ll need when you launch the Cloud Connector. To download the security credentials, make the following GET request with the query string parameters:

curl -X GET \
  -H 'X-API-KEY:<your_api_key>' \
  -H "Content-type:application/json" \
  'https://<your_company>.manage.iotium.io/api/v1/node/<your_virtual_inode_id>/download' \
  -o "<your_virtual_inode_security_credentials_file>"

The response is the security credentials, written to the specified credentials file.