mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
1028 lines
37 KiB
HTML
1028 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Devices Patch - sasportal v2.0.0+20210330</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</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-nav-search">
|
|
<a href=".." class="icon icon-home"> sasportal v2.0.0+20210330</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Customers</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-create">Deployments Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-delete">Deployments Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-devices-create">Deployments Devices Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-devices-create-signed">Deployments Devices Create Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-devices-list">Deployments Devices List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-get">Deployments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-list">Deployments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-move">Deployments Move</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_deployments-patch">Deployments Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-create">Devices Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-create-signed">Devices Create Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-delete">Devices Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-get">Devices Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-list">Devices List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-move">Devices Move</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-patch">Devices Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-sign-device">Devices Sign Device</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_devices-update-signed">Devices Update Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-create">Nodes Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-delete">Nodes Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-deployments-create">Nodes Deployments Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-deployments-list">Nodes Deployments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-devices-create">Nodes Devices Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-devices-create-signed">Nodes Devices Create Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-devices-list">Nodes Devices List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-get">Nodes Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-list">Nodes List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-move">Nodes Move</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-nodes-create">Nodes Nodes Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-nodes-list">Nodes Nodes List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_nodes-patch">Nodes Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../customers_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Deployments</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_devices-delete">Devices Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_devices-get">Devices Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_devices-move">Devices Move</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Devices Patch</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_devices-sign-device">Devices Sign Device</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_devices-update-signed">Devices Update Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../deployments_get">Get</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Installer</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../installer_generate-secret">Generate Secret</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../installer_validate">Validate</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Nodes</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-delete">Deployments Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-devices-create">Deployments Devices Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-devices-create-signed">Deployments Devices Create Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-devices-list">Deployments Devices List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-get">Deployments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-list">Deployments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-move">Deployments Move</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_deployments-patch">Deployments Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-create">Devices Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-create-signed">Devices Create Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-delete">Devices Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-get">Devices Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-list">Devices List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-move">Devices Move</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-patch">Devices Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-sign-device">Devices Sign Device</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_devices-update-signed">Devices Update Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-create">Nodes Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-delete">Nodes Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-deployments-create">Nodes Deployments Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-deployments-list">Nodes Deployments List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-devices-create">Nodes Devices Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-devices-create-signed">Nodes Devices Create Signed</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-devices-list">Nodes Devices List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-get">Nodes Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-list">Nodes List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-move">Nodes Move</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-nodes-create">Nodes Nodes Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-nodes-list">Nodes Nodes List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../nodes_nodes-patch">Nodes Patch</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Policies</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../policies_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../policies_set">Set</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../policies_test">Test</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></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="..">Docs</a> »</li>
|
|
<li>Devices Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/sasportal1_alpha1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Updates a device.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/userinfo.email</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/userinfo.email</em>.
|
|
You can set the scope for this method like this: <code>sasportal1-alpha1 --scope <scope> deployments devices-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Output only. The resource path name.</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>SasPortalDevice:
|
|
active-config:
|
|
air-interface:
|
|
radio-technology: string
|
|
supported-spec: string
|
|
call-sign: string
|
|
category: string
|
|
installation-params:
|
|
antenna-azimuth: integer
|
|
antenna-beamwidth: integer
|
|
antenna-downtilt: integer
|
|
antenna-gain: integer
|
|
antenna-model: string
|
|
cpe-cbsd-indication: boolean
|
|
eirp-capability: integer
|
|
height: number
|
|
height-type: string
|
|
horizontal-accuracy: number
|
|
indoor-deployment: boolean
|
|
latitude: number
|
|
longitude: number
|
|
vertical-accuracy: number
|
|
is-signed: boolean
|
|
measurement-capabilities: [string]
|
|
model:
|
|
firmware-version: string
|
|
hardware-version: string
|
|
name: string
|
|
software-version: string
|
|
vendor: string
|
|
state: string
|
|
update-time: string
|
|
user-id: string
|
|
display-name: string
|
|
fcc-id: string
|
|
name: string
|
|
preloaded-config:
|
|
air-interface:
|
|
radio-technology: string
|
|
supported-spec: string
|
|
call-sign: string
|
|
category: string
|
|
installation-params:
|
|
antenna-azimuth: integer
|
|
antenna-beamwidth: integer
|
|
antenna-downtilt: integer
|
|
antenna-gain: integer
|
|
antenna-model: string
|
|
cpe-cbsd-indication: boolean
|
|
eirp-capability: integer
|
|
height: number
|
|
height-type: string
|
|
horizontal-accuracy: number
|
|
indoor-deployment: boolean
|
|
latitude: number
|
|
longitude: number
|
|
vertical-accuracy: number
|
|
is-signed: boolean
|
|
measurement-capabilities: [string]
|
|
model:
|
|
firmware-version: string
|
|
hardware-version: string
|
|
name: string
|
|
software-version: string
|
|
vendor: string
|
|
state: string
|
|
update-time: string
|
|
user-id: string
|
|
serial-number: string
|
|
state: 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><code>-r .active-config.air-interface radio-technology=dolor</code><ul>
|
|
<li>Conditional. This field specifies the radio access technology that is used for the CBSD.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>supported-spec=amet</code></p>
|
|
<ul>
|
|
<li>Optional. This field is related to the <code>radioTechnology</code> and provides the air interface specification that the CBSD is compliant with at the time of registration.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. call-sign=et</code></p>
|
|
<ul>
|
|
<li>The call sign of the device operator.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>category=aliquyam</code><ul>
|
|
<li>FCC category of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>installation-params antenna-azimuth=96</code><ul>
|
|
<li>Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-beamwidth=39</code><ul>
|
|
<li>3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-downtilt=13</code><ul>
|
|
<li>Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-gain=91</code><ul>
|
|
<li>Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-model=duo</code><ul>
|
|
<li>If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cpe-cbsd-indication=true</code><ul>
|
|
<li>If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>eirp-capability=36</code><ul>
|
|
<li>This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>height=0.0517042800543942</code><ul>
|
|
<li>Device antenna height in meters. When the <code>heightType</code> parameter value is "AGL", the antenna height should be given relative to ground level. When the <code>heightType</code> parameter value is "AMSL", it is given with respect to WGS84 datum.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>height-type=no</code><ul>
|
|
<li>Specifies how the height is measured.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>horizontal-accuracy=0.8773482329441525</code><ul>
|
|
<li>A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>indoor-deployment=true</code><ul>
|
|
<li>Whether the device antenna is indoor or not. <code>true</code>: indoor. <code>false</code>: outdoor.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>latitude=0.8272981866875683</code><ul>
|
|
<li>Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>longitude=0.32575100678738056</code><ul>
|
|
<li>Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>vertical-accuracy=0.7771889296232175</code></p>
|
|
<ul>
|
|
<li>A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. is-signed=true</code></p>
|
|
<ul>
|
|
<li>Output only. Whether the configuration has been signed by a CPI.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>measurement-capabilities=gubergren</code><ul>
|
|
<li>Measurement reporting capabilities of the device.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>model firmware-version=et</code><ul>
|
|
<li>The firmware version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>hardware-version=invidunt</code><ul>
|
|
<li>The hardware version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=magna</code><ul>
|
|
<li>The name of the device model.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>software-version=sit</code><ul>
|
|
<li>The software version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>vendor=gubergren</code></p>
|
|
<ul>
|
|
<li>The name of the device vendor.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. state=elitr</code></p>
|
|
<ul>
|
|
<li>State of the configuration.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=ipsum</code><ul>
|
|
<li>Output only. The last time the device configuration was edited.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>user-id=kasd</code></p>
|
|
<ul>
|
|
<li>The identifier of a device user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. display-name=dolore</code></p>
|
|
<ul>
|
|
<li>Device display name.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>fcc-id=lorem</code><ul>
|
|
<li>The FCC identifier of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=amet</code><ul>
|
|
<li>Output only. The resource path name.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>preloaded-config.air-interface radio-technology=ipsum</code><ul>
|
|
<li>Conditional. This field specifies the radio access technology that is used for the CBSD.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>supported-spec=lorem</code></p>
|
|
<ul>
|
|
<li>Optional. This field is related to the <code>radioTechnology</code> and provides the air interface specification that the CBSD is compliant with at the time of registration.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. call-sign=dolores</code></p>
|
|
<ul>
|
|
<li>The call sign of the device operator.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>category=consetetur</code><ul>
|
|
<li>FCC category of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>installation-params antenna-azimuth=86</code><ul>
|
|
<li>Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-beamwidth=78</code><ul>
|
|
<li>3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-downtilt=55</code><ul>
|
|
<li>Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-gain=92</code><ul>
|
|
<li>Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>antenna-model=sed</code><ul>
|
|
<li>If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cpe-cbsd-indication=false</code><ul>
|
|
<li>If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>eirp-capability=41</code><ul>
|
|
<li>This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>height=0.5971313679491855</code><ul>
|
|
<li>Device antenna height in meters. When the <code>heightType</code> parameter value is "AGL", the antenna height should be given relative to ground level. When the <code>heightType</code> parameter value is "AMSL", it is given with respect to WGS84 datum.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>height-type=accusam</code><ul>
|
|
<li>Specifies how the height is measured.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>horizontal-accuracy=0.4480846044533596</code><ul>
|
|
<li>A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>indoor-deployment=false</code><ul>
|
|
<li>Whether the device antenna is indoor or not. <code>true</code>: indoor. <code>false</code>: outdoor.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>latitude=0.08950879767081599</code><ul>
|
|
<li>Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>longitude=0.9824142797669447</code><ul>
|
|
<li>Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>vertical-accuracy=0.6735332970099256</code></p>
|
|
<ul>
|
|
<li>A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. is-signed=true</code></p>
|
|
<ul>
|
|
<li>Output only. Whether the configuration has been signed by a CPI.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>measurement-capabilities=lorem</code><ul>
|
|
<li>Measurement reporting capabilities of the device.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>model firmware-version=dolor</code><ul>
|
|
<li>The firmware version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>hardware-version=amet</code><ul>
|
|
<li>The hardware version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=magna</code><ul>
|
|
<li>The name of the device model.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>software-version=magna</code><ul>
|
|
<li>The software version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>vendor=invidunt</code></p>
|
|
<ul>
|
|
<li>The name of the device vendor.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. state=et</code></p>
|
|
<ul>
|
|
<li>State of the configuration.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=et</code><ul>
|
|
<li>Output only. The last time the device configuration was edited.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>user-id=dolor</code></p>
|
|
<ul>
|
|
<li>The identifier of a device user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. serial-number=erat</code></p>
|
|
<ul>
|
|
<li>A serial number assigned to the device by the device manufacturer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=dolore</code><ul>
|
|
<li>Output only. Device state.</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-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p update-mask=string</strong><ul>
|
|
<li>Fields to be updated.</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="../deployments_devices-sign-device" class="btn btn-neutral float-right" title="Devices Sign Device"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../deployments_devices-move" class="btn btn-neutral" title="Devices Move"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../deployments_devices-move" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../deployments_devices-sign-device" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |