创建 SDWAN 设备
先决条件
身份验证-提交您的用户凭据，客户端ID和客户端机密以进行OAuth2身份验证。有关如何调用OAuth API以验证和验证凭据的说明，请参阅API身份验证。
第 2 步：获取设备类型和账户
调用 获取设备类型
此 API 用于查找可在 NE 平台上启动的 SD-WAN 设备。您将了解这些设备可用的城域网（metroCode）、可用核心数（core）、软件包（packageCode 和 version）以及所有可能的许可和吞吐量选项。
如果您已经知道想要哪个设备，则可以跳过此步骤。
调用 Get Accounts {metro} API，查看您在所需虚拟设备所在都市区的账号（或 accountReferenceId）和状态。出于计费原因，您必须在所需虚拟设备所在都市区拥有一个账号，该账号状态必须为“激活”或“待处理”。要了解如何创建账号，请访问 计费账号管理。
如果您是尝试为客户创建设备的经销商，则必须确保客户和您(经销商)的帐户均处于"活动"或"待定"状态。您的帐户将会收到账单，但是，您必须将客户的帐号发送至邮政API，以便为您的客户创建WAN设备。
如果您已经知道您的账号（或accountReferenceId），则可以跳过此步骤。
地位。
步骤 3：配置许可证
目前，自带许可证 (BYOL) 是 SD-WAN 设备唯一可用的许可选项。 每个供应商的自带设备许可（BYOL）流程都各不相同。
要为Cisco WAN设备配置许可证，请执行以下操作：
- 在Cisco vManage 平台上生成引导文件。
- 要创建 C8000V-SDWAN，请调用 上传文件 上传 Cisco 引导文件。响应中会返回一个
fileUuid。您可以将该值输入到创建有效负载的day0TextFileId字段中，以创建虚拟 C8000V-SDWAN 设备。
要为Prisma设备配置许可证，请执行以下操作：
- 在Prisma Orchestrator上生成许可证密钥(离子密钥)和许可证密钥(密钥)。
- 调用Equinix创建设备API以创建Prisma WAN设备时，输入许可证密钥(离子密钥)和密钥(密钥)。
在创建 Fortinet 设备时，许可证并非强制性要求。如果您拥有令牌，
将其输入到 licenseToken 字段中。要为 Fortinet SD-WAN 设备配置许可证文件，请执行以下操作：
下列的：
- 在 Fortinet 门户上生成许可证文件。
- 通过调用 Post License File 将许可证文件上传到 Equinix 门户。您将获得一个
fileId，可用于创建虚拟 SD-WAN 设备。
要配置Versa设备，请在Versa director上创建VNF设备模板并记下序列号 。
您不需要许可证文件即可在Network Edge平台上配置 Aruba 设备。
要上传瞻博网络WAN的许可证，请执行以下操作：
- 在Juniper门户上生成许可证文件。
- 通过调用 Post License File 将许可证文件上传到 Equinix 门户。您将获得一个
fileId，可用于创建 Juniper SD-WAN 设备。
步骤 4：供应商特定参数
每个 SD-WAN 供应商都需要自己的一套参数，这些参数与作为通用参数列出的参数不同。 步骤 5 中定义了 POST API。请检查参数。 在步骤中创建新设备时，请提供您的供应商信息，并在 vendorConfig{} 对象中传递参数。 5.
思科 SD-WAN
| Cisco vendorConfig{}参数 | 必填 | 类型 | 示例 | 可能的值 | 描述 |
|---|---|---|---|---|---|
| 站点ID | 是 | 细绳 | 12345 | 站点 ID。对于Cisco SD-WAN 设备而言是必需的。站点 ID 是 Viptela 覆盖网络内的特定物理位置，例如分支机构或校园。 | |
| SystemIpAddress | 是 | 细绳 | 192.168.1.5 | 系统 IP 地址。对于Cisco SD-WAN 设备是必需的。每个 vEdge 路由器和 vSmart 控制器都分配有一个系统 IP 地址。它应采用四部分十进制点分表示法，就像 IPv4 地址一样。 | |
| 主机名 | 有条件的 | 细绳 | SR-01 | 主机名。对于 C8000V-SDWAN 是必需的。 |
Palo Alto Networks PRISMA-SDWAN
| Palo Alto Networks vendorConfig{}参数 | 必填 | 类型 | 示例 | 可能的值 | 描述 |
|---|---|---|---|---|---|
| 许可证密钥(离子密钥) | 是 | 细绳 | <license_key> | 许可证密钥(离子密钥)。对于Palo Alto Networks设备为必填。 | |
| 许可证密钥(密钥) | 是 | 细绳 | ec68e425-f973-452e-a866-76be5844d0ba | 许可证密钥(密钥)。对于Palo Alto Networks设备为必填。 |
Versa VERSA_SDWAN
| Versa vendorConfig{}参数 | 必填 | 类型 | 示例 | 可能的值 | 描述 |
|---|---|---|---|---|---|
| 本地ID | 是 | 细绳 | SDWAN-Branch@Versa.com | 分支机构的电子邮件地址。 | |
| 远程ID | 是 | 细绳 | Controller-01-staging@Versa.com | 控制端的电子邮件地址。 | |
| 序列号 | 是 | 细绳 | 12345 | 客户在 Versa 控制器上设置设备模板时选择序列号。Versa 控制器上的 Versa 后备设备序列号应与此输入匹配。 | |
| 控制器1 | 是 | 细绳 | 54.219.248.29 | SD-WAN 控制器 1 的 IP 地址。 | |
| 控制器2 | 是 | 细绳 | 54.177.220.115 | SD-WAN 控制器 2 的 IP 地址。 |
FortiGate FG-SDWAN *
| FortiGate vendorConfig{}参数 | 必填 | 类型 | 示例 | 可能的值 | 描述 |
|---|---|---|---|---|---|
| 管理员密码 | 是 | 细绳 | 此口令9 | 密码。此密码长度至少应为 6 个字符，并且必须包含大写字母和数字。 | |
| 控制器1 | 是 | 细绳 | 1.1.1.1 | 系统 IP 地址。对于 FortiGate SD-WAN 设备是必需的。 |
*FortiGate SD-WAN 设备也需要主机名，但它不属于 vendorConfig 对象，而是直接传递的。 一个参数，以及其他参数，例如 deviceTypeCode、accountNumber 等。
Arista VELOCLOUD-SDWAN
| Arista vendorConfig{}参数 | 必填 | 类型 | 示例 | 可能的值 | 描述 |
|---|---|---|---|---|---|
| ActivationKey | 是 | 细绳 | GJUK-JM2X-59BJ-样本 | 激活密钥。可在 VeloCloud 编排门户获取。 | |
| controllerFqdn | 是 | 细绳 | demo.velocloud.net | VeloCloud SD-WAN 网关。请在设备的 ACL 列表中提供与 controllerFqdn 关联的 IP 地址。 | |
| root口令 | 没有 | 细绳 | 测试密码！ | 设备的 CLI 密码。 |
HPE Aruba EDGECONNECT-SDWAN
| Aruba vendorConfig{}参数 | 必填 | 类型 | 示例 | 可能的值 | 描述 |
|---|---|---|---|---|---|
| 帐户名称 | 是 | 细绳 | 帐户名称 | 帐户的名称。 | |
| 主机名 | 是 | 细绳 | 我的主机名1 | 用于识别的主机名。此名称作为 FQDN 包含在内，并确保设备可从批准的来源访问。仅允许使用 az、AZ、0-9 和连字符 (-)。它应以字母开头，以字母或数字结尾。长度应介于 2-30 个字符之间。例外情况 - FTDv 2-14；Aruba 2-24。 | |
| 帐户密钥 | 是 | 细绳 | 帐户密钥 | 帐户密钥。 | |
| 设备标签 | 没有 | 细绳 | 设备标签 | 电器标签。 |
步骤 5：创建 SD-WAN 设备
| POST /ne/v1/devices | |
|---|---|
| 方法 | POST |
| URL 或端点 | /ne/v1/devices |
| 标头 | Authorization,Content-Type |
| 查询参数 | draft,draftUuid |
如果您想创建一个包含两个设备（主设备和备用设备）的冗余 SD-WAN 设备，请执行以下操作： 下列的：
-
设置可选辅助对象的
vendorConfig参数。- 在请求正文负载中为Cisco SD-WAN 提供两个 licenseFileId
- 为 CloudGenix 冗余提供两个许可证密钥（ION 密钥）和许可证密钥（密钥）。 请求正文有效负载中的设备
- 为冗余的 Arista VeloCloud SD-WAN Edge 设备提供两个激活密钥。
-
您的辅助设备可能具有不同的 ACL 模板、帐号、additionalBandwidth、metroCode 和通知。
-
如果您是尝试为客户创建冗余设备的经销商，请确保主要和辅助城域网位于同一个国家/地区。此外，主帐号和辅助帐号必须相同。经销商的帐户将被收取费用，但是，此API接受客户的帐号，以便为客户创建设备。上述限制是必要的，因为每个客户都与经销商的计费帐户相关联。
即使您没有所有必要信息，仍然可以将信息保存为草稿。 您必须提供设备类型代码、帐户编号/帐户参考 ID 和 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"
}
如果收到“拒绝访问”信息，请联系您当地的Equinix服务台以获取门户访问权限。
设备状态
创建 SD-WAN 设备时，该设备会在 Equinix 基础架构中经历各种状态转换。您可以使用 Get Virtual Device {uuid} API 的“status”响应属性来监控这些状态。设备配置完成并应用许可证后，即可创建与云服务提供商的连接。
| 虚拟设备状态 | 描述 |
|---|---|
INITIALIZING | Equinix目前正在预留资源和创建设备。 |
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 | Equinix接受了客户删除虚拟设备的请求。 |
DEPROVISIONED | 该设备已取消配置/删除。 |
当最终用户使用 Delete Virtual Devices API 删除设备时，该设备在 Equinix 系统中会经历以下状态转换。 基础设施。
| 身份 | 描述 |
|---|---|
DEPROVISIONING | Equinix接受了客户删除虚拟设备的请求。 |
DEPROVISIONED | 该设备已取消配置/删除。 |