mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
446 lines
20 KiB
HTML
446 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-androidmanagement1-cli/enterprises_devices-issue-command/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Devices Issue Command - Android Management v5.0.4+20240221</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Devices Issue Command";
|
|
var mkdocs_page_input_path = "enterprises_devices-issue-command.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-androidmanagement1-cli/enterprises_devices-issue-command/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Android Management v5.0.4+20240221
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Enterprises</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_applications-get/">Applications Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_create/">Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-delete/">Devices Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-get/">Devices Get</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Devices Issue Command</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-list/">Devices List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-operations-cancel/">Devices Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-operations-get/">Devices Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-operations-list/">Devices Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_devices-patch/">Devices Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-create/">Enrollment Tokens Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-delete/">Enrollment Tokens Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-get/">Enrollment Tokens Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_enrollment-tokens-list/">Enrollment Tokens List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_migration-tokens-create/">Migration Tokens Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_migration-tokens-get/">Migration Tokens Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_migration-tokens-list/">Migration Tokens List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-delete/">Policies Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-get/">Policies Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-list/">Policies List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_policies-patch/">Policies Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-create/">Web Apps Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-delete/">Web Apps Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-get/">Web Apps Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-list/">Web Apps List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-apps-patch/">Web Apps Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../enterprises_web-tokens-create/">Web Tokens Create</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Provisioning Info</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../provisioning-info_get/">Get</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Signup Urls</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../signup-urls_create/">Create</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Android Management v5.0.4+20240221</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Enterprises »</li>
|
|
<li>Devices Issue Command</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/androidmanagement1-cli/edit/master/docs/enterprises_devices-issue-command.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/androidmanagement</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/androidmanagement</em>.
|
|
You can set the scope for this method like this: <code>androidmanagement1 --scope <scope> enterprises devices-issue-command ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Command:
|
|
clear-apps-data-params:
|
|
package-names: [string]
|
|
create-time: string
|
|
duration: string
|
|
error-code: string
|
|
new-password: string
|
|
reset-password-flags: [string]
|
|
start-lost-mode-params:
|
|
lost-email-address: string
|
|
lost-message:
|
|
default-message: string
|
|
localized-messages: { string: string }
|
|
lost-organization:
|
|
default-message: string
|
|
localized-messages: { string: string }
|
|
lost-phone-number:
|
|
default-message: string
|
|
localized-messages: { string: string }
|
|
lost-street-address:
|
|
default-message: string
|
|
localized-messages: { string: string }
|
|
start-lost-mode-status:
|
|
status: string
|
|
stop-lost-mode-status:
|
|
status: string
|
|
type: string
|
|
user-name: string
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li>
|
|
<p><code>-r .clear-apps-data-params package-names=ea</code></p>
|
|
<ul>
|
|
<li>The package names of the apps whose data will be cleared when the command is executed.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. create-time=ipsum</code></p>
|
|
<ul>
|
|
<li>The timestamp at which the command was created. The timestamp is automatically generated by the server.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>duration=invidunt</code><ul>
|
|
<li>The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>error-code=amet</code><ul>
|
|
<li>If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>new-password=duo</code><ul>
|
|
<li>For commands of type RESET_PASSWORD, optionally specifies the new password. Note: The new password must be at least 6 characters long if it is numeric in case of Android 14 devices. Else the command will fail with INVALID_VALUE.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reset-password-flags=ipsum</code><ul>
|
|
<li>For commands of type RESET_PASSWORD, optionally specifies flags.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>start-lost-mode-params lost-email-address=sed</code><ul>
|
|
<li>The email address displayed to the user when the device is in lost mode.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>lost-message default-message=ut</code><ul>
|
|
<li>The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>localized-messages=key=gubergren</code></p>
|
|
<ul>
|
|
<li>A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..lost-organization default-message=rebum.</code></p>
|
|
<ul>
|
|
<li>The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>localized-messages=key=est</code></p>
|
|
<ul>
|
|
<li>A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..lost-phone-number default-message=ipsum</code></p>
|
|
<ul>
|
|
<li>The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>localized-messages=key=ipsum</code></p>
|
|
<ul>
|
|
<li>A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..lost-street-address default-message=est</code></p>
|
|
<ul>
|
|
<li>The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>localized-messages=key=gubergren</code></p>
|
|
<ul>
|
|
<li>A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...start-lost-mode-status status=ea</code></p>
|
|
<ul>
|
|
<li>The status. See StartLostModeStatus.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..stop-lost-mode-status status=dolor</code></p>
|
|
<ul>
|
|
<li>The status. See StopLostModeStatus.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. type=lorem</code></p>
|
|
<ul>
|
|
<li>The type of the command.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user-name=eos</code><ul>
|
|
<li>The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../enterprises_devices-get/" class="btn btn-neutral float-left" title="Devices Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../enterprises_devices-list/" class="btn btn-neutral float-right" title="Devices List">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/androidmanagement1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../enterprises_devices-get/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../enterprises_devices-list/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|