REST Resource: customer.devices.chromeos.commands

Recurso: DirectoryChromeosdevicesCommand

Es la información sobre un comando que se envió 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 el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 fecha y hora en que vencerá el comando. Si el dispositivo no ejecuta el comando dentro de este período, el comando vencerá.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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

Es 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 para dispositivos en modo de kiosco, sesión de invitado administrada y 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 para 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 de los perfiles de usuario, pero se conservarán la política de dispositivo y la inscripción.
REMOTE_POWERWASH Borra el dispositivo realizando un Powerwash. 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 acción restablecerá el estado de fábrica del dispositivo sin necesidad de una inscripción, a menos que el dispositivo esté sujeto a una inscripción forzosa o automática. Úsala con precaución, ya que esta acción es 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 presente en el campo deviceFiles de chromeosdevices.
FETCH_CRD_AVAILABILITY_INFO Recupera los tipos disponibles de sesiones del Escritorio remoto de Chrome (privadas o compartidas) que se pueden usar para conectarse de forma remota al 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 Es un comando que no venció y que aún no se envió al cliente.
EXPIRED El cliente no ejecutó el comando dentro del tiempo esperado.
CANCELLED El administrador canceló el comando mientras estaba 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 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)

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

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
errorMessage

string

Es el mensaje de error con una breve explicación del motivo por el que falló el comando. Solo está presente si falló el comando.
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 convertido en cadena con el siguiente formato: { "url": url }. La URL proporcionada vincula a la sesión de Escritorio remoto de Chrome y requiere autenticación solo con el email asociado con la emisión del comando.
  • FETCH_CRD_AVAILABILITY_INFO: La carga útil es un objeto JSON convertido en cadena con el siguiente formato: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. El campo "remoteSupportAvailability" se establece en "AVAILABLE" si hay disponible una sesión de CRD de shared en el dispositivo. El campo "remoteAccessAvailability" se establece en "AVAILABLE" si hay una sesión de CRD de private disponible para el dispositivo.

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 está 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.