Snowball Edge クライアントの設定と使用

Snowball Edge クライアントは、Snowball Edge または Snowball Edge のクラスターを操作するためにAWS使用できる のコマンドラインインターフェイス (CLI) ツールです。クライアントを使用して、Snowball Edge またはデバイスのクラスターのロック解除、Snowball Edge のセットアップ、デバイスでのサービスの起動と停止、デバイスとの間でのデータ転送を行うことができます。Snowball Edge クライアントは、Linux、macOS および Windows オペレーティングシステムで動作するコンピュータと互換性があります。

Snowball Edge クライアントのダウンロードとインストール

Snowball Edge クライアントは「AWS Snowball Edgeリソース」からダウンロードできます。そのページに、お使いのオペレーティングシステムに適したインストールパッケージが用意されています。

以下の手順に従って、クライアントをインストールして設定します。

Snowball Edge クライアント用プロファイルの設定

Snowball Edge クライアントのコマンドを実行するたびに、Snowball Edge のマニフェストファイル、ロック解除コード、IP アドレスを指定します。コマンドを実行するたびにこれらを指定する代わりに、 configure コマンドを使用して、マニフェストファイル、29 文字のロック解除コード、エンドポイント (Snowball Edge の IP アドレス) へのパスをプロファイルとして保存できます。設定後、コマンドにプロファイル名を含めることで、コマンドごとにこれらの値を手動で入力することなく Snowball Edge クライアントのコマンドを使用できます。Snowball Edge クライアントの設定後、その情報はプレーンテキストの JSON 形式で home directory/.aws/snowball/config/snowball-edge.config に保存されます。このファイルを作成できるように環境が設定されていることを確認してください。

AWS OpsHubを使用してプロファイルを作成することもできます。で作成されたプロファイルAWS OpsHubは Snowball Edge クライアントで使用でき、 で作成されたプロファイルAWS OpsHubは Snowball Edge クライアントで使用できます。詳細については、「Managing profiles」を参照してください。

プロファイルを使用するには、コマンド構文の--profile profile-name後に を含めます。

複数のスタンドアロン Snowball Edge を使用している場合は、それぞれにプロファイルを作成できます。別のプロファイルを作成するには、configure コマンドを再度実行し、--profile パラメータに別の値を指定し、別のデバイスの情報を指定します。

{"version":1,"profiles":
    {
    "SnowDevice1profile":
        {
            "name":"SnowDevice1profile",
            "jobId":"JID12345678-136f-45b4-b5c2-847db8adc749",
            "unlockCode":"db223-12345-dbe46-44557-c7cc2",
            "manifestPath":"C:\\Users\\Administrator\\.aws\\ops-hub\\manifest\\JID12345678-136f-45b4-b5c2-847db8adc749_manifest-1670622989203.bin",
            "defaultEndpoint":"https://10.16.0.1",
            "isCluster":false,
            "deviceIps":[]
        },
    },
    "SnowDevice2profile":
    {
        "name":"SnowDevice2profile",
        "jobId":"JID12345678-fdb2-436a-a4ff-7c510dec1bae",
        "unlockCode":"b893b-54321-0f65c-6c5e1-7f748",
        "manifestPath":"C:\\Users\\Administrator\\.aws\\ops-hub\\manifest\\JID12345678-fdb2-436a-a4ff-7c510dec1bae_manifest-1670623746908.bin",
        "defaultEndpoint":"https://10.16.0.2",
        "isCluster":false,
        "deviceIps":[]
    },
    "SnowDevice3profile":
    {
        "name":"SnowDevice3profile",
        "jobId":"JID12345678-c384-4a5e-becd-ab5f38888463",
        "unlockCode":"64c89-13524-4d054-13d93-c1b80",
        "manifestPath":"C:\\Users\\Administrator\\.aws\\ops-hub\\manifest\\JID12345678-c384-4a5e-becd-ab5f38888463_manifest-1670623999136.bin",
        "defaultEndpoint":"https://10.16.0.3",
        "isCluster":false,
        "deviceIps":[]
    }
}
                        

プロファイルを編集または削除するには、テキストエディタでプロファイルファイルを編集します。

Snowball Edge クライアントバージョンの検索

version コマンドを使用して、Snowball Edge コマンドラインインターフェイス (CLI) クライアントのバージョンを確認します。

使用方法

    snowballEdge version                
            

出力例

    Snowball Edge client version: 1.2.0  Build 661                
            

Snowball Edge の認証情報の取得

