Skip to content

iectl iem-v2 device list

List Edge Devices

Synopsis

This method retrieves a comprehensive list of Edge Devices with support for sorting, filtering, and pagination. Use filter parameters to query devices by status, type, or other attributes, and sort parameters to order results by specific fields.

iectl iem-v2 device list [flags]

Options

  -d, --data string        use this flag for passing data via json or as datafile with @filename
      --filter string      URL-encoded list of fields that filter the result.

                           The filter values must be wrapped in double quotes ('"'), and may contain the following expressions:

                           - `typeId eq 'value'`
                           - `architecture eq 'value'`
                           - `name contains 'value'`
                           - `status eq 'Offline'`, `'Online'`, `'withoutapps'`, or `'notonboarded'`
                           - `label contains 'value'`
                           - `hasRemoteAccess eq true` or `false`

                           **Example**

                           For filtering `status == 'value1' and typeId == 'value2'`, the filter parameter should contain the URL-encoded value of:

                           - Plain:
                             `"status eq 'value1' and typeId eq 'value2' and label contains 'value3'"`
                           - URL-encoded:
                             `"status%20eq%20%27value1%27%20and%20typeId%20eq%20%27value2%27%20and%20label%20contains%20%27value3%27"`

                           **Supported filter fields:**
                           `name`, `status`, `architecture`, `typeId`, `label`, `hasRemoteAccess`

                           **Note:**
                           Single quotes inside values must be escaped with a backslash (`\'`).
                           The escape character is removed in the parsed value (e.g., `John\'s device` becomes `John's device`).

  -h, --help               help for list
      --page int           Page number (default 1)
      --size int           Page size (default 10)
      --sort stringArray   List of fields that order the result.
                           For sorting based on status, since there are three possible statuses and only two possible direction of sorting, please use the following table to obtain the desired sorting by status.

                           | Desired status order              | Input to the sorting field     |
                           | ----------------------------------| -------------------------------|
                           | NotOnboarded, Online, Offline     | sort=onboarded,-status         |
                           | NotOnboarded, Offline, Online     | sort=onboarded,status          |
                           | Online, Offline, NotOnboarded     | sort=-status,-onboarded        |
                           | Offline, Online, NotOnboarded     | sort=-onboarded,status         |
                           | Online, NotOnboarded, Offline     | sort=-status,onboarded         |
                           | Offline, NotOnboarded, Online     | sort=status,-onboarded         |

Options inherited from parent commands

  -o, --output string   output format
  -q, --query string    query on result of object
  -v, --verbose         verbose output

Example

$ iectl iem-v2 device list --filter "status eq 'Online' and typeId eq 'core.ieipc'" --sort name --page 1 --size 50

SEE ALSO