Créer un périphérique 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
Appel Obtenir les types d'appareils
API pour trouver les équipements SD-WAN compatibles avec la plateforme NE. Vous découvrirez les régions métropolitaines (metroCode) où ces équipements sont disponibles, le nombre de cœurs disponibles (core), les progiciels (packageCode et version), ainsi que toutes les options de licence et de débit.
Vous pouvez ignorer cette étape si vous savez déjà quel appareil vous souhaitez.
Vérifiez votre numéro de compte (ou accountReferenceId) et son statut dans la région métropolitaine où vous souhaitez déployer un périphérique virtuel en appelant l'API Get Accounts {metro}. Pour des raisons de facturation, vous devez avoir un compte dans cette région métropolitaine, que ce compte soit actif ou en attente. Pour savoir comment créer un compte, consultez la section Gestion des comptes de facturation.
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 ignorer cette étape si vous connaissez déjà votre numéro de compte (ou accountReferenceId) et
statut.
Étape 3: Configurer une licence
Pour l'instant, l'option « Apportez votre propre licence » (BYOL) est la seule disponible pour les appareils SD-WAN. Le processus 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 bootstrap sur la plate-forme Cisco vManage.
- Pour créer un C8000V-SDWAN, chargez le fichier d'amorçage Cisco en appelant Upload File. Vous obtiendrez un
fileUuiden réponse. Vous pouvez saisir cette valeur dans le champday0TextFileIdde la charge utile de création pour créer un périphérique 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 leur création. Si vous avez un jeton,
Entrez-le dans le champ licenseToken. Pour configurer un fichier de licence pour un périphérique SD-WAN Fortinet, procédez comme suit:
suivant:
- 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 périphérique 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 périphérique Aruba sur la plate-forme Network Edge .
Pour télécharger une licence pour Juniper SD-WAN, procédez comme suit :
- Générer 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 appareil Juniper SD-WAN.
Étape 4: Paramètres spécifiques au fournisseur
Chaque fournisseur SD-WAN requiert son propre ensemble de paramètres, en plus des paramètres communs énumérés dans la section de 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 transmettez les paramètres dans l'objet vendorConfig{} lors de la création d'un nouvel appareil à l'étape 5.
Cisco SD-WAN
| Paramètres Cisco vendorConfig{ } | Obligatoire | Type | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
| ID du site | Oui | chaîne | 12345 | ID de site. Obligatoire pour les périphériques 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 système. Obligatoire pour les périphériques Cisco SD-WAN. Une adresse IP système est attribuée à chaque routeur vEdge et contrôleur vSmart. Elle doit être 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 | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
| 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 | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
| LocalID | Oui | chaîne | SDWAN-Branch@Versa.com | Adresse e-mail de la succursale. | |
| ID à distance | Oui | chaîne | Controller-01-staging@Versa.com | Adresse e-mail du côté du contrôleur. | |
| Numéro de série | Oui | chaîne | 12345 | Le client sélectionne un numéro de série lors de la configuration du modèle d'appareil sur Versa Director. Le numéro de série de l'appareil post-mise en scène Versa sur 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 *
| Paramètres Fortigate vendorConfig{ } | Obligatoire | Type | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
| 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. |
Les périphériques FortiGate SD-WAN nécessitent également un nom d'hôte, mais celui-ci ne fait pas partie de l'objet vendorConfig ; il est simplement transmis en tant que un paramètre parmi d'autres comme deviceTypeCode, accountNumber, etc.
Arista VELOCLOUD-SDWAN
| Paramètres Arista vendorConfig{ } | Obligatoire | Type | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
| 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 | Passerelle SD-WAN VeloCloud. Veuillez indiquer les adresses IP associées au nom de domaine complet du contrôleur (controllerFqdn) dans la liste des ACL du périphérique. | |
| RootPassword | Non | chaîne | TestPassword ! | Mot de passe CLI pour l'appareil. |
HPE ARUBA EDGECONNECT-SDWAN
| Paramètres Aruba vendorConfig{ } | Obligatoire | Type | Exemple | Valeurs possibles | Description |
|---|---|---|---|---|---|
| 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 en tant que FQDN et garantit que l'appareil est accessible à partir des sources approuvées. Seuls les caractères az, AZ, 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 périphériques SD-WAN
| POST /ne/v1/devices | |
|---|---|
| Méthode | POST |
| URL ou point de terminaison | /ne/v1/devices |
| En-têtes | Authorization, Content-Type |
| Paramètres de la requête | draft, draftUuid |
Si vous souhaitez créer un périphérique SD-WAN redondant composé de deux appareils, un principal et un secondaire, procédez comme suit: suivant:
-
Définissez les paramètres
vendorConfigde l'objet secondaire optionnel.- fournir deux licenseFileIds pour un Cisco SD-WAN dans la charge utile du corps de la demande
- fournir deux clés de licence (clés ION) et deux secrets de licence (clés secrètes) pour une redondance CloudGenix dispositif dans la charge utile du corps de la requête
- Fournir 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 metroCode 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 n'avez pas toutes les informations nécessaires, vous pouvez quand même les sauvegarder comme brouillon. Vous devez fournir un deviceTypeCode, un accountNumber/accountReferenceId et un metroCode pour enregistrer un brouillon.
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 demande 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.
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 périphérique redondant 202: Demande acceptée.
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",
"secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"
}
Si vous obtenez le message « Accès refusé », contactez votre service d’assistance Equinix local pour accéder au portail.
État de l'appareil
Lors de la création d'un périphérique SD-WAN, celui-ci passe par différents états au sein de l'infrastructure Equinix. Ces états peuvent être suivis grâce à l'attribut de réponse « status » de l'API Get Virtual Device {uuid}. Une fois votre appareil approvisionné et la licence appliquée, vous pouvez établir des connexions aux fournisseurs de services cloud.
| états des périphériques virtuels | Description |
|---|---|
INITIALIZING | Equinix est en train de réserver des ressources et de créer l'appareil. |
PENDING_ACCOUNT | Le compte client n'est pas approuvé. La création de l'appareil se poursuivra une fois le compte approuvé. |
PROVISIONING | L'appareil est en cours de démarrage. |
PENDING_ORDER | Ce statut s'applique uniquement aux commandes envoyées à NE par 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 s'applique uniquement aux commandes envoyées à Network Edge par Siebel. |
WAITING_FOR_PRIMARY | Le périphérique secondaire est prêt, mais pas le périphérique principal. Cet état peut apparaître si vous avez demandé un périphérique redondant. |
WAITING_FOR_SECONDARY | Le périphérique principal est prêt, mais pas le périphérique secondaire. Cet état peut apparaître si vous avez demandé un périphérique 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 l'appareil virtuel. |
DEPROVISIONED | L'appareil est déprovisionné/supprimé. |
Lorsqu'un utilisateur final supprime un périphérique à l'aide de l'API Supprimer les périphériques virtuels, l'appareil passe par les états suivants au sein d'Equinix. infrastructure.
| statut | Description |
|---|---|
DEPROVISIONING | Equinix a accepté la demande du client de supprimer l'appareil virtuel. |
DEPROVISIONED | L'appareil est déprovisionné/supprimé. |