デバイスの作成

前提条件
認証- OAuth2認証のためにユーザー資格情報、クライアントID、およびクライアントシークレットを送信する。認証情報を検証および認証するためにOAuth APIを呼び出す方法については、API認証を参照。
ステップ2:デバイスの詳細を取得する
-
NEプラットフォームで起動する自己設定デバイス(ルータやファイアウォールなど)を検索するには、Get Device Typesを呼び出す。仮想デバイスが利用可能な都市圏、デバイスのベンダー、利用可能なコア数、ソフトウェアパッケージとそのバージョンについて学習する。
deviceTypeCode、metroCode、core、、packageCodeおよびを選択する。version -
Get Allowed Interfacesを呼び出して、選択したコアに許可されているインターフェイス数を確認する。使用可能な任意のデバイスインターフェイスをとして選択できる。
sshInterfaceIdそうでない場合、Equinixは最初に利用可能なインターフェイスを選択する。 -
Get Accounts {metro}を呼び出して、
accountReferenceId仮想デバイスが必要なメトロのアカウント番号(または)とステータスを確認する。課金上の理由から、仮想デバイスが必要なメトロ内のアカウント(アクティブまたは保留中の状態)が必要である。アカウントをお持ちでない場合は、アカウントを作成する。
販売店がお客様用のデバイスを作成しようとしている場合は、お客様のアカウントと(販売店の)アカウントの両方が「アクティブ」または「保留中」のステータスになっていることを確認する必要がある。アカウントには請求が発生するが、お客様用のデバイスを作成するには、お客様のアカウント番号をAPIに送信する必要がある。
ステップ3:ライセンスオプション
ほとんどのデバイスのライセンスオプションとして、BYOL (Bring Your Own Licensing)を提供している。ベンダーが提供するライセンスファイルまたはコード/トークン/IDをアップロードする。Cisco 8000Vでは、サブスクリプションライセンスオプションがある。
-
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/デバイス | |
|---|---|
| 方法 | POST |
| URLまたはエンドポイント | /ne/v1/devices |
| ヘッダー | Authorizationトークン、Content-Type |
| クエリーパラメータ | draft、draftUuid |
プライマリ・デバイスとセカンダリ・デバイスを持つ冗長デバイスを作成する:
- セカンダリーオブジェクトのパラメータを設定する
- リセラーが顧客用に冗長デバイスを作成しようとしている場合は、プライマリメトロとセカンダリメトロの両方が同じ国にあることを確認する。プライマリアカウント番号とセカンダリアカウント番号の両方が同じであること。リセラーのアカウントには請求が行われるが、このAPIはお客様のアカウント番号を受け入れて、お客様用のデバイスを作成する。各顧客がリセラーの請求先アカウントに関連付けられているため、上記の制限が必要である。
- Cisco FTDデバイスの場合、プライマリデバイスとセカンダリデバイスの管理タイプは同じでなければなりません。
仮想デバイスを作成することで、注文条件に同意したことになる。注文条件の取得に電話して詳細を確認する。「自己構成エッジデバイスの作成」をチェックして、ビジネスの詳細を理解する。
デバイスドラフトを保存するには、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": "23.2R1.13",
"interfaceCount": 8,
"deviceManagementType": "SELF-CONFIGURED",
"core": 2,
"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-001-SROY - primary",
"notifications": [
"test@equinix.com"
],
"hostNamePrefix": "TC01",
"aclDetails": [
{
"uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",
"interfaceType": "WAN"
}
],
"accountNumber": "201148",
"version": "17.06.06a",
"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-002-SROY - secondary",
"additionalBandwidth": "100",
"aclDetails": [
{
"uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",
"interfaceType": "WAN"
}
],
"accountNumber": "201148",
"sshInterfaceId": "4"
}
}
'
インターネットにアクセスできない 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": "DC",
"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": "DC",
"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}を呼び出して、デバイスのステータスを監視します。クラウドサービスプロバイダに接続する前に、デバイスがプロビジョニングされ、ライセンスが登録されている必要があります。
| 仮想デバイスの「ステータス」 | 会社概要 |
|---|---|
INITIALIZING | エクイニクスは現在、リソースの予約とデバイスの作成を進めています。 |
PROVISIONING | デバイスが起動している。 |
PENDING_ORDER | 注文はSiebelからNEに来ています。顧客はNEポータルにログインし、注文を送信する必要があります。 |
PENDING_SIGNATURE | 顧客はNE規約のオフライン承諾にサインアップしたが、まだ規約を承諾していない。 |
CANCEL_ORDER | シーベルからNEへの注文はキャンセルされる。 |
WAITING_FOR_PRIMARY | セカンダリデバイスは準備できているが、プライマリデバイスは準備できていない。この状態は、冗長化のためにセカンダリーデバイスを作成した場合にのみ表示される。 |
WAITING_FOR_SECONDARY | プライマリデバイスの準備はできているが、セカンダリデバイスの準備はできていない。この状態は、冗長化のためにセカンダリーデバイスを作成した場合にのみ表示される。 |
FAILED | デバイスの作成に失敗しました。 |
PROVISIONED | デバイスは準備できている。 |

エンドユーザーが仮想デバイスの削除 APIを使用してデバイスを削除すると、エクイニクスインフラストラクチャ内でデバイスは次の状態に遷移します。
| ne/v1/devices/{uuid}配下の仮想デバイス "status" | 商品説明 |
|---|---|
| プロビジョニング解除 | エクイニクスはお客様からの仮想デバイスの削除リクエストを受け入れました。 |
| プロビジョニング解除 | デバイスはプロビジョニング解除/削除される。 |