iNodes bereitstellen

  • Updated on Aug 1, 2023
  • 7 minute(s) read
Prev Next

In den folgenden Abschnitten wird erläutert, wie Sie iNodes erstellen und hinzufügen.

IDs der iNode-Profile für Ihre Organisation erhalten

Beginnen Sie damit, die IDs der iNode-Profile für Ihre Organisation zu erhalten. Die ID des iNode-Profils ist ein erforderlicher Parameter für den API-Aufruf, um ein iNode bereitzustellen. Stellen Sie die folgende GET-Anfrage, um eine Liste mit den IDs der iNode-Profile für Ihre Organisation zu erhalten:

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}'

Die Antwort beinhaltet die IDs und Namen aller iNode-Profile für Ihre Organisation:

{
  "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"
}

Öffentlichen Schlüssel zu dem ioTium Orchestrator hinzufügen

Stellen Sie vor der Bereitstellung eines Edge iNode oder Virtual Edge iNode sicher, dass Sie über einen öffentlichen SSH-Schlüssel für den Zugriff auf die iNode-Konsole verfügen. (Sehen Sie sich Creating an SSH Public-Private Key Pair in unserem Handbuch an, falls Sie über kein SSH-Schlüsselpaar verfügen.)

Stellen Sie die folgende POST-Anfrage mit den Parametern des Anfrage-Bodys, um Ihren öffentlichen SSH-Schlüssel dem Secure Edge Portal hinzuzufügen:

NameTypeErforderlich oder OptionalBeschreibung

name

string

Erforderlich

Name Ihres SSH-Schlüssels.

public_key

string

Erforderlich

Inhalte der Datei mit Ihrem öffentlichen SSH-Schlüssel.

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}'

Die Antwort beinhaltet den Namen und die ID des dem Secure Edge Portal hinzugefügten SSH-Schlüssels:

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

Alle hinzugefügten öffentlichen Schlüssel für Ihre Organisation erhalten

Stellen Sie die folgende GET-Anfrage, um eine Liste mit allen dem Secure Edge Portal hinzugefügten SSH-Schlüsseln für Ihre Organisation zu erhalten:

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}'

Die Antwort beinhaltet die Namen und IDs aller SSH-Schlüssel für Ihre Organisation:

{
  "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>"
}

Edge iNode bereitstellen

In diesen Abschnitten wird erläutert, wie Sie Edge iNodes bereitstellen.

Verfügbare Hardware-Seriennummern für Ihre Organisation erhalten

Bevor Sie ein Edge iNode bereitstellen, stellen Sie sicher, dass die mit der Seriennummer auf Ihrem Edge iNode übereinstimmende Hardware-Seriennummer in Ihrem Secure-Edge-Portal-Konto verfügbar ist. Wir haben im Secure Edge Portal die Hardware-Seriennummern der Hardware-Geräte vorgegeben, die wir Ihnen bereitgestellt haben.

Stellen Sie die folgende GET-Anfrage mit den Query-String-Parametern, um eine Liste mit den verfügbaren Hardware-Seriennummern für Ihre Organisation zu erhalten:

NameTypeErforderlich oder OptionalBeschreibung

assigned

boolean

Optional

Legen Sie false fest, um nur die verfügbaren (d. h. die noch nicht bereitgestellten) Seriennummern zu erhalten.

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}'

Die Antwort beinhaltet alle verfügbaren (d. h. die noch nicht bereitgestellten) Hardware-Seriennummern für Ihre Organisation:

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

Edge iNode hinzufügen

Stellen Sie die folgende POST-Anfrage mit den Parametern des Anfrage-Bodys, um ein Edge iNode dem Secure Edge Portal hinzuzufügen:

NameTypeErforderlich oder OptionalBeschreibung

name

string

Erforderlich

Name Ihres Edge iNode.

profile_id

string

Erforderlich

ID Ihres Edge-iNode-Profils.

hardware_serial_number

string

Erforderlich

