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 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "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 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "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

इससे यह तय होता है कि डिवाइस को किस तरह का निर्देश देना है.

Enums
COMMAND_TYPE_UNSPECIFIED निर्देश के टाइप के बारे में नहीं बताया गया था.
REBOOT डिवाइस को रीबूट करें. इन्हें कीऑस्क और मैनेज किए जा रहे गेस्ट सेशन (मेहमान के तौर पर ब्राउज़ करने का सेशन) वाले डिवाइसों के साथ-साथ, ChromeOS 113 या उसके बाद के वर्शन वाले सामान्य डिवाइसों के लिए भी जारी किया जा सकता है.
TAKE_A_SCREENSHOT डिवाइस का स्क्रीनशॉट लें. यह सुविधा सिर्फ़ तब उपलब्ध होती है, जब डिवाइस कीऑस्क मोड में हो.
SET_VOLUME डिवाइस की आवाज़ सेट करना. यह सिर्फ़ कीऑस्क और मैनेज किए जा रहे गेस्ट सेशन मोड वाले डिवाइसों के लिए जारी किया जा सकता है.
WIPE_USERS डिवाइस से सभी उपयोगकर्ताओं का डेटा मिटाएं. डिवाइस में इस कमांड को चलाने से, उपयोगकर्ता प्रोफ़ाइल का सारा डेटा हट जाएगा. हालांकि, डिवाइस से जुड़ी नीति और रजिस्टर करने का डेटा बना रहेगा.
REMOTE_POWERWASH यह डिवाइस को पावर वॉश करके वाइप करता है. डिवाइस में इस कमांड को लागू करने पर, उपयोगकर्ता की नीतियों, डिवाइस की नीतियों, और रजिस्टर करने की नीतियों के साथ-साथ सभी डेटा को हटा दिया जाएगा. चेतावनी: ऐसा करने पर, यह डिवाइस अपनी फ़ैक्ट्री सेटिंग की डिफ़ॉल्ट स्थिति में पहुंच जाएगा और इसमें दर्ज सभी नाम हट जाएंगे. हालांकि, अगर डिवाइस में ज़बरदस्ती या अपने-आप नाम दर्ज होने की सेटिंग चालू है, तो ऐसा नहीं होगा. इस कार्रवाई को पहले जैसा नहीं किया जा सकता. इसलिए, इसका इस्तेमाल सावधानी से करें!
DEVICE_START_CRD_SESSION Chrome Remote Desktop सेशन शुरू करता है.
CAPTURE_LOGS कीऑस्क डिवाइस के सिस्टम लॉग कैप्चर करें. लॉग को chromeosdevices के deviceFiles फ़ील्ड में मौजूद downloadUrl लिंक से डाउनलोड किया जा सकता है
FETCH_CRD_AVAILABILITY_INFO यह कुकी, Chrome Remote Desktop के उपलब्ध सेशन के टाइप (निजी या शेयर किए गए) को फ़ेच करती है. इनका इस्तेमाल, डिवाइस से रिमोट सेशन के ज़रिए कनेक्ट करने के लिए किया जा सकता है.
FETCH_SUPPORT_PACKET किसी डिवाइस से सहायता पैकेज को रिमोट से फ़ेच करें. सहायता पैकेट एक ज़िप संग्रह होता है. इसमें ChromeOS डिवाइस के अलग-अलग सिस्टम लॉग और डीबग डेटा शामिल होता है. सहायता पैकेज को chromeosdevices के deviceFiles फ़ील्ड में मौजूद downloadURL लिंक से डाउनलोड किया जा सकता है

स्थिति

इससे जारी किए गए निर्देश की स्थिति के बारे में पता चलता है.

Enums
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 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "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: पेलोड, स्ट्रिंग के तौर पर JSON ऑब्जेक्ट होता है. इसका फ़ॉर्मैट यह होता है: { "url": url }. दिया गया यूआरएल, Chrome Remote Desktop सेशन से लिंक होता है. इसके लिए, सिर्फ़ उस email का इस्तेमाल करके पुष्टि करना ज़रूरी है जो कमांड जारी करने से जुड़ा है.
  • FETCH_CRD_AVAILABILITY_INFO: पेलोड, स्ट्रिंग के तौर पर JSON ऑब्जेक्ट होता है. इसका फ़ॉर्मैट यह होता है: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. अगर डिवाइस के लिए shared CRD सेशन उपलब्ध है, तो "remoteSupportAvailability" फ़ील्ड को "AVAILABLE" पर सेट किया जाता है. अगर डिवाइस के लिए private CRD सेशन उपलब्ध है, तो "remoteAccessAvailability" फ़ील्ड को "AVAILABLE" पर सेट किया जाता है.

CommandResultType

कमांड के नतीजे का टाइप.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED कमांड के नतीजे के बारे में जानकारी नहीं दी गई थी.
IGNORED इस निर्देश को 'पुराना है' के तौर पर अनदेखा कर दिया गया.
FAILURE कमांड को पूरा नहीं किया जा सका.
SUCCESS यह निर्देश पूरा हो गया.

तरीके

get

इस तरीके से, डिवाइस को भेजे गए किसी निर्देश का डेटा मिलता है.