REST Resource: customer.devices.chromeos.commands

Recurso: DirectoryChromeosdevicesCommand

Información sobre un comando emitido 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 de dispositivo.

type

enum (CommandType)

Es el tipo del comando.

issueTime

string (Timestamp format)

La marca de tiempo en la que el administrador emitió el comando.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Indica el estado del comando.

commandExpireTime

string (Timestamp format)

La hora en la que vencerá el comando. Si el dispositivo no ejecuta el comando dentro de este tiempo, el comando caducará.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

commandResult

object (DirectoryChromeosdevicesCommandResult)

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 con sesiones de invitado administradas o de kiosco, así como 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 con sesiones de invitado administradas o de kiosco.
WIPE_USERS Limpiar a todos los usuarios del dispositivo Si ejecutas este comando en el dispositivo, se quitarán todos los datos del perfil del usuario, pero se conservarán la política del dispositivo y la inscripción.
REMOTE_POWERWASH Limpia el dispositivo realizando un Powerwash. Si ejecutas este comando en el dispositivo, se quitarán todos los datos, incluidas las políticas del usuario, de dispositivo y de inscripción. Advertencia: Esta acción revertirá el dispositivo al estado de fábrica sin inscripción, a menos que esté sujeto a una inscripción automática o forzada. Úsala con precaución, ya que esta es una acción irreversible.
DEVICE_START_CRD_SESSION Inicia una sesión de 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, que se encuentra en el campo deviceFiles de chromeosdevices.
FETCH_SUPPORT_PACKET Recupera un paquete de asistencia desde 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 no vencido que aún no se envió al cliente.
EXPIRED El cliente no ejecutó el comando dentro del tiempo esperado.
CANCELLED El administrador cancela el comando mientras se encuentra en PENDIENTE.
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 de forma correcta.

DirectoryChromeosdevicesCommandResult

El resultado de la ejecución de un comando.

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

enum (CommandResultType)

Es el resultado del comando.

executeTime

string (Timestamp format)

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

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

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

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 en cadena con el siguiente formato: { "url": url }. La URL proporciona un vínculo a la sesión del Escritorio remoto de Chrome.

CommandResultType

Es el tipo del resultado del comando.

Enumeraciones
COMMAND_RESULT_TYPE_UNSPECIFIED No se especificó el resultado del comando.
IGNORED El comando se ignoró y se marcó como obsoleto.
FAILURE No se pudo ejecutar correctamente el comando.
SUCCESS El comando se ejecutó de forma correcta.

Métodos

get

Obtiene los datos de un comando específico enviado al dispositivo.