REST Resource: customer.devices.chromeos.commands

Recurso: DirectoryChromeosdevicesCommand

Informações sobre um comando emitido para um dispositivo.

Representação JSON 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Campos
commandId

string (int64 format)

ID exclusivo de um comando do dispositivo.
type

enum (CommandType)

O tipo de comando.
issueTime

string (Timestamp format)

O carimbo de data/hora em que o comando foi emitido pelo administrador.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Indica o estado do comando.
commandExpireTime

string (Timestamp format)

A hora em que o comando vai expirar. Se o dispositivo não executar o comando nesse período, ele vai expirar.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
commandResult

object (DirectoryChromeosdevicesCommandResult)

O resultado da execução do comando.
payload

string

O payload especificado pelo comando, se houver.

CommandType

Estabelece o tipo de comando que o dispositivo precisa executar.

Enums
COMMAND_TYPE_UNSPECIFIED O tipo de comando não foi especificado.
REBOOT Reinicialize o dispositivo. Pode ser emitido para dispositivos de sessão de visitante gerenciada e de quiosque, além de dispositivos comuns com o ChromeOS 113 ou mais recente.
TAKE_A_SCREENSHOT Faça uma captura de tela do dispositivo. Disponível apenas se o dispositivo estiver no modo quiosque.
SET_VOLUME Define o volume do dispositivo. Só pode ser emitido para dispositivos de quiosque e sessão de visitante gerenciada.
WIPE_USERS Exclua todos os usuários do dispositivo permanentemente. Executar esse comando no dispositivo remove todos os dados do perfil do usuário, mas mantém o registro e a política do dispositivo.
REMOTE_POWERWASH Limpa o dispositivo com um Power wash. Executar esse comando no dispositivo vai remover todos os dados, inclusive as políticas do usuário, do dispositivo e de registro. Aviso: a configuração original do dispositivo será restaurada sem o registro, a menos que ele esteja sujeito ao registro forçado ou automático. Use com cuidado, já que essa é uma ação irreversível.
DEVICE_START_CRD_SESSION Inicia uma sessão da Área de trabalho remota do Google Chrome.
CAPTURE_LOGS Captura os registros do sistema de um dispositivo de quiosque. É possível fazer o download dos registros no link downloadUrl presente no campo deviceFiles de chromeosdevices
FETCH_SUPPORT_PACKET Busque remotamente o pacote de suporte de um dispositivo. O pacote de suporte é um arquivo ZIP que contém vários registros do sistema e dados de depuração de um dispositivo ChromeOS. Faça o download do pacote de suporte usando o link downloadURL presente no campo deviceFiles de chromeosdevices

Estado

Representa o estado do comando emitido.

Enums
STATE_UNSPECIFIED O status do comando não foi especificado.
PENDING Um comando não expirado ainda não enviado ao cliente.
EXPIRED O comando não foi executado pelo cliente no tempo esperado.
CANCELLED O comando é cancelado pelo administrador enquanto está em PENDENTE.
SENT_TO_CLIENT O comando foi enviado ao cliente.
ACKED_BY_CLIENT O cliente respondeu que recebeu o comando.
EXECUTED_BY_CLIENT O cliente não executou o comando com sucesso.

DirectoryChromeosdevicesCommandResult

O resultado da execução de um comando.

Representação JSON 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Campos
result

enum (CommandResultType)

O resultado do comando.
executeTime

string (Timestamp format)

O horário em que o comando foi executado ou apresentou falha.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
errorMessage

string

A mensagem de erro com uma breve explicação do motivo da falha do comando. Presente apenas se o comando falhar.
commandResultPayload

string

O payload do resultado do comando. Os comandos a seguir respondem com um payload:

  • DEVICE_START_CRD_SESSION: o payload é um objeto JSON com strings no formato: { "url": url }. O URL fornece um link para a sessão da Área de trabalho remota do Google Chrome.

CommandResultType

O tipo de resultado do comando.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED O resultado do comando não foi especificado.
IGNORED O comando foi ignorado por estar obsoleto.
FAILURE Não foi possível executar o comando.
SUCCESS O comando foi executado com sucesso.

Métodos

get

 Recebe dados de comando que um comando específico emitiu para o dispositivo.