snowballEdge list-access-keys および snowballEdge get-secret-access-key コマンドを使用して、AWS アカウント Snowball Edge 上の の管理者ユーザーの認証情報を取得できます。これらの認証情報を使用して、AWS Identity and Access Management(IAM ユーザー) とロールを作成し、AWS CLIまたはAWS SDK で を使用するときにリクエストを認証できます。これらの認証情報は、Snowball Edge の個々のジョブにのみ関連付けられ、デバイスまたはデバイスのクラスターでのみ使用できます。デバイスには、AWS クラウドの IAM アクセス許可はありません。

使用法 (Snowball Edge クライアント設定済み)

snowballEdge list-access-keys

{
  "AccessKeyIds" : [ "AKIAIOSFODNN7EXAMPLE" ]
}

使用法 (Snowball Edge クライアント設定済み)

snowballEdge get-secret-access-key --access-key-id Access Key

[snowballEdge]
aws_access_key_id = AKIAIOSFODNN7EXAMPLE
aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Snowball Edge でサービスを開始する

Snowball Edge デバイスは複数のサービスをサポートします。これには、コンピューティングインスタンス、ネットワークファイルシステム (NFS) インターフェイス、Snowball Edge Device Management、および が含まれますAWS IoT Greengrass。Amazon S3 アダプターサービス、Amazon EC2 AWS STS、IAM はデフォルトで開始され、停止または再起動することはできません。ただし、NFS インターフェイス、Snowball Edge Device Management、および は、 start-service コマンドでサービス ID を使用して開始AWS IoT Greengrassできます。各サービスのサービス ID を取得するには、list-services コマンドを使用できます。

このコマンドを実行する前に、1 つの仮想ネットワークインターフェイスを作成して、開始するサービスに結合します。詳細については、「Snowball Edge での仮想ネットワークインターフェイスの作成」を参照してください。

snowballEdge start-service --service-id service_id --virtual-network-interface-arns virtual-network-interface-arn --profile profile-name

Starting the AWS service on your Snowball Edge. You can determine the status of the AWS service using the describe-service command.

Snowball Edge でのサービスの停止

Snowball Edge で実行されているサービスを停止するには、 stop-service コマンドを使用できます。

Amazon S3 アダプター、Amazon EC2 AWS STS、IAM サービスは停止できません。

snowballEdge stop-service --service-id service_id --profile profile-name

Stopping the AWS service on your Snowball Edge. You can determine the status of the AWS service using the describe-service command.

Snowball Edge からのログの表示とダウンロード

オンプレミスのデータセンターと Snowball Edge 間でデータを転送すると、自動的にログが生成されます。デバイスへのデータ転送中に予期しないエラーが発生した場合は、次のコマンドを使用してログのコピーをローカルサーバーに保存できます。

ログに関連するコマンドは、以下の 3 つです。

Snowball Edge のステータスの表示

describe-device コマンドを使用して、Snowball Edge のステータスと一般的な状態を判断できます。

snowballEdge describe-device --profile profile-name

                            {
  "DeviceId": "JID-EXAMPLE12345-123-456-7-890",
  "UnlockStatus": {
    "State": "UNLOCKED"
  },
  "ActiveNetworkInterface": {
    "IpAddress": "192.0.2.0"
  },
  "PhysicalNetworkInterfaces": [
    {
      "PhysicalNetworkInterfaceId": "s.ni-EXAMPLEd9ecbf03e3",
      "PhysicalConnectorType": "RJ45",
      "IpAddressAssignment": "STATIC",
      "IpAddress": "0.0.0.0",
      "Netmask": "0.0.0.0",
      "DefaultGateway": "192.0.2.1",
      "MacAddress": "EX:AM:PL:E0:12:34"
    },
    {
      "PhysicalNetworkInterfaceId": "s.ni-EXAMPLE4c3840068f",
      "PhysicalConnectorType": "QSFP",
      "IpAddressAssignment": "STATIC",
      "IpAddress": "0.0.0.0",
      "Netmask": "0.0.0.0",
      "DefaultGateway": "192.0.2.2",
      "MacAddress": "EX:AM:PL:E0:56:78"
    },
    {
      "PhysicalNetworkInterfaceId": "s.ni-EXAMPLE0a3a6499fd",
      "PhysicalConnectorType": "SFP_PLUS",
      "IpAddressAssignment": "DHCP",
      "IpAddress": "192.168.1.231",
      "Netmask": "255.255.255.0",
      "DefaultGateway": "192.0.2.3",
      "MacAddress": "EX:AM:PL:E0:90:12"
    }
  ]
}

Snowball Edge で実行されているサービスのステータスの表示

describe-serviceコマンドを使用して、Snowball Edge デバイスで実行中のサービスのステータスと全般的なヘルスを判断できます。最初に list-services コマンドを実行して、実行中のサービスを確認します。

