Utilisation AWS Snow Device Management pour gérer les appareils Snow Family - AWS Snowball Edge Guide du développeur

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utilisation AWS Snow Device Management pour gérer les appareils Snow Family

AWS Snow Device Management vous permet de gérer à distance votre appareil Snow Family et les AWS services locaux. Tous les appareils Snow Family prennent en charge la gestion des appareils Snow, qui est installée sur les nouveaux appareils de Régions AWS la plupart des appareils Snow Family disponibles.

Avec Snow Device Management, vous pouvez effectuer les tâches suivantes :

  • Création d'une tâche

  • Vérifier l'état de la tâche

  • Vérifier les métadonnées des tâches

  • Annuler une tâche

  • Vérifiez les informations de l'appareil

  • Vérifiez l'état de l'instance EC2 compatible avec Amazon

  • Commandes de liste et syntaxe

  • Répertorier les appareils administrables à distance

  • Afficher l'état des tâches sur tous les appareils

  • Liste des ressources disponibles

  • Répertorier les tâches par statut

  • Répertorier les tags des appareils ou des tâches

  • Appliquer des balises

  • Supprimer les tags

Choix de l'état de gestion des appareils Snow lors de la commande d'un appareil Snow Family

Lorsque vous créez une tâche pour commander un appareil Snow, vous pouvez choisir dans quel état se trouvera Snow Device Management lorsque vous recevrez l'appareil : installé mais non activé ou installé et activé. S'il est installé mais qu'il n'est pas activé, vous devrez utiliser AWS OpsHub le client Snowball Edge pour l'activer avant de l'utiliser. S'il est installé et activé, vous pouvez utiliser Snow Device Management après avoir reçu l'appareil et l'avoir connecté à votre réseau local. Vous pouvez choisir l'état Snow Device Management lors de la création d'une tâche pour commander un appareil via le AWS Snow Family Management Console client Snowball Edge AWS CLI, la ou la gestion des tâches Snow. API

Pour choisir l'état Snow Device Management dans AWS Snow Family Management Console
  1. Pour choisir d'installer et d'activer Snow Device Management, choisissez Gérer votre appareil Snow à distance avec AWS OpsHub ou avec le client Snowball.

  2. Pour choisir d'installer Snow Device Management mais de ne pas l'activer, ne sélectionnez pas Gérer votre appareil Snow à distance avec AWS OpsHub le client Snowball.

Pour plus d'informations, voir Étape 3 : Choisissez vos fonctionnalités et options dans ce guide.

Pour choisir l'état Snow Device Management dans le AWS CLI client Snowball Edge ou dans la gestion des tâches Snow, procédez comme suit : API
  • Utilisez le remote-management paramètre pour spécifier l'état de Snow Device Management. La INSTALLED_ONLY valeur du paramètre signifie que Snow Device Management est installé mais n'est pas activé. La INSTALLED_AUTOSTART valeur du paramètre signifie que Snow Device Management est installé et activé. Si vous ne spécifiez aucune valeur pour ce paramètre, INSTALLED_ONLY c'est la valeur par défaut.

Exemple de la syntaxe du remote-management paramètre de la create-job commande
aws snowball create-job \ --job-type IMPORT \ --remote-management INSTALLED_AUTOSTART --device-configuration '{"SnowconeDeviceConfiguration": {"WirelessConnection": {"IsWifiEnabled": false} } }' \ --resources '{"S3Resources":[{"BucketArn":"arn:aws:s3:::bucket-name"}]}' \ --description "Description here" \ --address-id ADID00000000-0000-0000-0000-000000000000 \ --kms-key-arn arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab \ --role-arn arn:aws:iam::000000000000:role/SnowconeImportGamma \ --snowball-capacity-preference T8 \ --shipping-option NEXT_DAY \ --snowball-type SNC1_HDD \ --region us-west-2 \

Pour plus d'informations, consultez la section Job Management API Reference dans la AWS Snowball API référence.

Activation de la gestion des appareils Snow sur un appareil Snow Family

Suivez cette procédure pour activer Snow Device Management à l'aide du client Snowball Edge.

Avant d'utiliser cette procédure, procédez comme suit :

snowballEdge set-features / --remote-management-state INSTALLED_AUTOSTART / --manifest-file JID1717d8cc-2dc9-4e68-aa46-63a3ad7927d2_manifest.bin / --unlock-code 7c0e1-bab84-f7675-0a2b6-f8k33 / --endpoint https://192.0.2.0:9091

