List Devices

panorama_list_devices

R Documentation

Returns a list of devices

Description

Returns a list of devices.

Usage

panorama_list_devices(DeviceAggregatedStatusFilter, MaxResults,
  NameFilter, NextToken, SortBy, SortOrder)

Arguments

DeviceAggregatedStatusFilter

Filter based on a device's status.

MaxResults

The maximum number of devices to return in one page of results.

NameFilter

Filter based on device's name. Prefixes supported.

NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

SortBy

The target column to be sorted on. Default column sort is CREATED_TIME.

SortOrder

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Value

A list with the following syntax:

list(
  Devices = list(
    list(
      Brand = "AWS_PANORAMA"|"LENOVO",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      CurrentSoftware = "string",
      Description = "string",
      DeviceAggregatedStatus = "ERROR"|"AWAITING_PROVISIONING"|"PENDING"|"FAILED"|"DELETING"|"ONLINE"|"OFFLINE"|"LEASE_EXPIRED"|"UPDATE_NEEDED"|"REBOOTING",
      DeviceId = "string",
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LatestDeviceJob = list(
        ImageVersion = "string",
        JobType = "OTA"|"REBOOT",
        Status = "PENDING"|"IN_PROGRESS"|"VERIFYING"|"REBOOTING"|"DOWNLOADING"|"COMPLETED"|"FAILED"
      ),
      LeaseExpirationTime = as.POSIXct(
        "2015-01-01"
      ),
      Name = "string",
      ProvisioningStatus = "AWAITING_PROVISIONING"|"PENDING"|"SUCCEEDED"|"FAILED"|"ERROR"|"DELETING",
      Tags = list(
        "string"
      ),
      Type = "PANORAMA_APPLIANCE_DEVELOPER_KIT"|"PANORAMA_APPLIANCE"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_devices(
  DeviceAggregatedStatusFilter = "ERROR"|"AWAITING_PROVISIONING"|"PENDING"|"FAILED"|"DELETING"|"ONLINE"|"OFFLINE"|"LEASE_EXPIRED"|"UPDATE_NEEDED"|"REBOOTING",
  MaxResults = 123,
  NameFilter = "string",
  NextToken = "string",
  SortBy = "DEVICE_ID"|"CREATED_TIME"|"NAME"|"DEVICE_AGGREGATED_STATUS",
  SortOrder = "ASCENDING"|"DESCENDING"
)