Créer un périphérique SDWAN

Préalable

Authentification: soumettez vos identifiants utilisateur, votre identifiant client et votre clé secrète pour l’authentification OAuth2. Consultez la documentation relative à l’authentification API (Authentification API) pour savoir comment appeler l’API OAuth afin de valider et d’authentifier vos identifiants.

É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 et que vous souhaitez créer un appareil pour votre client, vous devez vous assurer que les comptes du client et le vôtre (celui du revendeur) sont actifs ou en attente. Votre compte sera facturé, mais vous devrez transmettre le numéro de compte du client à l'API POST pour créer un appareil SD-WAN.

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 un périphérique Cisco SD-WAN, vous devez procéder 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 fileUuid en réponse. Vous pouvez saisir cette valeur dans le champ day0TextFileId de la charge utile de création pour créer un périphérique 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.
• Entrez la clé de licence (clé ION) et le secret (clé secrète) lors de l'appel à Equinix create 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 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 fileId que vous pourrez utiliser pour créer un périphérique SD-WAN virtuel.

Pour configurer un périphérique Versa, veuillez créer un modèle de périphérique vNF sur Versa Director et noter le numéro de série. numéro.

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 un Juniper SD-WAN, vous devez procéder 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 fileId que 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

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.

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

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 périphériques 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 périphérique SD-WAN redondant composé de deux appareils, un principal et un secondaire, procédez comme suit: suivant:

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

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

3. Si vous êtes un revendeur et que vous souhaitez créer un appareil redondant pour votre client, assurez-vous que les zones métropolitaines principale et secondaire sont dans le même pays. De plus, les numéros de compte principal et secondaire doivent être identiques. Le compte du détaillant sera facturé, mais cette API accepte le numéro de compte du client pour la création d'appareils. Ces restrictions sont nécessaires parce que 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.

remarque

En créant un appareil virtuel, vous acceptez les conditions générales de commande. Appelez Obtenir les conditions générales de commande 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.

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

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