Crear un dispositivo SDWAN
Requisitos previos
Autenticar - Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para la autenticación OAuth2. Consulte API Authentication para obtener instrucciones sobre cómo llamar a la API OAuth para validar y autenticar sus credenciales.
Paso 2: Obtener tipos de dispositivos y cuenta
Llame a la API Get Device Types para encontrar los dispositivos SD-WAN que puede lanzar en la plataforma NE. Conocerá los metros (metroCode) en los que están disponibles estos dispositivos, el número de núcleos disponibles (core), los paquetes de software (packageCode y version) y todas las opciones posibles de licencia y rendimiento.
Puede omitir este paso si ya sabe qué dispositivo desea.
Compruebe su número de cuenta (o accountReferenceId) y su estado en el metro en el que desea un dispositivo virtual llamando a la API Get Accounts {metro}. Por motivos de facturación, debe tener una cuenta en el metro en el que desea un dispositivo virtual, ya sea en estado Activo o Pendiente. Para saber cómo crear una cuenta, vaya a Gestión de cuentas de facturación.
Si usted es un revendedor de **** que intenta crear un dispositivo para su cliente, debe asegurarse de que tanto la cuenta del cliente como la suya (la del revendedor) están en estado Activo o Pendiente. Sin embargo, deberá enviar el número de cuenta del cliente a la API POST para crear un dispositivo SD-WAN para su cliente.
Puede omitir este paso si ya conoce su número de cuenta (o accountReferenceId) y su estado.
Paso 3: Configurar una licencia
Por ahora, traer su propia licencia (BYOL) es la única opción de licencia disponible para los dispositivos SD-WAN y el proceso para BYOL es único para cada proveedor.
Para configurar una licencia para un dispositivo Cisco SD-WAN, debe hacer lo siguiente:
- Genere un archivo de arranque en la plataforma Cisco vManage.
- Para crear una SDWAN C8000V, cargue el archivo de arranque de Cisco llamando a Upload File. Obtendrá un
fileUuiden la respuesta. Puede introducir el valor en el campoday0TextFileIdde la carga útil de creación para crear un dispositivo C8000V-SDWAN virtual.
Para configurar una licencia para un dispositivo CloudGenix, debe hacer lo siguiente:
- Genere una clave de licencia (clave ION) y un secreto de licencia (clave Secret) en la plataforma CloudGenix.
- Introduzca la clave de licencia (clave ION) y el secreto (clave Secret) cuando llame a Equinix create API de dispositivos para crear un dispositivo CloudGenix SD-WAN.
La licencia no es obligatoria para los dispositivos Fortinet en el momento de la creación del dispositivo. Si dispone de un token, introdúzcalo en el campo licenseToken. Para configurar un archivo de licencia para un dispositivo SD-WAN de Fortinet, haga lo siguiente:
- Genere un archivo de licencia en el portal de Fortinet.
- Cargue el archivo de licencia en el portal Equinix llamando a Post License File. Obtendrá un
fileIdque podrá utilizar para crear un dispositivo SD-WAN virtual.
Para configurar un dispositivo Versa, cree una plantilla de dispositivo vNF en Versa director y anote el número de serie.
No necesita un archivo de licencia para configurar un dispositivo Aruba en la plataforma Network Edge.
Para cargar una licencia para una SD-WAN de Juniper, debe hacer lo siguiente:
- Genere un archivo de licencia en el portal de Juniper.
- Cargue el archivo de licencia en el portal Equinix llamando a Post License File. Obtendrá un
fileIdque podrá utilizar para crear un dispositivo SD-WAN de Juniper.
Paso 4: Parámetros específicos del proveedor
Cada proveedor de SD-WAN requiere su propio conjunto de parámetros, aparte de los parámetros comunes enumerados como parte de la definición de la API POST en Paso 5. Por favor, compruebe los parámetros de su proveedor y pase los parámetros en el objeto vendorConfig{} cuando cree un nuevo dispositivo en el Paso 5.
SD-WAN de Cisco
| 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. |
*Los dispositivos SD-WAN FortiGate también necesitan un nombre de host, pero no forma parte del objeto vendorConfig, sólo se pasa como parámetro junto con otros como deviceTypeCode, accountNumber, etc.
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. |
Paso 5: Crear dispositivos SD-WAN
| POST /ne/v1/devices | |
|---|---|
| Method | POST |
| URL or End Point | /ne/v1/devices |
| Headers | Authorization, Content-Type |
| Query Parameters | draft, draftUuid |
Si desea crear un dispositivo SD-WAN redundante que tenga dos dispositivos, uno primario y otro secundario, haga lo siguiente:
-
Establezca los parámetros
vendorConfigdel objeto secundario opcional.- proporcione dos licenseFileIds para una Cisco SD-WAN en la carga útil del cuerpo de la solicitud
- proporcione dos claves de licencia (claves ION) y secretos de licencia (claves Secret) para un CloudGenix redundante dispositivo en la carga útil del cuerpo de la solicitud
- proporcione dos activationKeys para un dispositivo redundante Arista VeloCloud SD-WAN Edge.
-
Es posible que tenga una plantilla ACL, un número de cuenta, un additionalBandwidth, un metroCode y notificaciones diferentes para su dispositivo secundario.
-
Si usted es un revendedor de **** que intenta crear un dispositivo redundante para su cliente, asegúrese de que tanto el metro primario como el secundario se encuentran en el mismo país. Además, los números de cuenta primario y secundario deben ser iguales. Se facturará a la cuenta del revendedor, sin embargo, esta API acepta el número de cuenta del cliente para crear dispositivos para el cliente. Las restricciones anteriores son necesarias ya que cada cliente está asociado a una cuenta de facturación del revendedor.
Debe proporcionar un deviceTypeCode, un accountNumber/accountReferenceId y un metroCode para guardar un borrador.
Al crear un dispositivo virtual, acepta las Condiciones del pedido. Llame a Obtener Condiciones del Pedido para revisar los detalles.
Solicitud de muestra
Un ejemplo de solicitud curl para crear un dispositivo Cisco SD-WAN redundante.
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"
}
'
Para obtener una lista completa de parámetros y opciones, consulte la Referencia API.
Muestra de respuesta
Ejemplo de respuesta para un único dispositivo 202: Solicitud aceptada.
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec"
}
Ejemplo de respuesta para un dispositivo redundante 202: Solicitud aceptada.
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",
"secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"
}
Si aparece el mensaje "Acceso denegado", póngase en contacto con el servicio local de atención al cliente de Equinix para obtener acceso al Portal.
Estado del dispositivo
Cuando se crea un dispositivo SD-WAN, el dispositivo pasa por varios estados dentro de la infraestructura de Equinix. Estos estados pueden supervisarse utilizando el atributo de respuesta "status" de la API Get Virtual Device {uuid}. Una vez aprovisionado su dispositivo y aplicada la licencia, puede crear conexiones con los proveedores de servicios en la nube.
| 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. |
Cuando un usuario final elimina un dispositivo utilizando la API Delete Virtual Devices, el dispositivo pasa por los siguientes estados dentro de la infraestructura de Equinix.
| status | Description |
|---|---|
DEPROVISIONING | Equinix accepted the customer's request to delete the virtual device. |
DEPROVISIONED | The device is de-provisioned/deleted. |