Le client Snowball Edge renvoie ce qui suit lorsque la commande aboutit.

{ "RemoteManagementState" : "INSTALLED_AUTOSTART" }

Ajouter des autorisations pour la gestion des appareils Snow à un IAM rôle sur un appareil Snow Family

Sur le périphérique Compte AWS à partir duquel l'appareil a été commandé, créez un rôle AWS Identity and Access Management (IAM) et ajoutez-y la politique suivante. Attribuez ensuite le rôle à l'IAMutilisateur qui se connectera pour gérer à distance votre appareil avec Snow Device Management. Pour plus d'informations, consultez les sections Création de IAM rôles et Création IAM d'un utilisateur dans votre Compte AWS.

Stratégie

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "snow-device-management:ListDevices", "snow-device-management:DescribeDevice", "snow-device-management:DescribeDeviceEc2Instances", "snow-device-management:ListDeviceResources", "snow-device-management:CreateTask", "snow-device-management:ListTasks", "snow-device-management:DescribeTask", "snow-device-management:CancelTask", "snow-device-management:DescribeExecution", "snow-device-management:ListExecutions", "snow-device-management:ListTagsForResource", "snow-device-management:TagResource", "snow-device-management:UntagResource" ], "Resource": "*" } ] }

CLICommandes de gestion des appareils Snow

Cette section décrit les AWS CLI commandes que vous pouvez utiliser pour gérer vos appareils de la gamme Snow à distance avec Snow Device Management. Vous pouvez également effectuer certaines tâches de gestion à distance à l'aide de AWS OpsHub for Snow Family. Pour plus d'informations, voir Gestion AWS des services sur votre appareil.

Note

Avant de gérer votre appareil, assurez-vous qu'il est allumé, connecté à votre réseau et qu'il peut se connecter à l' Région AWS endroit où il a été configuré.

Création d'une tâche pour gérer un appareil Snow Family avec Snow Device Management

Pour demander à un ou plusieurs équipements cibles d'effectuer une tâche, telle que le déverrouillage ou le redémarrage, utilisez. create-task Vous spécifiez les équipements cibles en fournissant une liste des appareils administrés IDs avec le --targets paramètre et en spécifiant les tâches à effectuer avec le --command paramètre. Une seule commande peut être exécutée sur un appareil à la fois.

Commandes prises en charge :

  • unlock(aucun argument)

  • reboot(aucun argument)

Pour créer une tâche à exécuter par les équipements cibles, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management create-task --targets smd-fictbgr3rbcjeqa5 --command reboot={}

Exceptions

ValidationException ResourceNotFoundException InternalServerException ThrottlingException AccessDeniedException ServiceQuotaExceededException

Sortie

{ "taskId": "st-ficthmqoc2pht111", "taskArn": "arn:aws:snow-device-management:us-west-2:000000000000:task/st-cjkwhmqoc2pht111" }

Vérifier l'état d'une tâche pour gérer un appareil Snow Family

Pour vérifier l'état d'une tâche distante exécutée sur une ou plusieurs machines cibles, utilisez la describe-execution commande.

Une tâche peut avoir l'un des états suivants :

  • QUEUED

  • IN_PROGRESS

  • CANCELED

  • FAILED

  • COMPLETED

  • REJECTED

  • TIMED_OUT

Pour vérifier l'état d'une tâche, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management describe-execution \ --taskId st-ficthmqoc2phtlef \ --managed-device-id smd-fictqic6gcldf111

Sortie

{ "executionId": "1", "lastUpdatedAt": "2021-07-22T15:29:44.110000+00:00", "managedDeviceId": "smd-fictqic6gcldf111", "startedAt": "2021-07-22T15:28:53.947000+00:00", "state": "SUCCEEDED", "taskId": "st-ficthmqoc2pht111" }

Vérifier les informations relatives à un appareil Snow Family à l'aide de Snow Device Management

Pour vérifier les informations spécifiques à l'appareil, telles que le type d'appareil, la version du logiciel, les adresses IP et l'état du verrouillage, utilisez la describe-device commande. La sortie inclut également les éléments suivants :

  • lastReachedOutAt— La dernière fois que l'appareil a contacté le AWS Cloud. Indique que l'appareil est en ligne.

  • lastUpdatedAt— Quand les données ont été mises à jour pour la dernière fois sur l'appareil. Indique à quel moment le cache de l'appareil a été actualisé.