Die mit der Nummer auf dem Etikett Ihres Hardwäre-Geräts übereinstimmende Seriennummer.

ssh_keys

Array

Erforderlich

IDs der SSH-Schlüssel, die Sie dem iNode zuweisen möchten.

metadata

objekt

Optional

Bestimmte, als Bezeichner festlegte Attribute.

max_headless_time

Integer

Optional

Verfallszeit des eigenständigen Modus. Legen Sie „0“ (Standard) fest, um den eigenständigen Modus zu deaktivieren; jeder andere Wert aktiviert den eigenständigen Modus. Die maximale Verfallszeit beträgt 365 Tage. Sehen Sie sich Using Standalone Mode in unserem Handbuch an.

stat_mode

string

Optional

Standardmäßig werden die Metriken zur System- und Container-Ressourcenauslastung von dem iNode minütlich an das Secure Edge Portal übermittelt. Dies ist die Einstellung FAST (Standard). Sie können sie als SLOW (fünf Minuten) oder OFF festlegen. Sehen Sie sich Using Data Saving Mode in unserem Handbuch an.

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}'

Die Antwort beinhaltet den Namen und die ID des dem ioTium Orchestrator hinzugefügten Edge iNode:

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

Das lokale Netzwerk hinzufügen, das von diesem Edge iNode geschützt werden soll

Stellen Sie die folgende POST-Anfrage mit den Parametern des Anfrage-Bodys, um das lokale Netzwerk hinzufügen, das von diesem Edge iNode geschützt werden soll:

NameTypeErforderlich oder OptionalBeschreibung

name

string

Erforderlich

Name Ihres lokalen Netzwerks.

cidr

string

Erforderlich

Der IP-Adressbereich dieses lokalen Netzwerks in Form eines CIDR-Blocks.

In diesem Beispiel ist das CIDR des lokalen Netzwerks auf 192.168.0.0/28 festgelegt.

reserved

objekt

Erforderlich

Intern reservierter IP-Adressbereich – Bereich für die IP-Adressen (mindestens einer), der für die interne iNode-Nutzung reserviert wird. Diese IP-Adressen sollten Bestandteil desselben IP-Subnetzes wie das des CIDR des lokalen Netzwerks sein.

In diesem Beispiel ist der intern reservierte IP-Adressbereich auf 192.168.0.1 bis 192.168.0.14 festgelegt.

interface

string

Erforderlich

Mit diesem lokalen Netzwerk verbundene Schnittstelle, als eth1 festgelegt.

network_type

string

Erforderlich

Adresszuweisung für dieses Netzwerk, als STATISCH festgelegt. Die Hosts in diesem Netzwerk müssen manuell mit statischen IP-Adressen konfiguriert werden.

node_id

string

Erforderlich

ID des Edge iNode, das dieses lokale Netzwerk schützt.

metadata

objekt

Optional

Bestimmte, als Bezeichner festlegte Attribute.

gateway

string

Optional

IP-Adresse des Standard-Gateways in Ihrem lokalen Netzwerk. Falls Sie kein Standard-Gateway festlegen, wird die Start-IP-Adresse des intern reservierten IP-Adressbereichs als Standard-Gateway genutzt.

In diesem Beispiel ist des Standard-Gateway nicht festgelegt; daher wird 192.168.0.1 (die Start-IP-Adresse des intern reservierten IP-Adressbereichs) als Standard-Gateway genutzt.

service_addressing

string

Optional

Standardmäßig weist das Edge iNode IP-Adressen für Dienste in dem Netzwerk dynamisch aus dem von Ihnen festgelegten intern reservierten IP-Adressbereich zu. Dies ist die Einstellung AUTO (Standard). Sie können sie als MANUAL festlegen, falls Sie vorhaben, die Dienste manuell mit statischen IP-Adressen zu konfigurieren.

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}'

Die Antwort beinhaltet die ID und die konfigurierten Einstellungen des lokalen Netzwerks:

{
  "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"
    }
  }
}

