Radius Client Metrics (v2.0)

List the AAA client metrics. The start time, end time, and max datapoints attibutes are optional with at least one of them specified. All three attributes can not be specified, as the result will be ambiguous.

application/json

Request Body

Query request for getting aaaclientmetrics

end_time date required
The end time to get the client metrics. If not specified, it is default to now. End times need to be specified in ISO8601 UTC format.
filter RadiusClientMetricsFilter required
Filters according to the specifications.
element string[] required
Element
interface string[] required
Interfaces
site string[] required
Site
max_datapoints integer required
The max data points.
name string required
The description of the client metrics. Maz size = 128.
start_time date required
The start time to get the client metrics. If not specified, it is default to epoch. Start times need to be specified in ISO8601 UTC format.

Responses

Successful Operation

application/json

Schema
Example (from schema)

Schema

end_time string required
The end time to get the client metrics. If not specified, it is default to now. End times need to be specified in ISO8601 UTC format.
items ClientDetails[] required
Filters according to the specifications.
Array [
aging_timeout integer
The aging timeout value.
auth_type string
The authentication type. Only closed mode and single host authentication is supported.
element_id string required
The element ID.
interface_id string required
The interface ID.
mac_address string required
The MAC address.
reauth_timeout integer required
The re-auth timeout.
reauthentication_timeout integer
The ION device authenticates or reinitializes the client after a session timeout based on the value of the Termination-Action. Values 1 and 0.
stats_start_time_ms int64 required
The stats start time in milliseconds.
uptime int64 required
Indicates the time for which the neighbor has been up.
username string required
The client user name.
vlan_id integer required
The virtual LAN ID.
]
start_time string required
The start time to get the client metrics. If not specified, it is default to epoch. Start times need to be specified in ISO8601 UTC format.

{
  "end_time": "string",
  "items": [
    {
      "aging_timeout": 0,
      "auth_type": "string",
      "element_id": "string",
      "interface_id": "string",
      "mac_address": "string",
      "reauth_timeout": 0,
      "reauthentication_timeout": 0,
      "stats_start_time_ms": 0,
      "uptime": 0,
      "username": "string",
      "vlan_id": 0
    }
  ],
  "start_time": "string"
}

Bad Request

application/json

Schema
Example (from schema)
Example

Schema

_error ErrorResponse[]
Array [
code string
message string
]

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

{
  "value": {
    "_error": [
      {
        "code": "EMPTY_REQ_BODY"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "EMPTY_FILTER"
      },
      {
        "code": "INTERFACES_WITH_ELEMENT_MISSING"
      },
      {
        "code": "SITE_WITH_ELEMENT_MISSING"
      }
    ]
  }
}

Radius Client Metrics (v2.0)​

Radius Client Metrics (v2.0)