Pour vérifier les informations de l'appareil, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management describe-device \ --managed-device-id smd-fictqic6gcldf111

Exceptions

ValidationException ResourceNotFoundException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "associatedWithJob": "JID2bf11d5a-ea1e-414a-b5b1-3bf7e6a6e111", "deviceCapacities": [ { "available": 158892032000, "name": "HDD Storage", "total": 158892032000, "unit": "Byte", "used": 0 }, { "available": 0, "name": "SSD Storage", "total": 0, "unit": "Byte", "used": 0 }, { "available": 3, "name": "vCPU", "total": 3, "unit": "Number", "used": 0 }, { "available": 5368709120, "name": "Memory", "total": 5368709120, "unit": "Byte", "used": 0 }, { "available": 0, "name": "GPU", "total": 0, "unit": "Number", "used": 0 } ], "deviceState": "UNLOCKED", "deviceType": "SNC1_HDD", "lastReachedOutAt": "2021-07-23T21:21:56.120000+00:00", "lastUpdatedAt": "2021-07-23T21:21:56.120000+00:00", "managedDeviceId": "smd-fictqic6gcldf111", "managedDeviceArn": "arn:aws:snow-device-management:us-west-2:000000000000:managed-device/smd-fictqic6gcldf111" "physicalNetworkInterfaces": [ { "defaultGateway": "10.0.0.1", "ipAddress": "10.0.0.2", "ipAddressAssignment": "DHCP", "macAddress": "ab:cd:ef:12:34:56", "netmask": "255.255.252.0", "physicalConnectorType": "RJ45", "physicalNetworkInterfaceId": "s.ni-530f866d526d4b111" }, { "defaultGateway": "10.0.0.1", "ipAddress": "0.0.0.0", "ipAddressAssignment": "STATIC", "macAddress": "ab:cd:ef:12:34:57", "netmask": "0.0.0.0", "physicalConnectorType": "RJ45", "physicalNetworkInterfaceId": "s.ni-8abc787f0a6750111" } ], "software": { "installState": "NA", "installedVersion": "122", "installingVersion": "NA" }, "tags": { "Project": "PrototypeA" } }

Vérification de l'état des instances EC2 compatibles avec Amazon sur les appareils de la gamme Snow avec Snow Device Management

Pour vérifier l'état actuel de l'EC2instance Amazon, utilisez la describe-ec2-instances commande. Le résultat est similaire à celui de la describe-device commande, mais les résultats proviennent du cache du périphérique dans le AWS Cloud et incluent un sous-ensemble des champs disponibles.

Pour vérifier l'état de l'instance EC2 compatible avec Amazon, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management describe-device-ec2-instances \ --managed-device-id smd-fictbgr3rbcje111 \ --instance-ids s.i-84fa8a27d3e15e111

Exceptions

ValidationException ResourceNotFoundException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "instances": [ { "instance": { "amiLaunchIndex": 0, "blockDeviceMappings": [ { "deviceName": "/dev/sda", "ebs": { "attachTime": "2021-07-23T15:25:38.719000-07:00", "deleteOnTermination": true, "status": "ATTACHED", "volumeId": "s.vol-84fa8a27d3e15e111" } } ], "cpuOptions": { "coreCount": 1, "threadsPerCore": 1 }, "createdAt": "2021-07-23T15:23:22.858000-07:00", "imageId": "s.ami-03f976c3cadaa6111", "instanceId": "s.i-84fa8a27d3e15e111", "state": { "name": "RUNNING" }, "instanceType": "snc1.micro", "privateIpAddress": "34.223.14.193", "publicIpAddress": "10.111.60.160", "rootDeviceName": "/dev/sda", "securityGroups": [ { "groupId": "s.sg-890b6b4008bdb3111", "groupName": "default" } ], "updatedAt": "2021-07-23T15:29:42.163000-07:00" }, "lastUpdatedAt": "2021-07-23T15:29:58. 071000-07:00" } ] }

Afficher les métadonnées des tâches sur les appareils de la gamme Snow avec Snow Device Management

