SDWANデバイスの作成
必須条件
Authenticate - OAuth2認証のためのユーザー認証情報、クライアントID、クライアントシークレットを送信します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API Authenticationを参照してください。
ステップ2：デバイスの種類とアカウントの取得
Get Device Types API を呼び出して、NE プラットフォーム上で起動できる SD-WAN デバイスを見つけます。これらのデバイスが利用可能なメトロ（metroCode）、利用可能なコア数（core）、ソフトウェアパッケージ（packageCodeとversion）、可能な全てのライセンスとスループットオプションについて学ぶことができます。
欲しいデバイスがすでに決まっている場合は、このステップを飛ばしても構いません。
Get Accounts {metro} API を呼び出して、仮想デバイスが必要なメトロのアカウント番号 (または accountReferenceId) とステータスを確認します。課金上の理由から、仮想デバイスが必要なメトロで、Active または Pending 状態のアカウントが必要です。アカウントの作成方法については、[Billing Account Managementを参照してください。
リセラー 顧客のためにデバイスを作成しようとしている場合、顧客とあなた（リセラー）のアカウントの両方がアクティブまたは保留状態であることを確認する必要があります。あなたのアカウントは請求されますが、顧客用の SD-WAN デバイスを作成するには、顧客のアカウント番号を POST API に送信する必要があります。
アカウント番号（または accountReferenceId）とステータスが既に分かっている場合は、この手順を省略できます。
ステップ 3: ライセンスの設定
今のところ、BYOL (Bring Your Own License) が SD-WAN デバイスで利用可能な唯一のライセンスオプションであり、BYOL へのプロセスはベンダーごとに異なります。
Cisco SD-WANデバイスのライセンスを設定するには、次の手順を実行する必要があります：
- Cisco vManageプラットフォームでブートストラップファイルを生成します。
- C8000V-SDWAN を作成するには、Upload File を呼び出して Cisco ブートストラップファイルをアップロードします。レスポンスには
fileUuidが含まれます。この値を create ペイロードのday0TextFileIdフィールドに入力すると、仮想 C8000V-SDWAN デバイスを作成できます。
CloudGenixデバイスのライセンスを設定するには、以下の手順を実行する必要があります：
- CloudGenixプラットフォーム上でライセンスキー（IONキー）とライセンスシークレット（シークレットキー）を生成します。
- Equinix createに電話をかける際は、ライセンスキー（IONキー）とシークレットキー（Secretキー）を入力してください。 デバイス API を使用して CloudGenix SD-WAN デバイスを作成します。
Fortinetデバイスでは、デバイス作成時にライセンスは必須ではありません。トークンをお持ちの場合は、licenseTokenフィールドに入力してください。Fortinet SD-WANデバイスにライセンスファイルを設定するには、次の手順を実行します：
- Fortinetポータルでライセンスファイルを生成します。
- ライセンスファイルの投稿を呼び出して、エクイニクスポータルでライセンスファイルをアップロードします。仮想 SD-WAN デバイスを作成するために使用できる
fileIdが得られます。
Versaデバイスを構成するには、Versa directorでvNFデバイステンプレートを作成し、シリアル番号を控えてください。
Network Edge プラットフォームで Aruba デバイスを設定するためにライセンスファイルは必要ありません。
Juniper SD-WANのライセンスをアップロードするには、次の手順を実行する必要があります：
- Juniper ポータルでライセンスファイルを生成します。
- ライセンスファイルの投稿を呼び出して、エクイニクスポータルでライセンスファイルをアップロードします。Juniper SD-WAN デバイスを作成するために使用できる
fileIdが取得されます。
ステップ4：ベンダー固有のパラメータ
各SD-WANベンダーは、ステップ5のPOST API定義の一部としてリストされている共通パラメータ以外の独自のパラメータセットを必要とします。ご利用のベンダーのパラメータをご確認の上、[Step 5]で新規デバイスを作成する際に vendorConfig{} オブジェクトにパラメータを渡してください。
Cisco SD-WAN
| Cisco vendorConfig{ } parameters | Mandatory | Type | Example | Possible Values | Description |
|---|---|---|---|---|---|
| siteId | Yes | string | 12345 | Site Id. Mandatory for Cisco SD-WAN devices. A siteId is a particular physical location within the Viptela overlay network, such as a branch office, or a campus. | |
| systemIpAddress | Yes | string | 192.168.1.5 | System IP address. Mandatory for Cisco SD-WAN devices. Each vEdge router and vSmart controller is assigned a system IP address. It should be in decimal four-part dotted notation, just like IPv4 address. | |
| hostname | Conditional | string | SR-01 | hostname. Mandatory for C8000V-SDWAN. |
CloudGenix PRISMA-SDWAN
| CloudGenix vendorConfig{ } parameters | Mandatory | Type | Example | Possible Values | Description |
|---|---|---|---|---|---|
| licenseKey (ION key) | Yes | string | <license_key> | License key (ION key). Mandatory for CloudGenix devices. | |
| licenseSecret (Secret key) | Yes | string | ec68e425-f973-452e-a866-76be5844d0ba | License secret (Secret key). Mandatory for CloudGenix devices. |
Versa VERSA_SDWAN
| Versa vendorConfig{ } parameters | Mandatory | Type | Example | Possible Values | Description |
|---|---|---|---|---|---|
| localId | Yes | string | SDWAN-Branch@Versa.com | Email address of the branch location. | |
| remoteId | Yes | string | Controller-01-staging@Versa.com | Email address of the controller side. | |
| serialNumber | Yes | string | 12345 | The customer selects a serial number when setting up the device template on Versa director. Versa post-staging device serial number on Versa director should match this input. | |
| controller1 | Yes | string | 54.219.248.29 | Ip address of the SD-WAN controller1. | |
| controller2 | Yes | string | 54.177.220.115 | Ip address of the SD-WAN controller2. |
FortiGate FG-SDWAN *
| FortiGate vendorConfig{ } parameters | Mandatory | Type | Example | Possible Values | Description |
|---|---|---|---|---|---|
| adminPassword | Yes | string | ThisPassword9 | Password. This password should be at least 6 characters long and must include an uppercase letter and a number. | |
| controller1 | Yes | string | 1.1.1.1 | System IP address. Mandatory for FortiGate SD-WAN devices. |
*FortiGate SD-WANデバイスにもホスト名が必要ですが、これはvendorConfigオブジェクトの一部ではなく、deviceTypeCode、accountNumberなどのパラメータとして渡されます。
Arista VELOCLOUD-SDWAN
| Arista vendorConfig{ } parameters | Mandatory | Type | Example | Possible Values | Description |
|---|---|---|---|---|---|
| activationKey | Yes | string | GJUK-JM2X-59BJ-SAMPLE | Activation key. Available on the VeloCloud Orchestration Portal. | |
| controllerFqdn | Yes | string | demo.velocloud.net | VeloCloud SD-WAN Gateway. In the list of ACLs for the device, please provide the IP addresses associated with the controllerFqdn. | |
| rootPassword | No | string | TestPassword! | CLI password for the device. |
Aruba EDGECONNECT-SDWAN
| Aruba vendorConfig{ } parameters | Mandatory | Type | Example | Possible Values | Description |
|---|---|---|---|---|---|
| accountName | Yes | string | accountName | The name of the account. | |
| hostname | Yes | string | myhostname1 | Host name for identification. This gets included as FQDN and ensures the device is reachable from the approved sources. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14; Aruba 2-24. | |
| accountKey | Yes | string | accountKey | The account key. | |
| applianceTag | No | string | applianceTag | The appliance tag. |
ステップ5：SD-WANデバイスの作成
| POST /ne/v1/devices | |
|---|---|
| Method | POST |
| URL or End Point | /ne/v1/devices |
| Headers | Authorization, Content-Type |
| Query Parameters | draft, draftUuid |
プライマリとセカンダリの2つのデバイスを持つ冗長SD-WANデバイスを作成したい場合は、次のようにします：
-
オプションのセカンダリオブジェクトの
vendorConfigパラメータを設定します。- リクエストボディのペイロードにCisco SD-WANの2つのlicenseFileIdsをプロバイダする。
- CloudGenixの冗長化には、2つのライセンスキー（IONキー）とライセンスシークレット（シークレットキー）が必要です。 リクエストボディのペイロードのデバイス
- 冗長化されたArista VeloCloud SD-WANエッジ・デバイスのアクティベーション・キーを2つ用意します。
-
セカンダリデバイスでは、ACLテンプレート、アカウント番号、additionalBandwidth、metroCode、および通知が異なる場合があります。
-
リセラー 顧客のために冗長デバイスを作成しようとしている場合は、プライマリとセカンダリのメトロの両方が同じ国にあることを確認してください。また、プライマリとセカンダリのアカウント番号は同じでなければなりません。リセラーのアカウントは課金されますが、このAPIは顧客のアカウント番号を受け付け、顧客のデバイスを作成します。各顧客はリセラーの請求アカウントに関連付けられているため、上記の制限が必要です。
必要な情報がすべて揃っていない場合でも、情報を下書きとして保存することができます。 下書きを保存するには、deviceTypeCode、accountNumber/accountReferenceId、および metroCode を提供する必要があります。
仮想デバイスを作成することで、注文規約に同意したことになります。詳細を確認するには、Get Order Terms を呼び出してください。
サンプル請求
冗長 Cisco SD-WAN デバイスを作成するためのサンプル curl リクエスト。
curl -X POST
https://api.equinix.com/ne/v1/devices?draft=false
-H 'Authorization: Bearer <token>'
-H 'Content-Type: application/json'
-d '
{
"deviceTypeCode": "C8000V-SDWAN",
"projectId": "XXXXX",
"metroCode": "DC",
"termLength": "1",
"licenseMode": "BYOL",
"packageCode": "DNA",
"virtualDeviceName": "sroy-cisco-8v-controller",
"notifications": [
"test@equinix.com"
],
"version": "17.09.01a",
"interfaceCount": 10,
"deviceManagementType": "SELF-CONFIGURED",
"core": 4,
"vendorConfig": {
"systemIpAddress": "1.1.1.1",
"siteId": "4567",
"hostname": "SR-01"
},
"aclTemplateUuid": "3319e378-be2f-40e4-8e79-13ea2aed7a5f",
"day0TextFileId": "917f2621-11d4-468f-9a09-af8fd66c0e57",
"accountNumber": "201091",
"secondary": {
"metroCode": "DC",
"notifications": [
"test@equinix.com"
],
"virtualDeviceName": "sroy-cisco-8v-controller-secondary",
"additionalBandwidth": "100",
"vendorConfig": {
"systemIpAddress": "1.1.1.1",
"siteId": "9886",
"hostname": "SR-02"
},
"aclTemplateUuid": "3319e378-be2f-40e4-8e79-13ea2aed7a5f",
"day0TextFileId": "dec1dee5-eba9-4187-a029-ae76341e8874",
"accountNumber": "201091"
},
"additionalBandwidth": "100"
}
'
パラメータとオプションの完全なリストについては、API リファレンス を参照してください。
回答例
単一デバイスの応答例 202：リクエストを受け付けました。
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec"
}
冗長デバイスの応答例 202：リクエストを受け付けました。
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",
"secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"
}
Access Denied（アクセス拒否）」と表示された場合は、お近くのエクイニクスサービスデスクにお問い合わせください。
デバイスステータス
SD-WANデバイスが作成されると、エクイニクスのインフラストラクチャ内でさまざまな状態に移行します。これらの状態は、Get Virtual Device {uuid}APIの「status」レスポンス属性を使用して監視できます。デバイスがプロビジョニングされ、ライセンスが適用されると、クラウドサービスプロバイダーへの接続を作成できます。
| Virtual device states | Description |
|---|---|
INITIALIZING | Equinix is in the process of reserving resources and creating the device. |
PENDING_ACCOUNT | Customer's account is not approved. The device creation will continue once the account gets approved. |
PROVISIONING | The device is booting. |
PENDING_ORDER | This status only applies to orders coming to NE from Siebel. Customers need to log in to the Network Edge portal and submit the pending order. |
PENDING_SIGNATURE | The customer has not yet accepted Network Edge terms. |
CANCEL_ORDER | The order from Siebel to NE is canceled. This status only applies to orders coming to Network Edge from Siebel. |
WAITING_FOR_PRIMARY | The secondary device is ready but the primary is not. This state may appear if you have requested a redundant device. |
WAITING_FOR_SECONDARY | The primary device is ready but the secondary is not. This state may appear if you have requested a redundant device. |
FAILED | The device creation failed. |
PROVISIONED | The device is ready. |
DEPROVISIONING | Equinix accepted the customer's request to delete the virtual device. |
DEPROVISIONED | The device is de-provisioned/deleted. |
エンドユーザーが仮想デバイスの削除 APIを使用してデバイスを削除すると、エクイニクスインフラストラクチャ内でデバイスは次の状態に遷移します。
| status | Description |
|---|---|
DEPROVISIONING | Equinix accepted the customer's request to delete the virtual device. |
DEPROVISIONED | The device is de-provisioned/deleted. |