ArubaOS 8.6.0.0Help Center
You are here: Home > External User Management > XML Response

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:

Ok | Error

response_code

response_message

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 theOkstring. If the request fails, the status tag will contain theErrorstring.

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 anErrorstring.

Table 1:XML Response Codes

Code

Reason message

Description

1

unknown user
The user specified in 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 does not exist or is incorrect.
If theMACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address or username is specified in the query,Mobility Masterrestricts the supplied IP address, i.e., the requested user IP address together with anyMACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address and username will not be found.

Returned by theuser_authenticate,user_delete,user_blacklist,user_logout, anduser_querycommands.

2

unknown role
The specified role in 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 does not exist inMobility Master.

Returned by theuser_addcommand.

3

unknown external agent

This error string is returned due to an unknown source IP (i.e. not configured 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.server).
Or,
In case of anuser_addcommand, it is likely to be due to thedefault-xml-apiAAA身份验证、授权和会计。AAAis a security framework to authenticate users, authorize the type of access based on user credentials, and record authentication events and information about the network access and network resource consumption.profile missing from theAAA身份验证、授权和会计。AAAis a security framework to authenticate users, authorize the type of access based on user credentials, and record authentication events and information about the network access and network resource consumption.authentication wired profile.

4

authentication failed

Indicates an authentication failure duringuser_authenticate.
This is only applicable tocaptive portalA captive portal is a web page that allows the users to authenticate and sign in before connecting to a public-access network. Captive portals are typically used by business centers, airports, hotel lobbies, coffee shops, and other venues that offer free Wi-Fi hotspots for the guest users.users.

5

invalid command
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 contains a command not supported byArubaOSXMLExtensible 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.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.interface.

6

invalid message authentication method
The authentication method specified in 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 is not supported by theArubaOSXMLExtensible 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.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.interface.

Returned by commands that contain the authentication method in 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.

7

invalid message digest


This is due to a mismatch in secret between 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.server andMobility MasterXMLExtensible 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.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.profile.
If using non cleartext, this could be an error in the calculation of the hashed secret.

8

missing message authentication
The authentication method is not specified in 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.

Returned by all commands that require the authentication method in 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.

9

missing or invalid version number
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 does not contain the version number or the version number is incorrect.

Returned by all commands.

10

internal error

12

can't use vlan ip

Indicates the supplied IP matches aVLANVirtual Local Area Network. In computer networking, a single Layer 2 network may be partitioned to create multiple distinct broadcast domains, which are mutually isolated so that packets can only pass between them through one or more routers; such a domain is referred to as a Virtual Local Area Network, Virtual LAN, or VLAN.IP onMobility Master.

13

invalid ip
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 contains invalid IP address of the user or client.

Returned by all commands that required IP address to be specified in 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.

14

can't use switch ip
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 contains theMobility MasterIP address instead of the client IP address.

Returned by all commands that required IP address to be specified in 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.

15

missing MAC address
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 does not contain theMACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address of the user or client.

Returned by all commands that requiredMACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address to be specified in 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.

16

unsupported command for this user

Returned when the requested operation is invalid for the specified user.

17

socket failed or timed out waiting for operation to complete

Returned when the status of the requested operation is unavailable; usually signifies a socket communication failure or timeout.

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 theuser_querycommand contains detailed information about the status of the user or client.

Thestatus,codeand原因values are similar to the default response. The following responses are returned only if thestatuscode returns theOkstring.

Table 2:Query Response Code

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 iswiredorwireless.

vlan

Displays theVLANVirtual Local Area Network. In computer networking, a single Layer 2 network may be partitioned to create multiple distinct broadcast domains, which are mutually isolated so that packets can only pass between them through one or more routers; such a domain is referred to as a Virtual Local Area Network, Virtual LAN, or VLAN.ID of the client.

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:通过身份验证orunauthenticated.

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:a,b,g,a-HT,g-HT, anda-VHT.

mobility_state

Displays the roaming state of the client. Available values are:Wired (Visitor),Visitor,Wired (Away),Away,Wired (Foreign VLAN),Foreign VLAN,Wired (Remote),Associated (Remote),Wired, andWireless.

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.

/*]]>*/
Baidu