Snowball Edge の機能のステータスの表示

Snowball Edge で使用できる機能のステータスを一覧表示するには、 describe-features コマンドを使用します。

RemoteManagementState は Snowball Edge Device Management のステータスを示し、次のいずれかの状態を返します。

使用方法

snowballEdge describe-features --profile profile-name

{
  "RemoteManagementState" : String
}
            

Snowball Edge のタイムサーバーの設定

Snowball Edge クライアントのコマンドを使用して、現在の Network Time Protocol (NTP) 設定を表示し、時間を提供するサーバーまたはピアを選択できます。Snowball Edge クライアントのコマンドは、デバイスがロック状態とロック解除状態の両方の場合に使用できます。

セキュリティで保護された NTP タイムサーバーは、お客様が用意する必要があります。デバイスを接続する NTP タイムサーバーを設定するには、update-time-servers コマンドを使用します。

Snowball Edge の時間ソースの確認

デバイスが現在接続されている NTP タイムソースを確認するには、describe-time-sources コマンドを使用します。

snowballEdge describe-time-sources --profile profile-name

{
  "Sources" : [ {
    "Address" : "172.31.2.71",
    "State" : "LOST",
    "Type" : "PEER",
    "Stratum" : 10
  }, {
    "Address" : "172.31.3.203",
    "State" : "LOST",
    "Type" : "PEER",
    "Stratum" : 10
  }, {
    "Address" : "172.31.0.178",
    "State" : "LOST",
    "Type" : "PEER",
    "Stratum" : 10
  }, {
    "Address" : "172.31.3.178",
    "State" : "LOST",
    "Type" : "PEER",
    "Stratum" : 10
  }, {
    "Address" : "216.239.35.12",
    "State" : "CURRENT",
    "Type" : "SERVER",
    "Stratum" : 1
  } ]
}

describe-time-sources コマンドは、タイムソースの状態のリストを返します。ソース状態は、毎回、Address、State、Type、Stratum フィールドを含みます。これらのフィールドの意味は以下のとおりです。

NTP タイムソースは、サーバーまたはピアのいずれかになります。サーバーは update-time-servers コマンドを使用してユーザーが設定できますが、ピアはクラスター内の他の Snowball Edge デバイスにのみ設定できます。出力例では、 describe-time-sources は 5 のクラスターにある Snowball Edge で呼び出されます。出力には、4 つのピアと 1 台のサーバーが含まれます。ピアの階層は 10 で、サーバーの階層は 1 であるため、サーバーが現在のタイムソースとして選択されます。

タイムサーバーの更新

update-time-servers コマンドとタイムサーバーアドレスを使用して、NTP に NTP サーバーまたはピアを使用するように Snowball Edge を設定します。

snowballEdge update-time-servers time-server-address --profile profile-name

Updating time servers now.

Snowball Edge NFC タグを検証するための QR コードの取得

このコマンドを使用して、AWS Snowball Edgeの検証アプリケーションで使用するデバイス固有の QR コードを生成することができます。NFC 検証の詳細は、NFC タグの検証 を参照してください。

使用方法

snowballEdge get-app-qr-code --output-file ~/downloads/snowball-qr-code.png --profile profile-name

QR code is saved to ~/downloads/snowball-qr-code.png

MTU サイズの更新

update-mtu-size コマンドを使用して、Snowball Edge デバイスの物理インターフェイスの最大送信単位 (MTU) のバイト単位のサイズを変更します。この物理ネットワークインターフェイスに関連付けられたすべての仮想ネットワークインターフェイスとダイレクトネットワークインターフェイスは、同じ MTU サイズで設定されます。

describe-device コマンドを使用して、物理ネットワークインターフェイス ID とインターフェイスの現在の MTU サイズを取得できます。詳細については、「Snowball Edge のステータスの表示」を参照してください。

descibe-direct-network-interface および describe-virtual-network-interface コマンドを使用して、インターフェイスの現在の MTU サイズを取得できます。

使用方法

snowballEdge update-mtu-size --physical-network-interface-id physical-network-interface-id --mtu-size size-in-bytes --profile profile-name

{
    "PhysicalNetworkInterface": {
        "PhysicalNetworkInterfaceId": "s.ni-8c1f891d7f5b87cfe",
        "PhysicalConnectorType": "SFP_PLUS",
        "IpAddressAssignment": "DHCP",
        "IpAddress": "192.0.2.0",
        "Netmask": "255.255.255.0",
        "DefaultGateway": "192.0.2.255",
        "MacAddress": "8A:2r:5G:9p:6Q:4s",
        "MtuSize": "5743"
    }
}