Device Attribute

This section covers the various attributes of different devices including terminals, routers, gateways, access points, and IoT devices.

Terminal

  • Name
    dish_serial_number
    Type
    string
    Description

    Unique identifier for the device

Router

  • Name
    config_id
    Type
    string
    Description

    Unique identifier for the device

  • Name
    is_bypassed
    Type
    boolean
    Description

    If the router is is currently bypassed

  • Name
    hardware_version
    Type
    string
    Description

    The version of Router usually v1,v2,v3

  • Name
    direct_link_to_dish
    Type
    string
    Description

    If the router is directly linked to Dish

Gateway & Access Point (Rujie)

  • Name
    product_class
    Type
    string
    Description

    Product classification assigned by devices.s

  • Name
    hardware_version
    Type
    string
    Description

    Hardware version of device installed.

  • Name
    software_version
    Type
    string
    Description

    Software version of device installed.

  • Name
    group_id
    Type
    int
    Description

    This is the group or project id which the device is assigned.

  • Name
    organization_id
    Type
    string
    Description

    Organization in which the device is managed.

  • Name
    mac_address
    Type
    string | null
    Description

    The device MAC Address

  • Name
    local_ip
    Type
    string
    Description

    Internal local ip of the device

IoT Devices

In some cases devices are not allowed to use third party devices, Polaris offers a first-party solution for capturing telemetry data.

  • Name
    interface
    Type
    string
    Description

    The interface of which Raspberry PI is connected.

  • Name
    tunnel_dns
    Type
    string | null
    Description

    The current assigned tunnel dns, this can be null if using agent mode

  • Name
    prom_version
    Type
    string
    Description

    The version of prometheus installed

  • Name
    software_vesrsion
    Type
    string
    Description

    The version of Polaris Harpoon installed

  • Name
    poller_interval
    Type
    int
    Description

    Poller interval rate in seconds

Was this page helpful?