Usar o AWS Snow Device Management para gerenciar dispositivos da família Snow. - Guia do desenvolvedor do AWS Snowball Edge
Escolher o estado do Snow Device Management ao solicitar um dispositivo da família SnowAtivar o Snow Device Management em um dispositivo da família SnowAdicionar permissões para o Snow Device Management a um perfil do IAM em um dispositivo da família SnowComandos da CLI do Snow Device Management

Usar o AWS Snow Device Management para gerenciar dispositivos da família Snow.

O AWS Snow Device Management permite que você gerencie seu dispositivo da Família Snow e serviços da AWS locais remotamente. Todos os dispositivos da família Snow aceitam o Snow Device Management e ele vem instalado em novos dispositivos na maioria das Regiões da AWS em que os dispositivos da família Snow estão disponíveis.

Com o Snow Device Management, é possível realizar as seguintes tarefas:

  • Criar uma tarefa

  • Verificar o status da tarefa

  • Verificar metadados de tarefas

  • Cancelar uma tarefa

  • Verifique as informações do dispositivo

  • Verifique o estado da instância compatível com o Amazon EC2

  • Listar comandos e sintaxe

  • Listar dispositivos gerenciáveis remotamente

  • Listar o status da tarefa em todos os dispositivos

  • Listar atributos disponíveis

  • Listar tarefas por status

  • Listar tags de dispositivo ou tarefa

  • Aplicar etiquetas

  • Remover marcações

Escolher o estado do Snow Device Management ao solicitar um dispositivo da família Snow

Quando um trabalho é criado para solicitar um dispositivo Snow, é possível escolher em qual estado o Snow Device Management estará quando receber o dispositivo: instalado, mas não ativado ou instalado e ativado. Se ele estiver instalado, mas não ativado, você precisará usar o AWS OpsHub ou o Snowball Edge Client para ativá-lo antes de usá-lo. Se estiver instalado e ativado, você poderá usar o Snow Device Management depois de receber o dispositivo e conectá-lo à rede local. É possível escolher o estado do Snow Device Management quando um trabalho para solicitar um dispositivo é criado por meio do Console de Gerenciamento da família AWS Snow do Snowball Edge Cliente, da AWS CLI ou da API de gerenciamento de trabalhos do Snow.

Como escolher o estado do Snow Device Management no Console de Gerenciamento da família AWS Snow

  1. Para escolher que o Snow Device Management seja instalado e ativado, escolha Gerenciar o dispositivo Snow remotamente com o AWS OpsHub ou um cliente do Snowball.

  2. Para escolher que o Snow Device Management seja instalado, mas não ativado, não selecione Gerenciar o dispositivo Snow remotamente com o AWS OpsHub ou o cliente do Snowball.

Para ter mais informações, consulte Etapa 3: escolher os recursos e as opções neste guia.

Para escolher o estado do Snow Device Management da AWS CLI, o Snowball Edge Client ou a API de gerenciamento de trabalhos do Snow:

  • Use o parâmetro remote-management para especificar o estado do Snow Device Management. O valor INSTALLED_ONLY do parâmetro significa que o Snow Device Management está instalado, mas não ativado. O valor INSTALLED_AUTOSTART do parâmetro significa que o Snow Device Management está instalado e ativado. Se você não especificar um valor para esse parâmetro, INSTALLED_ONLY será o valor padrão.

exemplo da sintaxe do parâmetro remote-management do comando create-job

  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 \

Para ter mais informações, consulte Referência da API de gerenciamento de trabalhos na Referência de API do AWS Snowball.

Ativar o Snow Device Management em um dispositivo da família Snow

Siga este procedimento para ativar o Snow Device Management usando o Snowball Edge Client.

Antes de usar este procedimento, faça o seguinte:


  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

O Snowball Edge Client exibe o seguinte quando o comando é bem-sucedido.


  {
    "RemoteManagementState" : "INSTALLED_AUTOSTART"
  }

Adicionar permissões para o Snow Device Management a um perfil do IAM em um dispositivo da família Snow

Na Conta da AWS da qual o dispositivo foi pedido, crie um perfil do AWS Identity and Access Management (IAM) e adicione a política a seguir ao perfil. Em seguida, atribua a função ao usuário do IAM que fará login para gerenciar remotamente seu dispositivo com o Snow Device Management. Para obter mais informações, consulte Criação de perfis do IAM e Criação de um usuário do IAM na sua Conta da AWS.

