Créer un appareil

Conditions préalables

Authentifier - envoyez vos identifiants utilisateur, votre identifiant client et votre secret client pour l'authentification OAuth2. Pour obtenir des instructions sur la façon d'appeler l'API OAuth pour valider et authentifier vos identifiants, reportez-vous à authentification API.

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

Appelez obtenir les types de dispositif pour savoir quel dispositif auto-configuré (par exemple, routeur ou pare-feu) vous souhaitez lancer sur la plateforme ne. Vous découvrirez les régions métropolitaines où des dispositifs virtuels sont disponibles, les fournisseurs de dispositifs, le nombre de cœurs disponibles, les packages logiciels et leurs versions. Sélectionnez deviceTypeCode, metroCode, , core, packageCodeet version.
Appelez Get Allowed interfaces pour connaître le nombre d'interfaces autorisé pour votre core sélectionné. Vous pouvez sélectionner n'importe quelle interface de dispositif disponible comme sshInterfaceId. Dans le cas contraire, Equinix choisira la première interface disponible.
Appelez obtenir des comptes {metro} pour vérifier votre numéro de compte (ou accountReferenceId) et le statut dans la zone métropolitaine où vous souhaitez un appareil virtuel. Pour des raisons de facturation, vous devez disposer d'un compte dans la zone métropolitaine où vous souhaitez un appareil virtuel, à l'état actif ou en attente. Si vous n'en avez pas, créez uncompte.

Si vous êtes un revendeur qui tente de créer un appareil pour votre client, vous devez vous assurer que les comptes du client et de votre (revendeur) sont tous deux à l'état actif ou en attente. Votre compte sera facturé, mais vous devez envoyer le numéro de compte du client au API afin de créer un appareil pour votre client.

Étape 3 : Options de licence

Nous proposons BYOL (Bring Your Own Licensing) comme option de licence pour la plupart des appareils. Téléchargez un fichier de licence ou un code/jeton/identifiant, selon ce que votre fournisseur propose. Pour Cisco 8000V, vous disposez de l'option de licence par abonnement.

Arista : Nous ne prenons pas en charge le téléchargement d'une licence pour un appareil 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. Saisissez le jeton de licence dans le licenseToken champ.
Juniper fournit des fichiers de licence. Pour apporter votre propre licence (BYOL) pour un appareil Juniper, utilisez le fichier post-licence 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 équipement Juniper redondant, vous pouvez utiliser le même identifiant de fichier pour les équipements principal et 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 licenseToken champ. 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 le fichier post-licence . Vous obtiendrez un fileId que vous pouvez utiliser pour créer un appareil virtuel.
- Connectez-vous à l'appareil pour vérifier l'état de votre licence.

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

	PUBLIER /ne/v1/devices
Méthode	`POST`
URL ou point de terminaison	`/ne/v1/devices`
En-têtes	`Authorization` jeton, `Content-Type`
Paramètres de requête	`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
En tant que revendeur, vous tentez de créer un appareil redondant pour votre client, assurez-vous que les métros principale et secondaire se trouvent dans le même pays. Les numéros de compte principal et secondaire doivent être identiques. Bien que le compte du revendeur soit facturé, 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.
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 dispositif virtuel, vous acceptez les conditions de commande. Appelez obtenir les conditions de la commande pour consulter les détails.

Pour enregistrer un brouillon de dispositif, 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": "23.2R1.13",  
    "interfaceCount": 8,  
    "deviceManagementType": "SELF-CONFIGURED",  
    "core": 2,  
    "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-001-SROY - primary",  
    "notifications": [  
        "test@equinix.com"  
    ],  
    "hostNamePrefix": "TC01",  
        "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
    "accountNumber": "201148",  
    "version": "17.06.06a",  
    "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-002-SROY - secondary",  
        "additionalBandwidth": "100",  
            "aclDetails": [  
        {  
            "uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",  
            "interfaceType": "WAN"  
        }  
    ],  
        "accountNumber": "201148",  
        "sshInterfaceId": "4"  
    }  
}  
'

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": "DC",  
    "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": "DC",  
        "notifications": [  
            "t@t.com"  
        ],  
        "virtualDeviceName": "test-secondary",  
        "vendorConfig": {  
            "managementType": "FDM"  
        }  
    }  
}  
'

Pour obtenir la liste complète des paramètres et des options, reportez-vous à 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 dispositif redondant. 202 : Demande acceptée.

{  
    "uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",  
    "secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"  
}

État du dispositif

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 de pouvoir vous connecter à des fournisseurs de services cloud.

« État » du dispositif virtuel	Description
`INITIALIZING`	Equinix est en train de réserver des ressources et de créer l'appareil.
`PROVISIONING`	L'appareil est en cours de démarrage.
`PENDING_ORDER`	La commande a été envoyée à ne par Siebel. Les clients doivent se connecter au portail ne et soumettre la commande.
`PENDING_SIGNATURE`	Le client s'est inscrit pour l'acceptation hors ligne des conditions NE mais n'a pas encore accepté les conditions.
`CANCEL_ORDER`	La commande de Siebel à NE est annulée.
`WAITING_FOR_PRIMARY`	Le dispositif secondaire est prêt, mais pas le dispositif principal. Cet état peut apparaître uniquement si vous avez créé un dispositif secondaire pour la redondance.
`WAITING_FOR_SECONDARY`	Le dispositif principal est prêt, mais pas le dispositif secondaire. Cet état peut apparaître uniquement si vous avez créé un dispositif secondaire pour la redondance.
`FAILED`	La création de l'appareil a échoué.
`PROVISIONED`	L'appareil est prêt.

Lorsque les utilisateurs finaux suppriment un appareil à l'aide de l'APIde suppression de périphériques virtuels, l'appareil passe par les états suivants au sein de l' infrastructure Equinix.

« Statut » du périphérique virtuel sous /ne/v1/devices/{uuid}	Description
DÉPROVISIONNEMENT	Equinix a accepté la demande du client de supprimer un appareil virtuel.
DÉPROVISIONNÉ	L'appareil est déprovisionné/supprimé.

Conditions préalables​

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

Étape 3 : Options de licence​

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

Exemples de demandes​

Exemples de réponses​

État du dispositif​