Pour vérifier les métadonnées d'une tâche donnée sur un appareil, utilisez la describe-task commande. Les métadonnées d'une tâche incluent les éléments suivants :

  • Les appareils cibles

  • État de la tâche

  • Quand la tâche a été créée

  • Quand les données ont été mises à jour pour la dernière fois sur l'appareil

  • Quand la tâche a été terminée

  • Description (le cas échéant) fournie lors de la création de la tâche

Pour vérifier les métadonnées d'une tâche, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management describe-task \ --task-id st-ficthmqoc2pht111

Exceptions

ValidationException ResourceNotFoundException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "completedAt": "2021-07-22T15:29:46.758000+00:00", "createdAt": "2021-07-22T15:28:42.613000+00:00", "lastUpdatedAt": "2021-07-22T15:29:46.758000+00:00", "state": "COMPLETED", "tags": {}, "targets": [ "smd-fictbgr3rbcje111" ], "taskId": "st-ficthmqoc2pht111", "taskArn": "arn:aws:snow-device-management:us-west-2:000000000000:task/st-ficthmqoc2pht111" }

Annulation d'une tâche sur un appareil Snow Family avec Snow Device Management

Pour envoyer une demande d'annulation pour une tâche spécifique, utilisez la cancel-task commande. Vous ne pouvez annuler que les tâches dont l'QUEUEDétat n'a pas encore été exécuté. Les tâches déjà en cours ne peuvent pas être annulées.

Note

Une tâche que vous tentez d'annuler peut toujours être exécutée si elle est traitée depuis la file d'attente avant que la cancel-task commande ne modifie l'état de la tâche.

Pour annuler une tâche, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management cancel-task \ --task-id st-ficthmqoc2pht111

Exceptions

ValidationException ResourceNotFoundException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "taskId": "st-ficthmqoc2pht111" }

Liste des commandes et de la syntaxe de Snow Device Management

Pour renvoyer une liste de toutes les commandes prises en charge pour le Snow Device ManagementAPI, utilisez la help commande. Vous pouvez également utiliser la help commande pour renvoyer des informations détaillées et la syntaxe d'une commande donnée.

Pour répertorier toutes les commandes prises en charge, utilisez la commande suivante.

Commande

aws snow-device-management help

Pour renvoyer des informations détaillées et la syntaxe d'une commande, utilisez la commande suivante. commandRemplacez-le par le nom de la commande qui vous intéresse.

Commande

aws snow-device-management command help

Liste des appareils de la gamme Snow disponibles pour la gestion à distance

Pour afficher la liste de tous les appareils de votre compte sur lesquels la gestion des appareils Snow est activée sur l' Région AWS endroit où la commande est exécutée, utilisez la list-devices commande. --max-resultset --next-token sont facultatifs. Pour plus d'informations, consultez la section Utilisation des options de AWS CLI pagination dans le « Guide de l'utilisateur de l'interface de ligne de AWS commande ».

Pour répertorier les appareils administrables à distance, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management list-devices \ --max-results 10

Exceptions

ValidationException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "devices": [ { "associatedWithJob": "ID2bf11d5a-ea1e-414a-b5b1-3bf7e6a6e111", "managedDeviceId": "smd-fictbgr3rbcjeqa5", "managedDeviceArn": "arn:aws:snow-device-management:us-west-2:000000000000:managed-device/smd-fictbgr3rbcje111" "tags": {} } ] }

Liste de l'état des tâches de gestion des appareils Snow sur les appareils de la gamme Snow

Pour renvoyer l'état des tâches pour une ou plusieurs machines cibles, utilisez la list-executions commande. Pour filtrer la liste des résultats afin d'afficher les tâches qui se trouvent actuellement dans un seul état spécifique, utilisez le --state paramètre. --max-resultset --next-token sont facultatifs. Pour plus d'informations, consultez la section Utilisation des options de AWS CLI pagination dans le « Guide de l'utilisateur de l'interface de ligne de AWS commande ».

Une tâche peut avoir l'un des états suivants :

  • QUEUED

  • IN_PROGRESS

  • CANCELED

  • FAILED

  • COMPLETED

  • REJECTED

  • TIMED_OUT

Pour répertorier l'état des tâches sur tous les appareils, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management list-executions \ --taskId st-ficthmqoc2phtlef \ --state SUCCEEDED \ --max-results 10

Exceptions

ValidationException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "executions": [ { "executionId": "1", "managedDeviceId": "smd-fictbgr3rbcje111", "state": "SUCCEEDED", "taskId": "st-ficthmqoc2pht111" } ] }

