REST Resource: customer.devices.chromeos.commands

משאב: DirectoryChromeosdevicesCommand

מידע על פקודה שהונפקה למכשיר.

ייצוג ב-JSON 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
שדות
commandId

string (int64 format)

מזהה ייחודי של פקודה למכשיר.
type

enum (CommandType)

סוג הפקודה.
issueTime

string (Timestamp format)

חותמת הזמן שבה האדמין הפעיל את הפקודה.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
state

enum (State)

מציין את סטטוס הפקודה.
commandExpireTime

string (Timestamp format)

המועד שבו יפוג התוקף של הפקודה. אם הפקודה לא תבוצע במכשיר במהלך פרק הזמן הזה, התוקף שלה יפוג.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
commandResult

object (DirectoryChromeosdevicesCommandResult)

התוצאה של ביצוע הפקודה.
payload

string

עומס העבודה שצוין בפקודה, אם יש כזה.

CommandType

קובעת את סוג הפקודה שהמכשיר צריך לבצע.

טיפוסים בני מנייה (enum)
COMMAND_TYPE_UNSPECIFIED לא צוין סוג הפקודה.
REBOOT מפעילים מחדש את המכשיר. אפשר להנפיק את התעודה למכשירים במצב קיוסק ולמכשירים עם סשן אורח מנוהל, וגם למכשירים רגילים עם ChromeOS מגרסה 113 ואילך.
TAKE_A_SCREENSHOT מצלמים את המסך של המכשיר. האפשרות הזו זמינה רק אם המכשיר נמצא במצב קיוסק.
SET_VOLUME מגדירים את עוצמת הקול במכשיר. אפשר להנפיק אותם רק למכשירי קיוסק ולמכשירים שהופעלה בהם גלישה מנוהלת כאורחים.
WIPE_USERS איפוס נתוני כל המשתמשים במכשיר. הפעלת הפקודה הזו במכשיר תסיר את כל נתוני פרופיל המשתמש, אבל תישאר מדיניות המכשיר והרישום שלו.
REMOTE_POWERWASH מחיקה של המכשיר באמצעות 'ניקוי יסודי'. הפעלת הפקודה הזו במכשיר תסיר את כל הנתונים, כולל כללי מדיניות המשתמשים, כללי מדיניות המכשיר וכללי מדיניות ההרשמה. אזהרה: הפעולה הזו תחזיר את המכשיר להגדרות היצרן שלו ללא רישום, אלא אם המכשיר כפוף לרישום אוטומטי או לרישום מחדש בכפייה. חשוב להשתמש באפשרות הזו בזהירות, כי זו פעולה בלתי הפיכה.
DEVICE_START_CRD_SESSION הפעלת סשן של Chrome Remote Desktop.
CAPTURE_LOGS תיעוד יומני המערכת של מכשיר קיוסק. אפשר להוריד את היומנים מהקישור downloadUrl שמופיע בשדה deviceFiles של chromeosdevices
FETCH_CRD_AVAILABILITY_INFO אחזור מידע שקובע את הזמינות של CRD‏ (Chrome Remote Desktop) במכשיר.
FETCH_SUPPORT_PACKET אחזור חבילה של תמיכה ממכשיר מרחוק. חבילת תמיכה היא קובץ ארכיון zip שמכיל יומני מערכת שונים ונתוני ניפוי באגים ממכשיר ChromeOS. אפשר להוריד את חבילת התמיכה מהקישור downloadURL שמופיע בשדה deviceFiles בקובץ chromeosdevices.

מדינה

מייצג את המצב של הפקודה שהונפקה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED סטטוס הפקודה לא צוין.
PENDING פקודה שעדיין לא פג תוקפה ושעדיין לא נשלחה ללקוח.
EXPIRED הלקוח לא ביצע את הפקודה בזמן הצפוי.
CANCELLED האדמין מבטל את הפקודה כשהיא בסטטוס 'בהמתנה'.
SENT_TO_CLIENT הפקודה נשלחה ללקוח.
ACKED_BY_CLIENT הלקוח הגיב שהוא קיבל את הפקודה.
EXECUTED_BY_CLIENT הלקוח ביצע (או לא ביצע) את הפקודה בהצלחה.

DirectoryChromeosdevicesCommandResult

התוצאה של הפעלת פקודה.

ייצוג ב-JSON 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
שדות
result

enum (CommandResultType)

התוצאה של הפקודה.
executeTime

string (Timestamp format)

השעה שבה הפקודה בוצעה או נכשלה.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
errorMessage

string

הודעת השגיאה עם הסבר קצר לגבי הסיבה לכך שהפקודה נכשלה. מוצג רק אם הפקודה נכשלה.
commandResultPayload

string

עומס העבודה של תוצאת הפקודה. הפקודות הבאות מחזירות עומס נתונים:

  • DEVICE_START_CRD_SESSION: המטען הייעודי (payload) הוא אובייקט JSON שמומר למחרוזת בפורמט: { "url": url }. כתובת ה-URL מספקת קישור לסשן של Chrome Remote Desktop.

CommandResultType

סוג התוצאה של הפקודה.

טיפוסים בני מנייה (enum)
COMMAND_RESULT_TYPE_UNSPECIFIED לא צוינה תוצאת הפקודה.
IGNORED הפקודה התעלמה כי היא מיושנת.
FAILURE לא ניתן היה להריץ את הפקודה.
SUCCESS הפקודה בוצעה בהצלחה.

Methods

get

 אחזור נתוני הפקודה של פקודה ספציפית שהופקה למכשיר.