Créer un dispositif SDWAN

Conditions préalables

Authentifier - Soumettez vos informations d'identification de l'utilisateur, l'ID du client et le secret du client pour l'authentification OAuth2. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'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 **** et que vous essayez de créer un appareil pour votre client, vous devez vous assurer que le compte du client et le vôtre (celui du revendeur) sont tous deux dans le statut Actif ou En attente. Votre compte sera facturé, mais vous devez envoyer le numéro de compte du client à l'API POST pour créer un dispositif 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 un périphérique Cisco SD-WAN, vous devez procéder 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 fileUuid dans la réponse. Vous pouvez entrer la valeur dans le champ day0TextFileId du payload create pour créer un appareil virtuel C8000V-SDWAN.

Pour configurer une licence pour un appareil CloudGenix, vous devez procéder comme suit :

• Générez une clé de licence (clé ION) et un secret de licence (clé secrète) sur la plateforme CloudGenix.
• Saisissez la clé de licence (ION key) et le secret (Secret key) lorsque vous appelez Equinix create Vous pouvez utiliser l'API de périphérique pour créer un périphérique SD-WAN CloudGenix.

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 fileId que vous pourrez utiliser pour créer un dispositif SD-WAN virtuel.

Pour configurer un appareil Versa, veuillez créer un modèle d'appareil vNF sur Versa director et noter 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 un Juniper SD-WAN, vous devez procéder 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 fileId que 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

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 \N*

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.

\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

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.

Étape 5 : Créer des dispositifs SD-WAN

	POST /ne/v1/devices
Method	POST
URL or End Point	/ne/v1/devices
Headers	Authorization, Content-Type
Query Parameters	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 :

1. Définissez les paramètres vendorConfig de 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.

2. 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.

3. Si vous êtes un revendeur **** et que vous essayez de créer un dispositif redondant pour votre client, assurez-vous que les métros primaire et secondaire se trouvent dans le même pays. De même, les numéros de compte primaire et secondaire doivent être identiques. Le compte du revendeur sera facturé, mais cette API accepte le numéro de compte du client pour créer des appareils pour ce dernier. 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.

note

En créant un appareil 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.

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.

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.

status	Description
DEPROVISIONING	Equinix accepted the customer's request to delete the virtual device.
DEPROVISIONED	The device is de-provisioned/deleted.