Política


{
    "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": "*" 
        }
    ]
}

Comandos da CLI do Snow Device Management

Esta seção descreve os comandos AWS CLI que você pode usar para gerenciar remotamente os dispositivos da Família Snow remotamente com o Snow Device Management. Você também pode realizar algumas tarefas de gerenciamento remoto usando o AWS OpsHub for Snow Family. Para ter mais informações, consulte Managing AWS services on your device.

nota

Antes de gerenciar seu dispositivo, verifique se ele está ligado, conectado à sua rede e pode se conectar à Região da AWS onde foi provisionado.

Criar uma tarefa para gerenciar um dispositivo da família Snow com o Snow Device Management

Para instruir um ou mais dispositivos de destino a realizar uma tarefa, como desbloquear ou reinicializar, use create-task. Você especifica os dispositivos de destino fornecendo uma lista de IDs de dispositivos gerenciados com o parâmetro --targets e especifica as tarefas a serem executadas com o parâmetro --command. Somente um único comando pode ser executado em um dispositivo por vez.

Comandos compatíveis:

  • unlock (sem argumentos)

  • reboot (sem argumentos)

Para criar uma tarefa a ser executada pelos dispositivos de destino, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções


ValidationException
ResourceNotFoundException
InternalServerException
ThrottlingException
AccessDeniedException
ServiceQuotaExceededException

Saída


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

Conferir o status de uma tarefa para gerenciar um dispositivo da família Snow

Para verificar o status de uma tarefa remota em execução em um ou mais dispositivos de destino, use o comando describe-execution.

Uma tarefa pode ter um dos seguintes estados:

  • QUEUED

  • IN_PROGRESS

  • CANCELED

  • FAILED

  • COMPLETED

  • REJECTED

  • TIMED_OUT

Para verificar o status de uma tarefa, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Saída


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

Conferir informações sobre um dispositivo da família Snow usando o Snow Device Management

Para verificar informações específicas do dispositivo, como tipo de dispositivo, versão do software, endereços IP e status do bloqueio, use o comando describe-device. A saída inclui o seguinte:

  • lastReachedOutAt: quando o dispositivo entrou em contato pela última vez com a Nuvem AWS. Indica que o dispositivo está on-line.

  • lastUpdatedAt: quando os dados foram atualizados pela última vez no dispositivo. Indica quando o cache do dispositivo foi atualizado.

Para verificar as informações do dispositivo, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções



ValidationException
ResourceNotFoundException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


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

Conferir estados de instâncias compatíveis com o Amazon EC2 em dispositivos da família Snow com o Snow Device Management

Para verificar o estado atual da instância do Amazon EC2, use o comando describe-ec2-instances. A saída é semelhante à do comando describe-device, mas os resultados são provenientes do cache do dispositivo Nuvem AWS e incluem um subconjunto dos campos disponíveis.

Para verificar o estado da instância compatível com o Amazon EC2, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções



ValidationException
ResourceNotFoundException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


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

Visualizar metadados de tarefas em dispositivos da família Snow com o Snow Device Management

Para verificar os metadados de uma determinada tarefa em um dispositivo, use o comando describe-task. Os metadados de uma tarefa incluem os seguintes itens:

  • Os dispositivos de destino

  • O status da tarefa

  • Quando a tarefa foi criada

  • Quando os dados foram atualizados pela última vez no dispositivo

  • Quando a tarefa foi concluída

  • A descrição (se houver) fornecida quando a tarefa foi criada

Para verificar os metadados de uma tarefa, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções



ValidationException
ResourceNotFoundException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


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

Cancelar uma tarefa em um dispositivo da família Snow com o Snow Device Management

Para enviar uma solicitação de cancelamento para uma tarefa específica, use o comando cancel-task. Você pode cancelar somente tarefas no estado QUEUED que ainda não foram executadas. As tarefas que já estão em execução não podem ser canceladas.

nota

Uma tarefa que você está tentando cancelar ainda pode ser executada se for processada na fila antes que o comando cancel-task altere o estado da tarefa.

Para cancelar uma tarefa, use o seguinte comando. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções



ValidationException
ResourceNotFoundException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


{
    "taskId": "st-ficthmqoc2pht111"
}

Listar os comandos e a sintaxe do Snow Device Management

