REST Resource: customer.devices.chromeos.commands

Recurso: DirectoryChromeosdevicesCommand

Información sobre un comando que se emitió a un dispositivo.

Representación JSON
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Campos
commandId

string (int64 format)

Es el ID único de un comando del dispositivo.

type

enum (CommandType)

Es el tipo de comando.

issueTime

string (Timestamp format)

Es la marca de tiempo del momento en que el administrador emitió el comando.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

state

enum (State)

Indica el estado del comando.

commandExpireTime

string (Timestamp format)

Es la hora a la que vencerá el comando. Si el dispositivo no ejecuta el comando dentro de este tiempo, este vencerá.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

commandResult

object (DirectoryChromeosdevicesCommandResult)

Es el resultado de la ejecución del comando.

payload

string

La carga útil que especificó el comando, si corresponde.

CommandType

Establece el tipo de comando que debe ejecutar el dispositivo.

Enumeraciones
COMMAND_TYPE_UNSPECIFIED No se especificó el tipo de comando.
REBOOT Reinicia el dispositivo. Se puede emitir a dispositivos de kiosco y de sesión de invitado administrada, y a dispositivos normales que ejecuten ChromeOS 113 o versiones posteriores.
TAKE_A_SCREENSHOT Toma una captura de pantalla del dispositivo. Solo está disponible si el dispositivo está en modo kiosco.
SET_VOLUME Establece el volumen del dispositivo. Solo se puede emitir a dispositivos de kiosco y de sesión de invitado administrada.
WIPE_USERS Borra todos los usuarios del dispositivo. Si ejecutas este comando en el dispositivo, se quitarán todos los datos del perfil de usuario, pero se conservarán la política de dispositivo y la inscripción.
REMOTE_POWERWASH Limpia el dispositivo con un lavado de energía. Si ejecutas este comando en el dispositivo, se quitarán todos los datos, incluidas las políticas de usuario, las políticas de dispositivo y las políticas de inscripción. Advertencia: Esta opción restablecerá el estado de fábrica del dispositivo sin inscripción, a menos que el dispositivo esté sujeto a una inscripción forzosa o automática. Usa esta opción con cuidado, ya que es una acción irreversible.
DEVICE_START_CRD_SESSION Inicia una sesión del Escritorio remoto de Chrome.
CAPTURE_LOGS Captura los registros del sistema de un dispositivo de kiosco. Los registros se pueden descargar desde el vínculo downloadUrl presente en el campo deviceFiles de chromeosdevices.
FETCH_CRD_AVAILABILITY_INFO Recupera información que determina la disponibilidad de CRD (Escritorio remoto de Chrome) en el dispositivo.
FETCH_SUPPORT_PACKET Recupera el paquete de asistencia de un dispositivo de forma remota. El paquete de asistencia es un archivo ZIP que contiene varios registros del sistema y datos de depuración de un dispositivo ChromeOS. El paquete de asistencia se puede descargar desde el vínculo downloadURL presente en el campo deviceFiles de chromeosdevices.

Estado

Representa el estado del comando emitido.

Enumeraciones
STATE_UNSPECIFIED No se especificó el estado del comando.
PENDING Un comando sin vencer que aún no se envía al cliente.
EXPIRED El cliente no ejecutó el comando dentro del tiempo esperado.
CANCELLED El administrador cancela el comando mientras está en PENDING.
SENT_TO_CLIENT Se envió el comando al cliente.
ACKED_BY_CLIENT El cliente respondió que recibió el comando.
EXECUTED_BY_CLIENT El cliente ejecutó el comando correctamente (o no).

DirectoryChromeosdevicesCommandResult

Es el resultado de ejecutar un comando.

Representación JSON
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Campos
result

enum (CommandResultType)

El resultado del comando.

executeTime

string (Timestamp format)

Es la hora en que se ejecutó o no se pudo ejecutar el comando.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

errorMessage

string

El mensaje de error con una breve explicación de por qué falló el comando. Solo está presente si el comando falló.

commandResultPayload

string

Es la carga útil del resultado del comando. Los siguientes comandos responden con una carga útil:

  • DEVICE_START_CRD_SESSION: La carga útil es un objeto JSON con formato de cadena con el formato: { "url": url }. La URL proporciona un vínculo a la sesión de Escritorio remoto de Chrome.

CommandResultType

Es el tipo de resultado del comando.

Enumeraciones
COMMAND_RESULT_TYPE_UNSPECIFIED No se especificó el resultado del comando.
IGNORED Se ignoró el comando porque es obsoleto.
FAILURE No se pudo ejecutar el comando correctamente.
SUCCESS El comando se ejecutó correctamente.

Métodos

get

Obtiene los datos de un comando específico que se emitió al dispositivo.