Créer un appareil

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

Appelez Get Device Types pour identifier le périphérique autoconfiguré (routeur ou pare-feu, par exemple) à déployer sur la plateforme NE. Vous obtiendrez des renseignements sur les régions métropolitaines où les appareils virtuels sont disponibles, leurs fournisseurs, 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 pour connaître le nombre d'interfaces autorisées pour le cœur sélectionné. Vous pouvez choisir n'importe quelle interface disponible comme sshInterfaceId. Sinon, Equinix choisira la première interface disponible.
Appelez Get Accounts {metro} pour vérifier votre numéro de compte (ou acountReferenceId) et son statut dans la zone métropolitaine où vous souhaitez déployer un périphérique virtuel. Pour des raisons de facturation, vous devez avoir un compte dans cette zone, qu'il soit actif ou en attente. Si vous n'en avez pas, créez un compte.

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 pour créer l'appareil.

É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/identifiant, selon la disponibilité de votre fournisseur. Pour Cisco 8KV, vous disposez de l'option de licence par abonnement.

Arista: Nous ne prenons pas en charge le téléchargement de licences pour les appareils Arista. Cependant, vous pouvez vous connecter à votre appareil après sa création pour télécharger une licence et 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 utiliser votre propre licence (BYOL) pour un équipement Juniper, utilisez Post License File afin de télécharger un fichier de licence. Vous obtiendrez un identifiant de fichier pour créer un équipement virtuel. Si vous avez de l'équipement Juniper redondant, vous pouvez utiliser le même identifiant pour les équipements principal et secondaire.
Fortinet: La licence n’est pas obligatoire pour les appareils Fortinet lors de leur création. Si vous avez un jeton, entrez-le dans le champ licenseToken. Pour configurer un fichier de licence pour un appareil 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 appareil virtuel.
- Connectez-vous à l'appareil pour vérifier l'état de votre licence.

Étape 4: Créer un appareil auto-configuré

	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 périphérique redondant doté de périphériques principaux et secondaires:

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

remarque

En créant un appareil virtuel, vous acceptez les conditions générales de vente. Consultez Obtenir les conditions générales de vente pour en prendre connaissance. Pour comprendre les modalités commerciales, consultez Création d'un périphérique Edge autoconfiguré.

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

Exemples de demandes

Un exemple de demande curl pour créer un seul périphérique.

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 périphérique 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 demande curl pour créer un périphérique secondaire Cisco FTD sans accès 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.

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 périphérique 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 approvisionné et votre licence enregistrée avant de pouvoir vous connecter aux fournisseurs de services cloud.

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.

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.

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.

Préalable​

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

Étape 3: Options de licence​

Étape 4: Créer un appareil auto-configuré​

Exemples de demandes​

Exemples de réponses​

État de l'appareil​