OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
f4bb79d2d629ee5166f17b80ca2aa0e621d1c837
google-apis-rs/google_sasportal1_alpha1_cli/deployments_devices-patch/index.html
Sebastian Thiel f4bb79d2d6 Update documentation
2024-03-05 21:06:01 +01:00

829 lines
37 KiB
HTML
Raw Blame History

<!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-sasportal1_alpha1-cli/deployments_devices-patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Devices Patch - sasportal v5.0.4+20240226</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 Patch";
var mkdocs_page_input_path = "deployments_devices-patch.md";
var mkdocs_page_url = "/google-apis-rs/google-sasportal1_alpha1-cli/deployments_devices-patch/";
</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"> sasportal v5.0.4+20240226
</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">Customers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-create/">Deployments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-delete/">Deployments Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-devices-create/">Deployments Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-devices-create-signed/">Deployments Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-devices-list/">Deployments Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-get/">Deployments Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-list/">Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-move/">Deployments Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_deployments-patch/">Deployments Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-create/">Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-create-signed/">Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-delete/">Devices Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-get/">Devices Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-list/">Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-move/">Devices Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-patch/">Devices Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-sign-device/">Devices Sign Device</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_devices-update-signed/">Devices Update Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_list-gcp-project-deployments/">List Gcp Project Deployments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_list-legacy-organizations/">List Legacy Organizations</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_migrate-organization/">Migrate Organization</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-create/">Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-delete/">Nodes Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-deployments-create/">Nodes Deployments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-deployments-list/">Nodes Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-devices-create/">Nodes Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-devices-create-signed/">Nodes Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-devices-list/">Nodes Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-get/">Nodes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-list/">Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-move/">Nodes Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-nodes-create/">Nodes Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-nodes-list/">Nodes Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_nodes-patch/">Nodes Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_provision-deployment/">Provision Deployment</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../customers_setup-sas-analytics/">Setup Sas Analytics</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Deployments</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-delete/">Devices Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-get/">Devices Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-move/">Devices Move</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Devices Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-sign-device/">Devices Sign Device</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_devices-update-signed/">Devices Update Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../deployments_get/">Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Installer</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installer_generate-secret/">Generate Secret</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installer_validate/">Validate</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Nodes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-delete/">Deployments Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-devices-create/">Deployments Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-devices-create-signed/">Deployments Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-devices-list/">Deployments Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-get/">Deployments Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-list/">Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-move/">Deployments Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_deployments-patch/">Deployments Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-create/">Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-create-signed/">Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-delete/">Devices Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-get/">Devices Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-list/">Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-move/">Devices Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-patch/">Devices Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-sign-device/">Devices Sign Device</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_devices-update-signed/">Devices Update Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-create/">Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-delete/">Nodes Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-deployments-create/">Nodes Deployments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-deployments-list/">Nodes Deployments List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-devices-create/">Nodes Devices Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-devices-create-signed/">Nodes Devices Create Signed</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-devices-list/">Nodes Devices List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-get/">Nodes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-list/">Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-move/">Nodes Move</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-nodes-create/">Nodes Nodes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-nodes-list/">Nodes Nodes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../nodes_nodes-patch/">Nodes Patch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Policies</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../policies_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../policies_set/">Set</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../policies_test/">Test</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="..">sasportal v5.0.4+20240226</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> &raquo;</li>
<li>Deployments &raquo;</li>
<li>Devices Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/sasportal1_alpha1-cli/edit/master/docs/deployments_devices-patch.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>Updates a device.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/sasportal</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>sasportal1-alpha1 --scope &lt;scope&gt; deployments devices-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</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
device-metadata:
antenna-model: string
common-channel-group: string
interference-coordination-group: string
nrqz-validated: boolean
nrqz-validation:
case-id: string
cpi-id: string
latitude: number
longitude: number
state: 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=sea</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=eos</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=dolore</code></p>
<ul>
<li>The call sign of the device operator.</li>
</ul>
</li>
<li><code>category=accusam</code><ul>
<li>FCC category of the device.</li>
</ul>
</li>
<li><code>installation-params antenna-azimuth=57</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=71</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=65</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=27</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=eirmod</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=74</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.6735332970099256</code><ul>
<li>Device antenna height in meters. When the <code>heightType</code> parameter value is &#34;AGL&#34;, the antenna height should be given relative to ground level. When the <code>heightType</code> parameter value is &#34;AMSL&#34;, it is given with respect to WGS84 datum.</li>
</ul>
</li>
<li><code>height-type=sit</code><ul>
<li>Specifies how the height is measured.</li>
</ul>
</li>
<li><code>horizontal-accuracy=0.36317502517618216</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.032302991633901934</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.14615157326830652</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.22806568296421847</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=erat</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=dolore</code><ul>
<li>The firmware version of the device.</li>
</ul>
</li>
<li><code>hardware-version=vero</code><ul>
<li>The hardware version of the device.</li>
</ul>
</li>
<li><code>name=ea</code><ul>
<li>The name of the device model.</li>
</ul>
</li>
<li><code>software-version=et</code><ul>
<li>The software version of the device.</li>
</ul>
</li>
<li>
<p><code>vendor=amet.</code></p>
<ul>
<li>The name of the device vendor.</li>
</ul>
</li>
<li>
<p><code>.. state=eirmod</code></p>
<ul>
<li>State of the configuration.</li>
</ul>
</li>
<li><code>update-time=sanctus</code><ul>
<li>Output only. The last time the device configuration was edited.</li>
</ul>
</li>
<li>
<p><code>user-id=sed</code></p>
<ul>
<li>The identifier of a device user.</li>
</ul>
</li>
<li>
<p><code>..device-metadata antenna-model=dolor</code></p>
<ul>
<li>If populated, the Antenna Model Pattern to use. Format is: <code>RecordCreatorId:PatternId</code></li>
</ul>
</li>
<li><code>common-channel-group=et</code><ul>
<li>Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see <a href="https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf">CBRSA-TS-2001 V3.0.0</a>.</li>
</ul>
</li>
<li><code>interference-coordination-group=et</code><ul>
<li>Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see <a href="https://ongoalliance.org/wp-content/uploads/2020/02/CBRSA-TS-2001-V3.0.0_Approved-for-publication.pdf">CBRSA-TS-2001 V3.0.0</a>.</li>
</ul>
</li>
<li><code>nrqz-validated=false</code><ul>
<li>Output only. Set to <code>true</code> if a CPI has validated that they have coordinated with the National Quiet Zone office.</li>
</ul>
</li>
<li><code>nrqz-validation case-id=eos</code><ul>
<li>Validation case ID.</li>
</ul>
</li>
<li><code>cpi-id=nonumy</code><ul>
<li>CPI who signed the validation.</li>
</ul>
</li>
<li><code>latitude=0.26872582587862837</code><ul>
<li>Device latitude that&#39;s associated with the validation.</li>
</ul>
</li>
<li><code>longitude=0.5409905970250275</code><ul>
<li>Device longitude that&#39;s associated with the validation.</li>
</ul>
</li>
<li>
<p><code>state=nonumy</code></p>
<ul>
<li>State of the NRQZ validation info.</li>
</ul>
</li>
<li>
<p><code>... display-name=stet</code></p>
<ul>
<li>Device display name.</li>
</ul>
</li>
<li><code>fcc-id=rebum.</code><ul>
<li>The FCC identifier of the device. Refer to https://www.fcc.gov/oet/ea/fccid for FccID format. Accept underscores and periods because some test-SAS customers use them.</li>
</ul>
</li>
<li><code>name=eirmod</code><ul>
<li>Output only. The resource path name.</li>
</ul>
</li>
<li><code>preloaded-config.air-interface radio-technology=dolores</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=aliquyam</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=sanctus</code></p>
<ul>
<li>The call sign of the device operator.</li>
</ul>
</li>
<li><code>category=invidunt</code><ul>
<li>FCC category of the device.</li>
</ul>
</li>
<li><code>installation-params antenna-azimuth=97</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=26</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=18</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=90</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=gubergren</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=19</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.043721800004570266</code><ul>
<li>Device antenna height in meters. When the <code>heightType</code> parameter value is &#34;AGL&#34;, the antenna height should be given relative to ground level. When the <code>heightType</code> parameter value is &#34;AMSL&#34;, it is given with respect to WGS84 datum.</li>
</ul>
</li>
<li><code>height-type=lorem</code><ul>
<li>Specifies how the height is measured.</li>
</ul>
</li>
<li><code>horizontal-accuracy=0.05560626266345936</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.12365623794436087</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.19923467678347817</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.0629499683582263</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=et</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=dolore</code><ul>
<li>The firmware version of the device.</li>
</ul>
</li>
<li><code>hardware-version=voluptua.</code><ul>
<li>The hardware version of the device.</li>
</ul>
</li>
<li><code>name=sit</code><ul>
<li>The name of the device model.</li>
</ul>
</li>
<li><code>software-version=sanctus</code><ul>
<li>The software version of the device.</li>
</ul>
</li>
<li>
<p><code>vendor=ipsum</code></p>
<ul>
<li>The name of the device vendor.</li>
</ul>
</li>
<li>
<p><code>.. state=eirmod</code></p>
<ul>
<li>State of the configuration.</li>
</ul>
</li>
<li><code>update-time=vero</code><ul>
<li>Output only. The last time the device configuration was edited.</li>
</ul>
</li>
<li>
<p><code>user-id=voluptua.</code></p>
<ul>
<li>The identifier of a device user.</li>
</ul>
</li>
<li>
<p><code>.. serial-number=sea</code></p>
<ul>
<li>A serial number assigned to the device by the device manufacturer.</li>
</ul>
</li>
<li><code>state=ipsum</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. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../deployments_devices-move/" class="btn btn-neutral float-left" title="Devices Move"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<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>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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/sasportal1_alpha1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../deployments_devices-move/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../deployments_devices-sign-device/" style="color: #fcfcfc">Next &raquo;</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>
Reference in New Issue View Git Blame Copy Permalink