ClientSessionRest
The following resources are applicable:
- /monitoring/client-sessions
- /monitoring/client-sessions/wired/{instanceId}
- /monitoring/client-sessions/wireless/{instanceId}
- /monitoring/client-sessions/wireless/{instanceId}/session-trend
/monitoring/client-sessions
GET
Returns list of client session based on search parameter Possible search parameters are username, MAC address, IPv4 address, IPv6 adderss If no search parameter is provided, exception is thrown search parameter could be full or partial text.
Parameters
name | description | type | default |
---|---|---|---|
search | (no documentation provided) | query |
Response Body
element: | clientSessions |
media types: | application/vnd.juniper.nd.client-sessions+xml application/vnd.juniper.nd.client-sessions+json |
ClientSessions resource containing list of Client sessions
/monitoring/client-sessions/wired/{instanceId}
GET
Returns the Wired Client Session resource identified by the given id
Parameters
name | description | type | default |
---|---|---|---|
instanceId | Identifier of the client session | path |
Response Body
element: | wireless |
media types: | application/vnd.juniper.nd.client-sessions+xml application/vnd.juniper.nd.client-sessions+json |
Client Session resource with its properties and associated resources
/monitoring/client-sessions/wireless/{instanceId}
GET
Returns the Wireless Client Session resource identified by the given id
Parameters
name | description | type | default |
---|---|---|---|
instanceId | Identifier of the client session | path |
Response Body
element: | wireless |
media types: | application/vnd.juniper.nd.client-sessions+xml application/vnd.juniper.nd.client-sessions+json |
Client Session resource with its properties and associated resources
/monitoring/client-sessions/wireless/{instanceId}/session-trend
GET
For Wireless Client Session Returns trends for the session identified by the session identifier (MAC Address) and the time range given by the query parameters. Either start time and end time of the query or last number of hours
Parameters
name | description | type | default |
---|---|---|---|
instanceId | Identifier of the client session | path | |
startTime | start time of the trend data in XML date time format "YYYY-MM-DDThh:mm:ssZ" or "YYYY-MM-DDThh:mm:ss+hh:mm" or "YYYY-MM-DDThh:mm:ss-hh:mm" | query | |
endTime | end time of the trend data in XML date time format "YYYY-MM-DDThh:mm:ssZ" or "YYYY-MM-DDThh:mm:ss+hh:mm" or "YYYY-MM-DDThh:mm:ss-hh:mm" | query | |
hours | number of hours of latest data | query |
Response Body
element: | wirelessSessionTrend |
media types: | application/vnd.juniper.nd.session-trend+xml application/vnd.juniper.nd.session-trend+json |
Client Session trend list with its properties for the given time range