Skip to content

Updates the details for an existing device

Description

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

Usage

networkmanager_update_device(GlobalNetworkId, DeviceId, AWSLocation,
  Description, Type, Vendor, Model, SerialNumber, Location, SiteId)

Arguments

  • GlobalNetworkId

    [required] The ID of the global network.

  • DeviceId

    [required] The ID of the device.

  • AWSLocation

    The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

  • Description

    A description of the device.

    Constraints: Maximum length of 256 characters.

  • Type

    The type of the device.

  • Vendor

    The vendor of the device.

    Constraints: Maximum length of 128 characters.

  • Model

    The model of the device.

    Constraints: Maximum length of 128 characters.

  • SerialNumber

    The serial number of the device.

    Constraints: Maximum length of 128 characters.

  • Location

    Describes a location.

  • SiteId

    The ID of the site.

Value

A list with the following syntax:

list(
  Device = list(
    DeviceId = "string",
    DeviceArn = "string",
    GlobalNetworkId = "string",
    AWSLocation = list(
      Zone = "string",
      SubnetArn = "string"
    ),
    Description = "string",
    Type = "string",
    Vendor = "string",
    Model = "string",
    SerialNumber = "string",
    Location = list(
      Address = "string",
      Latitude = "string",
      Longitude = "string"
    ),
    SiteId = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    State = "PENDING"|"AVAILABLE"|"DELETING"|"UPDATING",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$update_device(
  GlobalNetworkId = "string",
  DeviceId = "string",
  AWSLocation = list(
    Zone = "string",
    SubnetArn = "string"
  ),
  Description = "string",
  Type = "string",
  Vendor = "string",
  Model = "string",
  SerialNumber = "string",
  Location = list(
    Address = "string",
    Latitude = "string",
    Longitude = "string"
  ),
  SiteId = "string"
)