Para retornar uma lista de todos os comandos compatíveis com a API Snow Device Management, use o comando help. Você também pode usar o comando help para retornar informações detalhadas e a sintaxe de um determinado comando.

Para listar todos os comandos suportados, use o comando a seguir.

Comando


aws snow-device-management help

Para retornar informações e sintaxe detalhadas de um comando, use o comando a seguir. Substitua command pelo nome do comando no qual você está interessado.

Comando


aws snow-device-management command help

Listar os dispositivos da família Snow disponíveis para gerenciamento remoto

Para retornar uma lista de todos os dispositivos em sua conta que têm o Snow Device Management ativado na Região da AWS em que o comando é executado, use o comando list-devices. --max-results e --next-token são opcionais. Para obter mais informações, consulte Como usar as opções de paginação do AWS CLI no "Manual do usuário da interface de linha de comando da AWS".

Para listar dispositivos gerenciáveis remotamente, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções



ValidationException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


{
    "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": {}
        }
    ]
}

Listar o status das tarefas do Snow Device Management nos dispositivos da família Snow

Para retornar o status das tarefas de um ou mais dispositivos de destino, use o comando list-executions. Para filtrar a lista de retorno para mostrar as tarefas que estão atualmente em um único estado específico, use o parâmetro --state. --max-results e --next-token são opcionais. Para obter mais informações, consulte Como usar as opções de paginação do AWS CLI no "Manual do usuário da interface de linha de comando da AWS".

Uma tarefa pode ter um dos seguintes estados:

  • QUEUED

  • IN_PROGRESS

  • CANCELED

  • FAILED

  • COMPLETED

  • REJECTED

  • TIMED_OUT

Para listar o status da tarefa nos dispositivos, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções



ValidationException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


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

Listar os recursos disponíveis em dispositivos da família Snow com o Snow Device Management

Para retornar uma lista dos atributos da AWS disponíveis para um dispositivo, use o comando list-device-resources. Para filtrar a lista por um tipo específico de recurso, use o parâmetro --type. Atualmente, as instâncias compatíveis com o Amazon EC2 são o único tipo de atributo compatível. --max-results e --next-token são opcionais. Para obter mais informações, consulte Como usar as opções de paginação do AWS CLI no "Manual do usuário da interface de linha de comando da AWS".

Para listar os atributos disponíveis para um dispositivo, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções



ValidationException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


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

Listar tags para dispositivos da família Snow ou tags do Snow Device Management

Para retornar uma lista de etiquetas de um dispositivo ou tarefa gerenciada, use o comando list-tags-for-resource.

Para listar as tags para um dispositivo, use o comando a seguir. Substitua o nome do recurso da Amazon (ARN) de exemplo pelo ARN de seu dispositivo.

Comando


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

Exceções


AccessDeniedException
InternalServerException
ResourceNotFoundException
ThrottlingException

Saída


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

Listar as tarefas do Snow Device Management por status

Use o comando list-tasks para retornar uma lista de tarefas dos dispositivos na região AWS em que o comando é executado. Para filtrar os resultados pelos status IN_PROGRESS, COMPLETED ou CANCELED, use o parâmetro --state. --max-results e --next-token são opcionais. Para obter mais informações, consulte Como usar as opções de paginação do AWS CLI no "Manual do usuário da interface de linha de comando da AWS".

Para listar as tarefas por status, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções


ValidationException
InternalServerException
ThrottlingException
AccessDeniedException

Saída


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

Aplicar tags às tarefas do Snow Device Management para dispositivos da família Snow

Para adicionar ou substituir uma tag em um dispositivo ou em uma tarefa em um dispositivo, use o comando tag-resource. O parâmetro --tags aceita uma lista de separados por vírgula Key=Value.

Para aplicar etiquetas a um dispositivo, use o comando a seguir. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções


AccessDeniedException
InternalServerException
ResourceNotFoundException
ThrottlingException

Remover tags do Snow Device Management de tarefas ou de dispositivos da família Snow

Para remover uma tag de um dispositivo ou de uma tarefa em um dispositivo, use o comando untag-resources.

Execute o comando a seguir para remover tags de um dispositivo. Substitua cada user input placeholder por suas próprias informações.

Comando


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

Exceções


AccessDeniedException
InternalServerException
ResourceNotFoundException
ThrottlingException