Skip to content

Get Devices

networkmanager_get_devices R Documentation

Gets information about one or more of your devices in a global network

Description

Gets information about one or more of your devices in a global network.

Usage

networkmanager_get_devices(GlobalNetworkId, DeviceIds, SiteId,
  MaxResults, NextToken)

Arguments

GlobalNetworkId

[required] The ID of the global network.

DeviceIds

One or more device IDs. The maximum is 10.

SiteId

The ID of the site.

MaxResults

The maximum number of results to return.

NextToken

The token for the next page of results.

Value

A list with the following syntax:

list(
  Devices = list(
    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"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_devices(
  GlobalNetworkId = "string",
  DeviceIds = list(
    "string"
  ),
  SiteId = "string",
  MaxResults = 123,
  NextToken = "string"
)