WAN-Netzwerk des Edge iNode als Standardziel für das lokale Netzwerk festlegen

Datenverkehr, der aus dem lokalen Netzwerk an ein Ziel außerhalb des lokalen Netzwerks (beispielsweise Internet oder LAN)
gesendet wird, wird an das Standardziel gesendet. Das Standardziel ist nicht standardmäßig festgelegt. Dies führt zu Unterbrechungen des Datenverkehrs. Sie können die IP-Adresse eines Gateways in dem lokalen Netzwerk oder das WAN-Netzwerk des Edge iNode als Standardziel festlegen, das den Datenverkehr durch den iNode-Uplink sendet.

Bevor Sie das WAN-Netzwerk des Edge iNode als Standardziel festlegen, müssen Sie die ID des WAN-Netzwerks erhalten. Stellen Sie die folgende GET-Anfrage mit den Query-String-Parametern, um eine Liste mit allen Netzwerken auf dem Edge iNode zu erhalten:

NameTypeErforderlich oder OptionalBeschreibung

node_id

string

Optional

ID Ihres Edge-iNode.

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}'

Die Antwort beinhaltet den Namen und die ID aller Netzwerke des Edge iNode:

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

Stellen Sie die folgende PUT-Anfrage mit den Parametern des Anfrage-Bodys, um das WAN-Netzwerk des Edge iNode als Standardziel festzulegen:

NameTypeErforderlich oder OptionalBeschreibung

routes

Array

Erforderlich

Legen Sie über Ihre ID des WAN-Netzwerks des Edge iNode eine Route mit dem Ziel 0.0.0.0/0 fest.

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}'

Die Antwort beinhaltet die Routeneinstellung für das Standardziel:

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

Virtual iNode bereitstellen

In diesem Abschnitt wird erläutert, wie Sie ein Virtual iNode bereitstellen und hinzufügen.

Virtual iNode hinzufügen

Stellen Sie die folgende POST-Anfrage mit den Parametern des Anfrage-Bodys, um ein Virtual iNode dem Secure Edge Portal hinzuzufügen:

NameTypeErforderlich oder OptionalBeschreibung

name

string

Erforderlich

Name Ihres Virtual iNode.

profile_id

string

Erforderlich

ID Ihres Virtual-iNode-Profils.

metadata

objekt

Optional

Bestimmte, als Bezeichner festlegte Attribute.

stat_mode

string

Optional

Standardmäßig werden die Metriken zur System- und Container-Ressourcenauslastung von dem iNode minütlich an den ioTium Orchestrator übermittelt. Dies ist die Einstellung FAST (Standard). Sie können sie als SLOW (fünf Minuten) oder OFF festlegen.

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}'

Die Antwort beinhaltet den Namen und die ID des Virtual iNode und den Namen und die ID aller Netzwerke des Virtual iNode:

{
  "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"
    }
  ]
}

Sichere Anmeldedaten für das Virtual iNode herunterladen

Laden Sie die sicheren Anmeldedaten für das Virtual iNode herunter, die Sie für die Implementierung des Virtual iNode benötigen. Stellen Sie die folgende GET-Anfrage mit den Query-String-Parametern, um die sicheren Anmeldedaten zu erhalten:

NameTypeErforderlich oder OptionalBeschreibung

download_type

string

Optional

Format der Datei mit den sicheren Anmeldedaten für das Virtual iNode, die Sie herunterladen. Standardmäßig ist das Dateiformat yaml, genutzt von AWS und Azure. Legen Sie für VMware das Format iso fest.

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>"

Die Antort beinhaltet die sicheren Anmeldedaten, die in der speziellen Datei enthalten sind.

Die Datei mit den sicheren Anmeldedaten für das Virtual iNode kann nur einmal heruntergeladen werden. Speichern Sie diese an einem sicheren Speicherort und teilen Sie diese mit niemandem. Nach der Erstellung des Virtual iNode sollten Sie diese Datei mit den Anmeldedaten löschen.