SDWANデバイスの作成
前提条件
認証- OAuth2認証のためにユーザー資格情報、クライアントID、およびクライアントシークレットを送信する。認証情報を検証および認証するためにOAuth APIを呼び出す方法については、API認証を参照。
ステップ2：デバイスの種類とアカウントを取得する
Get Device Types API を呼び出して、NE プラットフォーム上で起動できる SD-WAN デバイスを見つけます。これらのデバイスが利用可能なメトロ（metroCode）、利用可能なコア数（core）、ソフトウェアパッケージ（packageCodeとversion）、可能な全てのライセンスとスループットオプションについて学ぶことができます。
欲しいデバイスがすでに決まっている場合は、このステップを飛ばしても構いません。
Get Accounts {metro} API を呼び出して、仮想デバイスが必要なメトロのアカウント番号 (または accountReferenceId) とステータスを確認します。課金上の理由から、仮想デバイスが必要なメトロで、Active または Pending 状態のアカウントが必要です。アカウントの作成方法については、Billing Account Managementを参照してください。
販売店がお客様用のデバイスを作成しようとしている場合は、お客様のアカウントと（販売店の）アカウントの両方が「アクティブ」または「保留中」のステータスになっていることを確認する必要がある。アカウントは請求されるが、お客様のアカウント番号をPOST APIに送信して、お客様用のSD WANデバイスを作成する必要がある。
アカウント番号（または 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 デバイスを作成できます。
Prismaデバイスのライセンスを構成するには、次の手順を実行する。
- Prisma Orchestratorでライセンスキー(ionキー)とライセンスシークレット(シークレットキー)を生成する。
- Equinix CREATE DEVICE APIを呼び出してプリズマWANデバイスを作成する際に、ライセンスキー(IONキー)とシークレット(シークレットキー)を入力する。
Fortinetデバイスでは、デバイス作成時にライセンスは必須ではありません。トークンをお持ちの場合は、licenseTokenフィールドに入力してください。Fortinet SD-WANデバイスにライセンスファイルを設定するには、次の手順を実行します：
- Fortinetポータルでライセンスファイルを生成します。
- ライセンスファイルの投稿を呼び出して、エクイニクスポータルでライセンスファイルをアップロードします。仮想 SD-WAN デバイスを作成するために使用できる
fileIdが得られます。
Versaデバイスを構成するには、VersaディレクタでVNFデバイステンプレートを作成し、シリアル 番号を書き留めておく。
Network EdgeプラットフォームでArubaデバイスを設定するには、ライセンスファイルは必要ありません。
Juniper WANのライセンスをアップロードするには：
- Juniper ポータルでライセンスファイルを生成します。
- ライセンスファイルの投稿を呼び出して、エクイニクスポータルでライセンスファイルをアップロードします。Juniper SD-WAN デバイスを作成するために使用できる
fileIdが取得されます。
ステップ4：ベンダー固有のパラメータ
各SD-WANベンダーは、ステップ5のPOST API定義の一部としてリストされている共通パラメータ以外の独自のパラメータセットを必要とします。ご利用のベンダーのパラメータをご確認の上、[Step 5]で新規デバイスを作成する際に vendorConfig{} オブジェクトにパラメータを渡してください。
Cisco SD-WAN
| Cisco vendorConfig{}のパラメータ | 必須 | タイプ | 例 | 可能な値 | 会社概要 |
|---|---|---|---|---|---|
| サイトID | はい | 列 | 12345 | サイト ID。Cisco SD-WANデバイスでは必須。サイトIDは、支社やキャンパスなど、Viptelaオーバーレイネットワーク内の特定の物理的な場所です。 | |
| systemIpAddress (システムIPアドレス) | はい | 列 | 192.168.1.5 | システムIPアドレス。Cisco SD-WAN デバイスでは必須。各 vEdge ルータと vSmart コントローラにはシステム IP アドレスが割り当てられます。IPv4 アドレスのように、10 進 4 部ドット表記でなければなりません。 | |
| ホスト名 | 条件付 | 列 | SR-01 | ホスト名。C8000V-SDWANでは必須です。 |
パロアルトネットワークスPRISMA-SDWAN
| Palo Alto Networks vendorConfig{}パラメータ | 必須 | タイプ | 例 | 可能な値 | 会社概要 |
|---|---|---|---|---|---|
| licenseKey (イオンキー) | はい | 列 | <license_key> | ライセンスキー(IONキー)。Palo Alto Networksデバイスで必須。 | |
| licenseSecret (シークレットキー) | はい | 列 | ec68e425-f973-452e-a866-76be5844d0ba | ライセンスシークレット(シークレットキー)。Palo Alto Networksデバイスで必須。 |
Versa VERSA_SDWAN
| Versa vendorConfig{}パラメータ | 必須 | タイプ | 例 | 可能な値 | 会社概要 |
|---|---|---|---|---|---|
| ローカルID | はい | 列 | SDWAN-Branch@Versa.com | 支店のEメールアドレス | |
| リモートID | はい | 列 | Controller-01-staging@Versa.com | コントローラー側のメールアドレス。 | |
| シリアル番号 | はい | 列 | 12345 | Versa directorでデバイステンプレートを設定する際、顧客はシリアル番号を選択します。Versa director上のVersaポストステージングデバイスのシリアル番号は、この入力と一致する必要があります。 | |
| コントローラ1 | はい | 列 | 54.219.248.29 | SD-WANコントローラ1のIPアドレス。 | |
| コントローラ2 | はい | 列 | 54.177.220.115 | SD-WANコントローラーのIPアドレス2。 |
FortiGate FG-SDWAN *
| FortiGate vendorConfig{}パラメータ | 必須 | タイプ | 例 | 可能な値 | 会社概要 |
|---|---|---|---|---|---|
| adminPassword (管理パスワード) | はい | 列 | パスワード9 | パスワード。このパスワードは6文字以上で、大文字と数字を含む必要があります。 | |
| コントローラ1 | はい | 列 | 1.1.1.1 | システムIPアドレス。FortiGate SD-WANデバイスでは必須です。 |
*FortiGate SD-WANデバイスにもホスト名が必要ですが、これはvendorConfigオブジェクトの一部ではなく、deviceTypeCode、accountNumberなどのパラメータとして渡されます。
Arista VELOCLOUD-SDWAN
| Arista vendorConfig{}パラメータ | 必須 | タイプ | 例 | 可能な値 | 会社概要 |
|---|---|---|---|---|---|
| アクティブ化キー | はい | 列 | GJUK-JM2X-59BJ-SAMPLE | アクティベーション・キー。VeloCloud オーケストレーション・ポータルで利用可能。 | |
| コントローラFqdn | はい | 列 | demo.velocloud.net | VeloCloud SD-WAN Gateway。デバイスの ACL のリストで、controllerFqdn に関連付けられた IP アドレスを提供してください。 | |
| ルートパスワード | いいえ | 列 | テストパスワード! | デバイスのCLIパスワード。 |
HPEアルバEDGECONNECT-SDWAN
| Aruba vendorConfig{}パラメータ | 必須 | タイプ | 例 | 可能な値 | 会社概要 |
|---|---|---|---|---|---|
| アカウント名 | はい | 列 | アカウント名 | 口座の名前。 | |
| ホスト名 | はい | 列 | マイホスト名1 | 識別用のホスト名。これはFQDNとして含まれ、デバイスが承認されたソースから到達可能であることを保証する。a-z、A-Z、0-9、およびハイフン(-)のみが許可される。文字で始まり、文字または数字で終わる必要があります。長さは2～30文字とする。例外 - FTDv 2-14; Aruba 2-24。 | |
| アカウントキー | はい | 列 | アカウントキー | アカウントの鍵 | |
| アプライアンスタグ | いいえ | 列 | アプライアンスタグ | 家電製品のタグ。 |
ステップ 5: SD-WANデバイスの作成
| POST/NE/v1/デバイス | |
|---|---|
| 方法 | POST |
| URLまたはエンドポイント | /ne/v1/devices |
| ヘッダー | Authorization、Content-Type |
| クエリーパラメータ | 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 を提供する必要があります。
仮想デバイスを作成することで、注文条件に同意したことになる。注文条件の取得に電話して詳細を確認する。
サンプル請求
冗長 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」レスポンス属性を使用して監視できます。デバイスがプロビジョニングされ、ライセンスが適用されると、クラウドサービスプロバイダーへの接続を作成できます。
| 仮想デバイスの状態 | 会社概要 |
|---|---|
INITIALIZING | エクイニクスは現在、リソースの予約とデバイスの作成を進めています。 |
PENDING_ACCOUNT | お客様のアカウントが承認されていません。アカウントが承認されると、デバイスの作成が続行されます。 |
PROVISIONING | デバイスが起動している。 |
PENDING_ORDER | このステータスは、SiebelからNEへの注文にのみ適用されます。顧客はNetwork Edgeポータルにログインし、保留中の注文を送信する必要があります。 |
PENDING_SIGNATURE | 顧客はまだNetwork Edgeの条件を受け入れていません。 |
CANCEL_ORDER | SiebelからNEへの注文はキャンセルされました。このステータスは、Siebel から Network Edge への注文にのみ適用されます。 |
WAITING_FOR_PRIMARY | セカンダリデバイスの準備はできているが、プライマリデバイスの準備はできていない。冗長デバイスを要求した場合、この状態が表示されることがある。 |
WAITING_FOR_SECONDARY | プライマリデバイスの準備はできているが、セカンダリデバイスの準備はできていない。冗長デバイスを要求した場合、この状態が表示されることがある。 |
FAILED | デバイスの作成に失敗しました。 |
PROVISIONED | デバイスは準備できている。 |
DEPROVISIONING | エクイニクスはお客様からの仮想デバイスの削除要求を受け入れました。 |
DEPROVISIONED | デバイスはプロビジョニング解除/削除される。 |
エンドユーザーが仮想デバイスの削除 APIを使用してデバイスを削除すると、エクイニクスインフラストラクチャ内でデバイスは次の状態に遷移します。
| 地位 | 商品説明 |
|---|---|
DEPROVISIONING | エクイニクスはお客様からの仮想デバイスの削除要求を受け入れました。 |
DEPROVISIONED | デバイスはプロビジョニング解除/削除される。 |