Créer un dispositif

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 détails de l'appareil

Appelez Get Device Types pour savoir quel dispositif auto-configuré (par exemple, un routeur ou un pare-feu) vous voulez lancer sur la plateforme NE. Vous découvrirez les régions métropolitaines où les dispositifs virtuels sont disponibles, les fournisseurs de dispositifs, le nombre de cœurs disponibles, ainsi que les progiciels et leurs versions. Sélectionnez deviceTypeCode, metroCode, core, packageCode, et version.
Appelez [Get Allowed Interfaces] (/api-catalog/network-edgev1/#tag/NetworkEdge-Availability-and-Metros/operation/getAllowedInterfaces) pour connaître le nombre d'interfaces autorisées pour le cœur que vous avez sélectionné. Vous pouvez sélectionner n'importe quelle interface de périphérique disponible comme sshInterfaceId. Sinon, Equinix choisira la première interface disponible.
Appelez [Get Accounts {metro}] (/api-catalog/network-edgev1/#tag/NetworkEdge-Availability-and-Metros/operation/getMetros) pour vérifier votre numéro de compte (ou acountReferenceId) et votre statut dans le métro où vous voulez un appareil virtuel. Pour des raisons de facturation, vous devez avoir un compte dans le métro où vous voulez un appareil virtuel, soit dans l'état Actif, soit dans l'état En attente. Créez un [compte] (https://docs.equinix.com/en-us/Content/Interconnection/NE/user-guide/NE-billing-account-creation.htm) si vous n'en avez pas.

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 en statut actif ou en attente. Votre compte sera facturé, mais vous devez envoyer le numéro de compte du client à l'API pour créer un appareil pour votre client.

Étape 3 : Options de licence

Nous proposons une option de licence BYOL (Bring Your Own Licensing) pour la plupart des appareils. Téléchargez un fichier de licence ou un code/token/ID, en fonction de ce que votre fournisseur propose. Pour Cisco 8KV, vous disposez de l'option de licence par abonnement.

Arista : Nous ne prenons pas en charge le téléchargement d'une licence pour les appareils Arista. Cependant, vous pouvez vous connecter à votre appareil après sa création pour télécharger une licence afin d'augmenter votre débit.
Cisco et Palo Alto fournissent des jetons de licence. Entrez le jeton de licence dans le champ licenseToken.
Juniper fournit des fichiers de licence. Pour apporter votre propre licence (BYOL) pour un équipement Juniper, utilisez [Post License File] (/api-catalog/network-edgev1/#tag/NetworkEdge-Availability-and-Metros/operation/uploadLicense) pour télécharger un fichier de licence. Vous obtiendrez un identifiant de fichier que vous pourrez utiliser pour créer un dispositif virtuel. Si vous disposez d'un appareil Juniper redondant, vous pouvez utiliser le même ID de fichier pour l'appareil principal et l'appareil secondaire.
Fortinet : 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 appareil Fortinet, vous devez procéder 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 périphérique virtuel.
- Connectez-vous à l'appareil pour vérifier l'état de votre licence.

Étape 4 : Création d'un dispositif autoconfiguré

	POST /ne/v1/devices
Method	`POST`
URL or End Point	`/ne/v1/devices`
Headers	`Authorization` token, `Content-Type`
Query Parameters	`draft`, `draftUuid`

Pour créer un dispositif redondant avec des dispositifs primaires et secondaires :

Définir les paramètres de l'objet secondaire
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. Les numéros de compte primaire et secondaire doivent être identiques. Bien que le compte du revendeur soit facturé, 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.
Dans le cas des appareils Cisco FTD, le type de gestion doit être le même pour l'appareil principal et l'appareil secondaire.

note

En créant un appareil virtuel, vous acceptez les conditions de commande. Appelez Get Order Terms pour consulter les détails. Consultez Creating a Self-Configured Edge Device pour comprendre les détails de l'opération.

Pour enregistrer un projet d'appareil, vous devez fournir deviceTypeCode, accountNumber ou accountReferenceId, et metroCode.

Exemples de demandes

Un exemple de requête curl pour créer un seul appareil.

curl -X  
POST "https://api.equinix.com/ne/v1/devices?draft=false"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '  
{  
    "metroCode": "SV",  
    "deviceTypeCode": "VSRX",  
    "agreeOrderTerms": true,  
    "termLength": "1",  
    "licenseMode": "BYOL",  
    "packageCode": "STD",  
    "virtualDeviceName": "Test-device-001-SROY",  
    "notifications": [  
        "test@equinix.com"  
    ],  
    "hostNamePrefix": "TC12",  
    "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
    "accountNumber": "200541",  
    "version": "18.4R2-S1.4",  
    "interfaceCount": 10,  
    "deviceManagementType": "SELF-CONFIGURED",  
    "core": 5,  
    "userPublicKey": {  
        "username": "userName",  
        "keyName": "keyName"  
    },  
    "additionalBandwidth": "100"  
}  
'

Un exemple de requête curl pour créer un dispositif redondant.

curl -X  
POST "https://api.equinix.com/ne/v1/devices?draft=false"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '  
{  
    "metroCode": "DC",  
    "deviceTypeCode": "C8000V",  
    "agreeOrderTerms": true,  
    "termLength": "1",  
    "licenseMode": "BYOL",  
    "packageCode": "network-advantage",  
    "virtualDeviceName": "Test-device-002-SROY",  
    "notifications": [  
        "test@equinix.com"  
    ],  
    "hostNamePrefix": "TC01",  
        "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
    "accountNumber": "201148",  
    "version": "17.06.01a",  
    "interfaceCount": 10,  
    "deviceManagementType": "SELF-CONFIGURED",  
    "core": 2,  
    "userPublicKey": {  
        "username": "sroy",  
        "keyName": "keyWIQzB"  
    },  
    "sshInterfaceId": "3",  
    "channelPartner": "SDCI",  
    "secondary": {  
        "metroCode": "DC",  
        "hostNamePrefix": "TC02",  
        "notifications": [  
            "test@equinix.com"  
        ],  
        "virtualDeviceName": "Test-device-001-SROY - secondary",  
        "additionalBandwidth": "100",  
            "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
        "accountNumber": "201148",  
        "sshInterfaceId": "4"  
    },  
    "additionalBandwidth": "100"  
}  
'

Un exemple de requête curl pour créer un appareil secondaire Cisco FTD sans accès à l'internet.

curl -X  
POST "https://api.equinix.com/ne/v1/devices?draft=false"  
-H "content-type: application/json"  
-H "Authorization: Bearer <token>"  
-d '  
{  
    "deviceTypeCode": "Cisco_NGFW",  
    "licenseMode": "BYOL",  
    "packageCode": "FTDv5",  
    "virtualDeviceName": "NEAut-",  
    "metroCode": "#(supportedMetro)",  
    "notifications": [  
        "t@t.com"  
    ],  
    "hostNamePrefix": "test",  
    "interfaceCount": 10,  
    "deviceManagementType": "SELF-CONFIGURED",  
    "core": 4,  
    "version": "7.0.4-55",  
    "vendorConfig": {  
        "managementType": "FDM"  
    },  
    "connectivity": "PRIVATE",  
    "secondary": {  
        "hostNamePrefix": "test-123",  
        "metroCode": "#(supportedMetroForSec)",  
        "notifications": [  
            "t@t.com"  
        ],  
        "virtualDeviceName": "test-secondary",  
        "vendorConfig": {  
            "managementType": "FDM"  
        }  
    }  
}  
'

Pour une liste complète des paramètres et des options, consultez la [Référence API] (/api-catalog/network-edgev1#operation/createVirtualDevice).

Exemples de réponses

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"  
}

État de l'appareil

Surveillez l'état de votre appareil en appelant Get Virtual Device {uuid}. Votre appareil doit être provisionné et votre licence doit être enregistrée avant que vous puissiez vous connecter aux fournisseurs de services en nuage.

Virtual device "status"	Description
`INITIALIZING`	Equinix is in the process of reserving resources and creating the device.
`PROVISIONING`	The device is booting.
`PENDING_ORDER`	The order has come to NE from Siebel. Customers need to log in to the NE portal and submit the order.
`PENDING_SIGNATURE`	The customer has signed up for the offline acceptance of NE terms but has not yet accepted the terms.
`CANCEL_ORDER`	The order from Siebel to NE is canceled.
`WAITING_FOR_PRIMARY`	The secondary device is ready but the primary is not. This state might appear only if you have created a secondary device for redundancy.
`WAITING_FOR_SECONDARY`	The primary device is ready but the secondary is not. This state might appear only if you have created a secondary device for redundancy.
`FAILED`	The device creation failed.
`PROVISIONED`	The device is ready.

Lorsque les utilisateurs finaux suppriment un dispositif à l'aide de l'API Delete Virtual Devices, le dispositif passe par les états suivants au sein de l'infrastructure Equinix.

Virtual device "status" under /ne/v1/devices/{uuid}	Description
DEPROVISIONING	Equinix accepted the customer's request to delete a virtual device.
DEPROVISIONED	The device is de-provisioned/deleted.

Conditions préalables​

Étape 2 : Obtenir les détails de l'appareil​

Étape 3 : Options de licence​

Étape 4 : Création d'un dispositif autoconfiguré​

Exemples de demandes​

Exemples de réponses​

État de l'appareil​