Créer un dispositif SDWAN
Conditions préalables
Authentifier - soumettre vos informations d'identification utilisateur, ID client et secret client pour l'authentification OAuth2. Reportez-vous à authentification API pour obtenir des instructions sur la façon d'appeler le API OAuth pour valider et authentifier vos informations d'identification.
Étape 2 : Obtenir les types d'appareils et le compte
Appelez l'API Get Device Types pour trouver les dispositifs SD-WAN que vous pouvez lancer sur la plateforme NE. Vous découvrirez les métros (metroCode) où ces dispositifs sont disponibles, le nombre de cœurs disponibles (core), les packages logiciels (packageCode et version), ainsi que toutes les options de licence et de débit possibles.
Vous pouvez sauter cette étape si vous savez déjà quel appareil vous voulez.
Vérifiez votre numéro de compte (ou accountReferenceId) et votre statut dans le métro où vous voulez un dispositif virtuel en appelant l'API Get Accounts {metro}. Pour des raisons de facturation, vous devez disposer d'un compte dans le métro où vous souhaitez installer un équipement virtuel, qu'il soit à l'état actif ou en attente. Pour savoir comment créer un compte, consultez [Billing Account Management] (https://docs.equinix.com/en-us/Content/Interconnection/NE/user-guide/NE-billing-account-creation.htm).
Si vous êtes un revendeur qui tente de créer un appareil pour votre client, vous devez vous assurer que le compte du client et celui de votre revendeur sont tous deux à l'état actif ou en attente. Votre compte sera facturé, cependant, vous devez envoyer le numéro de compte du client au POST API pour créer un appareil SD-WAN pour votre client.
Vous pouvez sauter cette étape si vous connaissez déjà votre numéro de compte (ou accountReferenceId) et votre statut.
Étape 3 : Configuration d'une licence
Pour l'instant, le BYOL (bring your own license) est la seule option de licence disponible pour les dispositifs SD-WAN et le processus de BYOL est propre à chaque fournisseur.
Pour configurer une licence pour les périphériques Cisco SD-WAN, procédez comme suit :
- Générer un fichier de démarrage sur la plateforme Cisco vManage.
- Pour créer un C8000V-SDWAN, téléchargez le fichier d'amorçage Cisco en appelant Upload File. Vous obtiendrez un
fileUuiddans la réponse. Vous pouvez entrer la valeur dans le champday0TextFileIddu payload create pour créer un appareil virtuel C8000V-SDWAN.
Pour configurer une licence pour un périphérique Prisma, procédez comme suit :
- Générez une clé de licence (clé ION) et un secret de licence (clé secrète) sur Prisma Orchestrator.
- Entrez la clé de licence (clé ION) et la clé secrète (clé secrète) lorsque vous appelez Equinix CREATE Device API pour créer un périphérique Prisma SD-WAN.
La licence n'est pas obligatoire pour les appareils Fortinet au moment de la création de l'appareil. Si vous avez un jeton, saisissez-le dans le champ licenseToken. Pour configurer un fichier de licence pour un dispositif SD-WAN Fortinet, procédez comme suit :
- Générer un fichier de licence sur le portail Fortinet.
- Téléchargez le fichier de licence sur le portail Equinix en appelant Post License File. Vous obtiendrez un
fileIdque vous pourrez utiliser pour créer un dispositif SD-WAN virtuel.
Pour configurer un périphérique versa, créez un modèle de périphérique VNF sur le directeur versa et notez le numéro de série.
Vous n'avez pas besoin d'un fichier de licence pour configurer un appareil Aruba sur la plateforme Network Edge.
Pour télécharger une licence pour Juniper SD-WAN, procédez comme suit :
- Générez un fichier de licence sur le portail Juniper.
- Téléchargez le fichier de licence sur le portail Equinix en appelant Post License File. Vous obtiendrez un
fileIdque vous pourrez utiliser pour créer un dispositif Juniper SD-WAN.
Étape 4 : Paramètres spécifiques au fournisseur
Chaque fournisseur de SD-WAN exige son propre ensemble de paramètres autres que les paramètres communs énumérés dans le cadre de la définition de l'API POST à [l'étape 5] (#step-5-create-sd-wan-devices). Veuillez vérifier les paramètres de votre fournisseur et les transmettre dans l'objet vendorConfig{} lors de la création d'un nouveau dispositif à l'étape 5.
Cisco SD-WAN
| Paramètres Cisco vendorConfig{ } | Obligatoire | Type de produit | Exemple | Valeurs possibles | Description de l'entreprise |
|---|---|---|---|---|---|
| ID du site | Oui | chaîne | 12345 | Site Id. Obligatoire pour les appareils Cisco SD-WAN. Un siteId est un emplacement physique particulier au sein du réseau superposé Viptela, tel qu'une succursale ou un campus. | |
| SystemIpAddress | Oui | chaîne | 192.168.1.5 | Adresse IP du système. Obligatoire pour les appareils Cisco SD-WAN. Chaque routeur vEdge et contrôleur vSmart se voit attribuer une adresse IP système. Elle doit être exprimée en notation décimale à quatre points, tout comme l'adresse IPv4. | |
| nom d'hôte | Conditionnel | chaîne | SR-01 | nom d'hôte. Obligatoire pour C8000V-SDWAN. |
Palo Alto Networks PRISMA-SDWAN
| Paramètres vendorConfig{ } de Palo Alto Networks | Obligatoire | Type de produit | Exemple | Valeurs possibles | Description de l'entreprise |
|---|---|---|---|---|---|
| Clé de licence (clé IONIQUE) | Oui | chaîne | <license_key> | Clé de licence (clé IONIQUE). Obligatoire pour les appareils Palo Alto Networks. | |
| LicenseSecret (clé secrète) | Oui | chaîne | ec68e425-f973-452e-a866-76be5844d0ba | Secret de licence (clé secrète). Obligatoire pour les appareils Palo Alto Networks. |
Versa VERSA_SDWAN
| Paramètres versa vendorConfig{ } | Obligatoire | Type de produit | Exemple | Valeurs possibles | Description de l'entreprise |
|---|---|---|---|---|---|
| LocalID | Oui | chaîne | SDWAN-Branch@Versa.com | Adresse électronique de la succursale. | |
| ID à distance | Oui | chaîne | Controller-01-staging@Versa.com | Adresse électronique du contrôleur. | |
| Numéro de série | Oui | chaîne | 12345 | Le client sélectionne un numéro de série lorsqu'il configure le modèle d'appareil sur Versa director. Le numéro de série de l'appareil de post-stationnement de Versa director doit correspondre à cette entrée. | |
| controleur 1 | Oui | chaîne | 54.219.248.29 | Adresse IP du contrôleur SD-WAN1. | |
| controleur 2 | Oui | chaîne | 54.177.220.115 | Adresse IP du contrôleur SD-WAN2. |
FortiGate FG-SDWAN \N*
| Paramètres Fortigate vendorConfig{ } | Obligatoire | Type de produit | Exemple | Valeurs possibles | Description de l'entreprise |
|---|---|---|---|---|---|
| AdminPassword | Oui | chaîne | ThisPassword9 | Mot de passe. Ce mot de passe doit comporter au moins 6 caractères et doit inclure une lettre majuscule et un chiffre. | |
| controleur 1 | Oui | chaîne | 1.1.1.1 | Adresse IP du système. Obligatoire pour les appareils FortiGate SD-WAN. |
\N-*Les dispositifs SD-WAN FortiGate ont également besoin d'un nom d'hôte, mais il ne fait pas partie de l'objet vendorConfig, il est simplement transmis en tant que paramètre avec d'autres comme deviceTypeCode, accountNumber, etc.
Arista VELOCLOUD-SDWAN
| Paramètres Arista vendorConfig{ } | Obligatoire | Type de produit | Exemple | Valeurs possibles | Description de l'entreprise |
|---|---|---|---|---|---|
| Clé d'activation | Oui | chaîne | ÉCHANTILLON GJUK-JM2X-59BJ | Clé d'activation. Disponible sur le portail d'orchestration VeloCloud. | |
| ControllerFqdn | Oui | chaîne | demo.velocloud.net | VeloCloud SD-WAN Gateway. Dans la liste des ACL pour l'appareil, veuillez fournir les adresses IP associées au contrôleurFqdn. | |
| RootPassword | Non | chaîne | TestPassword ! | Mot de passe CLI pour l'appareil. |
HPE ARUBA EDGECONNECT-SDWAN
| Paramètres Aruba vendorConfig{ } | Obligatoire | Type de produit | Exemple | Valeurs possibles | Description de l'entreprise |
|---|---|---|---|---|---|
| AccountName | Oui | chaîne | AccountName | Le nom du compte. | |
| nom d'hôte | Oui | chaîne | nomhôte1 | Nom d'hôte pour l'identification. Il est inclus dans le FQDN et garantit que l'appareil est accessible à partir des sources approuvées. Seuls les caractères a-z, A-Z, 0-9 et le trait d'union (-) sont autorisés. Il doit commencer par une lettre et se terminer par une lettre ou un chiffre. La longueur doit être comprise entre 2 et 30 caractères. Exceptions - FTDv 2-14 ; Aruba 2-24. | |
| AccountKey | Oui | chaîne | AccountKey | La clé du compte. | |
| ApplianceTag | Non | chaîne | ApplianceTag | L'étiquette de l'appareil. |
Étape 5 : Créer des dispositifs SD-WAN
| POST /ne/v1/devices | |
|---|---|
| Méthode | POST |
| URL ou point final | /ne/v1/devices |
| En-têtes | Authorization Content-Type |
| Paramètres d'interrogation | draft draftUuid |
Si vous souhaitez créer un dispositif SD-WAN redondant composé de deux dispositifs, l'un primaire et l'autre secondaire, procédez comme suit :
-
Définissez les paramètres
vendorConfigde l'objet secondaire optionnel.- fournir deux licenseFileIds pour un Cisco SD-WAN dans le payload du corps de la requête
- Fournissez deux clés de licence (clés ION) et secrets de licence (clés secrètes) pour un serveur CloudGenix redondant. dispositif dans le corps de la demande charge utile
- Fournissez deux clés d'activation pour un périphérique Arista VeloCloud SD-WAN Edge redondant.
-
Vous pouvez avoir un modèle ACL, un numéro de compte, une bande passante supplémentaire, un code métro et des notifications différents pour votre appareil secondaire.
-
Si vous êtes un revendeur essayant de créer un appareil redondant pour votre client, assurez-vous que les métros principal et secondaire se trouvent dans le même pays. De plus, les numéros de compte principal et secondaire doivent être identiques. Le compte du revendeur sera facturé, cependant, ce API accepte le numéro de compte du client pour créer des appareils pour le client. Les restrictions ci-dessus sont nécessaires car chaque client est associé au compte de facturation d'un revendeur.
Si vous ne disposez pas de toutes les informations nécessaires, vous pouvez toujours les enregistrer en tant que projet. Vous devez fournir un deviceTypeCode, un accountNumber/accountReferenceId et un metroCode pour enregistrer un projet.
En créant un périphérique virtuel, vous acceptez les conditions de commande. Appelez Get Order Terms pour consulter les détails.
Demande d'échantillon
Un exemple de requête curl pour créer un périphérique Cisco SD-WAN redondant.
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"
}
'
Pour une liste complète des paramètres et des options, consultez la [Référence API] (/api-catalog/network-edgev1#operation/createVirtualDevice).
Exemple de réponse
Exemple de réponse pour un seul appareil 202 : Demande acceptée.
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec"
}
Exemple de réponse pour un dispositif redondant 202 : Demande acceptée.
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",
"secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"
}
Si vous obtenez le message " Access Denied ", contactez le service d'assistance local d'Equinix pour obtenir l'accès au portail.
État de l'appareil
Lorsqu'un dispositif SD-WAN est créé, il passe par différents états au sein de l'infrastructure Equinix. Ces états peuvent être contrôlés à l'aide de l'attribut de réponse " status " de l'API [Get Virtual Device {uuid}] (/api-catalog/network-edgev1/#tag/Virtual-Device/operation/getVirtualDeviceByUuid). Une fois que votre appareil est approvisionné et que la licence est appliquée, vous pouvez créer des connexions avec les fournisseurs de services en nuage.
| états des périphériques virtuels | Description de l'entreprise |
|---|---|
INITIALIZING | Equinix est en train de réserver des ressources et de créer le dispositif. |
PENDING_ACCOUNT | Le compte du client n'est pas approuvé. La création de l'appareil se poursuivra dès que le compte sera approuvé. |
PROVISIONING | L'appareil démarre. |
PENDING_ORDER | Ce statut ne s'applique qu'aux commandes provenant de Siebel. Les clients doivent se connecter au portail Network Edge et soumettre la commande en attente. |
PENDING_SIGNATURE | Le client n'a pas encore accepté les conditions de Network Edge. |
CANCEL_ORDER | La commande de Siebel à NE est annulée. Ce statut ne s'applique qu'aux commandes provenant de Siebel et arrivant à Network Edge. |
WAITING_FOR_PRIMARY | L'appareil secondaire est prêt mais l'appareil principal ne l'est pas. Cet état peut apparaître si vous avez demandé un appareil redondant. |
WAITING_FOR_SECONDARY | L'appareil principal est prêt mais l'appareil secondaire ne l'est pas. Cet état peut apparaître si vous avez demandé un appareil redondant. |
FAILED | La création de l'appareil a échoué. |
PROVISIONED | L'appareil est prêt. |
DEPROVISIONING | Equinix a accepté la demande du client de supprimer le dispositif virtuel. |
DEPROVISIONED | L'appareil est déprovisionné/supprimé. |
Lorsqu'un utilisateur final supprime un dispositif à l'aide de l'API Delete Virtual Devices, le dispositif passe par les états suivants au sein de l'infrastructure Equinix.
| statut | Description |
|---|---|
DEPROVISIONING | Equinix a accepté la demande du client de supprimer le dispositif virtuel. |
DEPROVISIONED | L'appareil est déprovisionné/supprimé. |