Updates a device.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/sasportal

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: sasportal1-alpha1 --scope <scope> deployments devices-patch ...

Required Scalar Argument

<name> (string)
- Output only. The resource path name.

Required Request Value

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.

For example, a structure like this:

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

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.

-r .active-config.air-interface radio-technology=sea
- Conditional. This field specifies the radio access technology that is used for the CBSD.
supported-spec=eos
- Optional. This field is related to the radioTechnology and provides the air interface specification that the CBSD is compliant with at the time of registration.
.. call-sign=dolore
- The call sign of the device operator.
category=accusam
- FCC category of the device.
installation-params antenna-azimuth=57
- 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.
antenna-beamwidth=71
- 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.
antenna-downtilt=65
- 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.
antenna-gain=27
- Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive.
antenna-model=eirmod
- If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
cpe-cbsd-indication=true
- If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
eirp-capability=74
- 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.
height=0.6735332970099256
- Device antenna height in meters. When the heightType parameter value is "AGL", the antenna height should be given relative to ground level. When the heightType parameter value is "AMSL", it is given with respect to WGS84 datum.
height-type=sit
- Specifies how the height is measured.
horizontal-accuracy=0.36317502517618216
- 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.
indoor-deployment=true
- Whether the device antenna is indoor or not. true: indoor. false: outdoor.
latitude=0.032302991633901934
- 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.
longitude=0.14615157326830652
- 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.
vertical-accuracy=0.22806568296421847
- 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.
.. is-signed=true
- Output only. Whether the configuration has been signed by a CPI.
measurement-capabilities=erat
- Measurement reporting capabilities of the device.
- Each invocation of this argument appends the given value to the array.
model firmware-version=dolore
- The firmware version of the device.
hardware-version=vero
- The hardware version of the device.
name=ea
- The name of the device model.
software-version=et
- The software version of the device.
vendor=amet.
- The name of the device vendor.
.. state=eirmod
- State of the configuration.
update-time=sanctus
- Output only. The last time the device configuration was edited.
user-id=sed
- The identifier of a device user.
..device-metadata antenna-model=dolor
- If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId
common-channel-group=et
- Common Channel Group (CCG). A group of CBSDs in the same ICG requesting a common primary channel assignment. For more details, see CBRSA-TS-2001 V3.0.0.
interference-coordination-group=et
- Interference Coordination Group (ICG). A group of CBSDs that manage their own interference with the group. For more details, see CBRSA-TS-2001 V3.0.0.
nrqz-validated=false
- Output only. Set to true if a CPI has validated that they have coordinated with the National Quiet Zone office.
nrqz-validation case-id=eos
- Validation case ID.
cpi-id=nonumy
- CPI who signed the validation.
latitude=0.26872582587862837
- Device latitude that's associated with the validation.
longitude=0.5409905970250275
- Device longitude that's associated with the validation.
state=nonumy
- State of the NRQZ validation info.
... display-name=stet
- Device display name.
fcc-id=rebum.
- 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.
name=eirmod
- Output only. The resource path name.
preloaded-config.air-interface radio-technology=dolores
- Conditional. This field specifies the radio access technology that is used for the CBSD.
supported-spec=aliquyam
- Optional. This field is related to the radioTechnology and provides the air interface specification that the CBSD is compliant with at the time of registration.
.. call-sign=sanctus
- The call sign of the device operator.
category=invidunt
- FCC category of the device.
installation-params antenna-azimuth=97
- 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.
antenna-beamwidth=26
- 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.
antenna-downtilt=18
- 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.
antenna-gain=90
- Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive.
antenna-model=gubergren
- If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets.
cpe-cbsd-indication=false
- If present, this parameter specifies whether the CBSD is a CPE-CBSD or not.
eirp-capability=19
- 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.
height=0.043721800004570266
- Device antenna height in meters. When the heightType parameter value is "AGL", the antenna height should be given relative to ground level. When the heightType parameter value is "AMSL", it is given with respect to WGS84 datum.
height-type=lorem
- Specifies how the height is measured.
horizontal-accuracy=0.05560626266345936
- 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.
indoor-deployment=true
- Whether the device antenna is indoor or not. true: indoor. false: outdoor.
latitude=0.12365623794436087
- 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.
longitude=0.19923467678347817
- 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.
vertical-accuracy=0.0629499683582263
- 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.
.. is-signed=true
- Output only. Whether the configuration has been signed by a CPI.
measurement-capabilities=et
- Measurement reporting capabilities of the device.
- Each invocation of this argument appends the given value to the array.
model firmware-version=dolore
- The firmware version of the device.
hardware-version=voluptua.
- The hardware version of the device.
name=sit
- The name of the device model.
software-version=sanctus
- The software version of the device.
vendor=ipsum
- The name of the device vendor.
.. state=eirmod
- State of the configuration.
update-time=vero
- Output only. The last time the device configuration was edited.
user-id=voluptua.
- The identifier of a device user.
.. serial-number=sea
- A serial number assigned to the device by the device manufacturer.
state=ipsum
- Output only. Device state.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
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 -r struct.sub_struct=bar.
You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

-o out
- out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

-p update-mask=string
- Fields to be updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

-p $-xgafv=string
- V1 error format.
-p access-token=string
- OAuth access token.
-p alt=string
- Data format for response.
-p callback=string
- JSONP
-p fields=string
- Selector specifying which fields to include in a partial response.
-p key=string
- 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.
-p oauth-token=string
- OAuth 2.0 token for the current user.
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-p quota-user=string
- 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.
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").