Répertorier les ressources disponibles sur les appareils de la gamme Snow avec Snow Device Management

Pour renvoyer la liste des AWS ressources disponibles pour un appareil, utilisez la list-device-resources commande. Pour filtrer la liste en fonction d'un type de ressource spécifique, utilisez le --type paramètre. Actuellement, les instances EC2 compatibles avec Amazon sont le seul type de ressource pris en charge. --max-resultset --next-token sont facultatifs. Pour plus d'informations, consultez la section Utilisation des options de AWS CLI pagination dans le « Guide de l'utilisateur de l'interface de ligne de AWS commande ».

Pour répertorier les ressources disponibles pour un appareil, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management list-device-resources \ --managed-device-id smd-fictbgr3rbcje111 \ --type AWS::EC2::Instance --next-token YAQGPwAT9l3wVKaGYjt4yS34MiQLWvzcShe9oIeDJr05AT4rXSprqcqQhhBEYRfcerAp0YYbJmRT= --max-results 10

Exceptions

ValidationException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "resources": [ { "id": "s.i-84fa8a27d3e15e111", "resourceType": "AWS::EC2::Instance" } ] }

Répertorier les tags pour les appareils Snow Family ou les tags Snow Device Management

Pour renvoyer une liste de balises pour un appareil géré ou une tâche, utilisez la list-tags-for-resource commande.

Pour répertorier les tags d'un appareil, utilisez la commande suivante. Remplacez l'exemple Amazon Resource Name (ARN) par celui ARN de votre appareil.

Commande

aws snow-device-management list-tags-for-resource --resource-arn arn:aws:snow-device-management:us-west-2:123456789012:managed-device/smd-fictbgr3rbcjeqa5

Exceptions

AccessDeniedException InternalServerException ResourceNotFoundException ThrottlingException

Sortie

{ "tags": { "Project": "PrototypeA" } }

Répertorier les tâches de gestion des appareils Snow par statut

Utilisez la list-tasks commande pour renvoyer une liste des tâches depuis les appareils de la AWS région où la commande est exécutée. Pour filtrer les résultats par IN_PROGRESSCOMPLETED, ou par CANCELED statut, utilisez le --state paramètre. --max-resultset --next-token sont facultatifs. Pour plus d'informations, consultez la section Utilisation des options de AWS CLI pagination dans le « Guide de l'utilisateur de l'interface de ligne de AWS commande ».

Pour répertorier les tâches par statut, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management list-tasks \ --state IN_PROGRESS \ --next-token K8VAMqKiP2Cf4xGkmH8GMyZrgOF8FUb+d1OKTP9+P4pUb+8PhW+6MiXh4= \ --max-results 10

Exceptions

ValidationException InternalServerException ThrottlingException AccessDeniedException

Sortie

{ "tasks": [ { "state": "IN_PROGRESS", "tags": {}, "taskId": "st-ficthmqoc2phtlef", "taskArn": "arn:aws:snow-device-management:us-west-2:000000000000:task/st-ficthmqoc2phtlef" } ] }

Appliquer des tags aux tâches de gestion des appareils Snow ou aux appareils Snow Family

Pour ajouter ou remplacer une étiquette pour un appareil ou pour une tâche sur un appareil, utilisez la tag-resource commande. Le --tags paramètre accepte une liste de paires séparées par des virgules. Key=Value

Pour appliquer des balises à un appareil, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management tag-resource \ --resource-arn arn:aws:snow-device-management:us-west-2:123456789012:managed-device/smd-fictbgr3rbcjeqa5 \ --tags Project=PrototypeA

Exceptions

AccessDeniedException InternalServerException ResourceNotFoundException ThrottlingException

Supprimer les balises Snow Device Management des tâches ou des appareils Snow Family

Pour supprimer une étiquette d'un appareil ou d'une tâche sur un appareil, utilisez la untag-resources commande.

Pour supprimer les tags d'un appareil, utilisez la commande suivante. Remplacez chaque user input placeholder par vos propres informations.

Commande

aws snow-device-management untag-resources \ --resource-arn arn:aws:snow-device-management:us-west-2:123456789012:managed-device/smd-fictbgr3rbcjeqa5 \ --tag-keys Project

Exceptions

AccessDeniedException InternalServerException ResourceNotFoundException ThrottlingException