XML Response
For every successfulXMLExtensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.request,Mobility Masterwill return the processed information as anXMLExtensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.response. There are two types of responses: Default response and Query response.
Default Response Format
The format of a defaultXMLExtensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.response fromMobility Masteris:
response_code
In which,
the status specifies if theXMLExtensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.response succeeds or fails. If the request succeeds, the status tag will contain the string. If the request fails, the status tag will contain the string.
the code is an integer number that represents the error in the request. This tag is populated only if there is an error in the request.
the reason is a message that contains descriptive information about the error.
Response Codes
The following response codes are returned if theXMLExtensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.request returns an string.
Query Command Response Format
The response of theXMLExtensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.request with the command contains detailed information about the status of the user or client.
The
, and values are similar to the default response. The following responses are returned only if the code returns the string.Response Code |
Description |
status |
Displays the status of theXMLExtensible Markup Language. XML is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.response. |
code |
Displays the code as an integer number that represents the error in the request. This tag is populated only if there is an error in the request. |
macaddr |
Displays theMACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address of the client. |
ipaddr |
Displays the IPv4 or IPv6 address of the client. |
name |
Displays the hostname of the user or client. |
role |
Displays the current role of the authenticated client. |
type |
Displays if the client is or . |
vlan |
|
location |
Displays the name of the AP to which the client is associated. |
age |
Displays the age of the client inMobility Master. The age is displayed in DD:HH:MM format (Day:Hours:Minutes). |
auth_status |
Displays the authentication status of the client. Available values are: or . |
auth_server |
Displays the name of the authentication server used for authenticating the client. This information is available only if the client is authenticated byMobility Master. |
auth_method |
Displays the authentication mechanism used to authenticate the client. This information is available only if the client is authenticated byMobility Master. |
essid |
Displays theESSID扩展服务Set Identifier. ESSID refers to the ID used for identifying an extended service set.to which the client is associated. |
bssid |
Displays theBSSIDBasic Service Set Identifier. The BSSID identifies a particular BSS within an area. In infrastructure BSS networks, the BSSID is the MAC address of the AP. In independent BSS or ad hoc networks, the BSSID is generated randomly.of the AP to which the client is associated. |
phy_type |
Displays the physical connection type. Available values are: , , , , , and . |
mobility_state |
Displays the roaming state of the client. Available values are: , , , , , , , , , and . |
in_packets |
Displays the total number of incoming packets received by the client. |
in_octets |
Displays the incoming packets (in bytes) received by the client. |
out_packets |
Displays the total number of outgoing packets received by the client. |
out_octets |
Displays the outgoing packets (in bytes) received by the client. |