デバイスの作成

必須条件

Authenticate - OAuth2認証のためのユーザー認証情報、クライアントID、クライアントシークレットを送信します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API Authenticationを参照してください。

ステップ2：デバイスの詳細を取得する

デバイスタイプの取得を呼び出して、NE プラットフォームで起動したい自己設定デバイス（ルーターやファイアウォールなど）を調べます。仮想デバイスが利用可能なメトロ地域、デバイスのベンダー、利用可能なコア数、ソフトウェアパッケージとそのバージョンを知ることができます。deviceTypeCode、metroCode、core、packageCode、version` を選択します。
Get Allowed Interfacesを呼び出して、選択したコアの許容インターフェース数を調べます。sshInterfaceId`として利用可能なデバイスインターフェースを選択できます。それ以外の場合、エクイニクスは最初に利用可能なインターフェースを選択します。
Get Accounts {metro}を呼び出して、仮想デバイスが必要なメトロのアカウント番号(または acountReferenceId)とステータスを確認します。課金の都合上、仮想デバイスを利用したいメトロのアカウントが「有効」または「保留」の状態である必要があります。アカウントをお持ちでない場合は、[アカウントを作成してください。

リセラー 顧客のためにデバイスを作成しようとしている場合、顧客とあなた（リセラー）のアカウントの両方がアクティブまたは保留状態であることを確認する必要があります。あなたのアカウントは課金されますが、顧客用のデバイスを作成するには、顧客のアカウント番号を API に送信する必要があります。

ステップ3：ライセンスオプション

当社は、ほとんどのデバイスに対してBYOL (Bring Your Own Licensing) ライセンスオプションを提供しています。ライセンスファイルまたはコード/トークン/IDをアップロードします。Cisco 8KVの場合は、サブスクリプションライセンスオプションがあります。

Aristaです：Aristaデバイスのライセンスのアップロードはサポートしていません。ただし、スループットを向上させるために、デバイス作成後にデバイスにログインしてライセンスをアップロードすることは可能です。
Cisco と Palo Alto はライセンストークンを提供します。ライセンストークンを licenseToken フィールドに入力します。
Juniperはライセンスファイルを提供します。JuniperデバイスのBYOL（Bring Your Own License）には、Post License Fileを使用してライセンスファイルをアップロードします。仮想デバイスの作成に使用できるファイルIDが取得されます。Juniper デバイスを冗長化している場合は、プライマリデバイスとセカンダリデバイスの両方に同じ fileId を使用できます。
Fortinet：Fortinetのデバイスでは、デバイス作成時にライセンスは必須ではありません。トークンをお持ちの場合は、licenseTokenフィールドに入力してください。Fortinetデバイスにライセンスファイルを設定するには、次の手順を実行する必要があります：
- Fortinetポータルでライセンスファイルを生成します。
- ライセンスファイルの投稿を呼び出して、エクイニクスポータルでライセンスファイルをアップロードします。仮想デバイスの作成に使用できる fileId が取得できます。
- ライセンスステータスを確認するには、デバイスにログインしてください。

ステップ4：自己設定デバイスの作成

	POST /ne/v1/devices
Method	`POST`
URL or End Point	`/ne/v1/devices`
Headers	`Authorization` token, `Content-Type`
Query Parameters	`draft`, `draftUuid`

プライマリデバイスとセカンダリデバイスを持つ冗長デバイスを作成する：

セカンダリーオブジェクトのパラメータを設定する
リセラー 顧客のために冗長デバイスを作成しようとしている場合は、プライマリとセカンダリの両方のメトロが同じ国にあることを確認してください。プライマリとセカンダリのアカウント番号は同じでなければなりません。リセラーのアカウントは課金されますが、このAPIは顧客のデバイスを作成するために顧客のアカウント番号を受け入れます。各顧客はリセラーの請求アカウントに関連付けられているため、上記の制限が必要です。
Cisco FTDデバイスの場合、プライマリデバイスとセカンダリデバイスの管理タイプは同じでなければなりません。

メモ

仮想デバイスを作成することで、注文規約に同意したことになります。詳細を確認するには、Get Order Terms を呼び出します。ビジネスの詳細を理解するには、自己構成Edgeデバイスの作成を確認してください。

デバイスドラフトを保存するには、deviceTypeCode、accountNumber または accountReferenceId、metroCode を提供する必要があります。

リクエスト例

単一のデバイスを作成するためのcurlリクエストのサンプル。

curl -X  
POST "https://api.equinix.com/ne/v1/devices?draft=false"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '  
{  
    "metroCode": "SV",  
    "deviceTypeCode": "VSRX",  
    "agreeOrderTerms": true,  
    "termLength": "1",  
    "licenseMode": "BYOL",  
    "packageCode": "STD",  
    "virtualDeviceName": "Test-device-001-SROY",  
    "notifications": [  
        "test@equinix.com"  
    ],  
    "hostNamePrefix": "TC12",  
    "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
    "accountNumber": "200541",  
    "version": "18.4R2-S1.4",  
    "interfaceCount": 10,  
    "deviceManagementType": "SELF-CONFIGURED",  
    "core": 5,  
    "userPublicKey": {  
        "username": "userName",  
        "keyName": "keyName"  
    },  
    "additionalBandwidth": "100"  
}  
'

冗長デバイスを作成するためのcurlリクエストのサンプル。

curl -X  
POST "https://api.equinix.com/ne/v1/devices?draft=false"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '  
{  
    "metroCode": "DC",  
    "deviceTypeCode": "C8000V",  
    "agreeOrderTerms": true,  
    "termLength": "1",  
    "licenseMode": "BYOL",  
    "packageCode": "network-advantage",  
    "virtualDeviceName": "Test-device-002-SROY",  
    "notifications": [  
        "test@equinix.com"  
    ],  
    "hostNamePrefix": "TC01",  
        "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
    "accountNumber": "201148",  
    "version": "17.06.01a",  
    "interfaceCount": 10,  
    "deviceManagementType": "SELF-CONFIGURED",  
    "core": 2,  
    "userPublicKey": {  
        "username": "sroy",  
        "keyName": "keyWIQzB"  
    },  
    "sshInterfaceId": "3",  
    "channelPartner": "SDCI",  
    "secondary": {  
        "metroCode": "DC",  
        "hostNamePrefix": "TC02",  
        "notifications": [  
            "test@equinix.com"  
        ],  
        "virtualDeviceName": "Test-device-001-SROY - secondary",  
        "additionalBandwidth": "100",  
            "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
        "accountNumber": "201148",  
        "sshInterfaceId": "4"  
    },  
    "additionalBandwidth": "100"  
}  
'

インターネットにアクセスできない Cisco FTD セカンダリデバイスを作成するためのサンプル curl リクエスト。

curl -X  
POST "https://api.equinix.com/ne/v1/devices?draft=false"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '  
{  
    "deviceTypeCode": "Cisco_NGFW",  
    "licenseMode": "BYOL",  
    "packageCode": "FTDv5",  
    "virtualDeviceName": "NEAut-",  
    "metroCode": "#(supportedMetro)",  
    "notifications": [  
        "t@t.com"  
    ],  
    "hostNamePrefix": "test",  
    "interfaceCount": 10,  
    "deviceManagementType": "SELF-CONFIGURED",  
    "core": 4,  
    "version": "7.0.4-55",  
    "vendorConfig": {  
        "managementType": "FDM"  
    },  
    "connectivity": "PRIVATE",  
    "secondary": {  
        "hostNamePrefix": "test-123",  
        "metroCode": "#(supportedMetroForSec)",  
        "notifications": [  
            "t@t.com"  
        ],  
        "virtualDeviceName": "test-secondary",  
        "vendorConfig": {  
            "managementType": "FDM"  
        }  
    }  
}  
'

パラメータとオプションの完全なリストについては、API リファレンスを参照してください。

回答例

単一デバイスの応答例。202:リクエストを受け付けました。

{  
    "uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec"  
}

冗長デバイスの応答例。202:リクエストを受け付けました。

{  
    "uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",  
    "secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"  
}

デバイスステータス

Get Virtual Device {uuid}を呼び出して、デバイスのステータスを監視します。クラウドサービスプロバイダに接続する前に、デバイスがプロビジョニングされ、ライセンスが登録されている必要があります。

Virtual device "status"	Description
`INITIALIZING`	Equinix is in the process of reserving resources and creating the device.
`PROVISIONING`	The device is booting.
`PENDING_ORDER`	The order has come to NE from Siebel. Customers need to log in to the NE portal and submit the order.
`PENDING_SIGNATURE`	The customer has signed up for the offline acceptance of NE terms but has not yet accepted the terms.
`CANCEL_ORDER`	The order from Siebel to NE is canceled.
`WAITING_FOR_PRIMARY`	The secondary device is ready but the primary is not. This state might appear only if you have created a secondary device for redundancy.
`WAITING_FOR_SECONDARY`	The primary device is ready but the secondary is not. This state might appear only if you have created a secondary device for redundancy.
`FAILED`	The device creation failed.
`PROVISIONED`	The device is ready.

エンドユーザーが仮想デバイスの削除 APIを使用してデバイスを削除すると、エクイニクスインフラストラクチャ内でデバイスは次の状態に遷移します。

Virtual device "status" under /ne/v1/devices/{uuid}	Description
DEPROVISIONING	Equinix accepted the customer's request to delete a virtual device.
DEPROVISIONED	The device is de-provisioned/deleted.

必須条件​

ステップ2：デバイスの詳細を取得する​

ステップ3：ライセンスオプション​

ステップ4：自己設定デバイスの作成​

リクエスト例​

回答例​

デバイスステータス​