• All Files
ArubaOS 8.6.0.0Help Center
You are here: Home > External User Management > Using the XML API Server > Creating an XML API Request

Creating an XML API Request

You can create 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.request with 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.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.command and send it toMobility MasterviaHTTPSHypertext Transfer Protocol Secure. HTTPS is a variant of the HTTP that adds a layer of security on the data in transit through a secure socket layer or transport layer security protocol connection.POSTPower On Self Test. An HTTP request method that requests data from a specified resource.. The format of theURLUniform Resource Locator. URL is a global address used for locating web resources on the Internet.to send 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:

https://<Mobility Master-ip>/auth/command.xml

Mobility Master-ip: The IP address ofMobility Masterthat will receive 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.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.request

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

The format 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.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.request is:

xml=

Value

...

Value

You can specify any of the following commands 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.要求:

Table 1:XML API Command

XML API Command

Description

user_add

This command creates a new user entry in theMobility Masteruser table. If the user entry is already present in the user table, the command will modify the entry with the values defined 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. For an existing user, this command will update any value that is supplied, with an exception of IP andMACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address. Session time-out 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.

user_delete

This command deletes an existing user from theMobility Masteruser table.

NOTE:Do not use theuser_deletecommand if the intention is to clear the association from theMobility Masteruser table. If the client is dual-stack, it re-inherits the authentication state from the IPv6 address. If not dual-stack, the client reverts to the initial role.

user_authenticate

This command authenticates against the server group defined in thecaptive 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.profile. 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.

user_blacklist

This command blacklists a user from connecting to your network. This command uses the default blacklist timeout of 3600 seconds. There is no correspondingclearcommand. You can use theMobility MasterCLICommand-Line Interface. A console interface with a command line shell that allows users to execute text input as commands and convert these commands to appropriate functions.to clear the blacklisted clients. Refer theshow ap blacklist-clients,stm remove-blacklist-client, andstm purge-blacklist-clientscommands in theArubaOSCLI参考性用途e Guideto clear the blacklisted clients.

user_query

这个命令读取的状态和细节ser connected to your network. A dual-stack client can be queried by any of its IPv4 or IPv6 addresses, but only the queried IP address is displayed in the output.

user_logout

This command reverts the user to the initial role. 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. For dual-stack clients, all user-table entries will be reverted to the initial role.

每一个XMLExtensible 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.command requires certain mandatory options to successfully execute the task. The list of all available options are:

Table 2:XML API Command Options

Options

Description

Range / Defaults

ipaddr

IP address of the user in IPv4 or IPv6 format.

—

macaddr

MACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address of the user in aa:bb:cc:dd:ee:ff format.

EnterMACMedia Access Control. A MAC address is a unique identifier assigned to network interfaces for communications on a network.address with colon.

user

Name of the user.

64 character string

role

The role to apply to a newly created user, or change of role for an existing user. This option applies touser_addanduser_deletecommands only.

64 character string

password

The password of the user for authentication.

—

session_timeout

Session time-out in seconds. User will be disconnected after this time.

—

authentication

Authentication method used to authenticate the message and the sender. You can use any ofMD5Message Digest 5. The MD5 algorithm is a widely used hash function producing a 128-bit hash value from the data input.,SHASecure Hash Algorithm. SHA is a family of cryptographic hash functions. The SHA algorithm includes the SHA, SHA-1, SHA-2 and SHA-3 variants.-1 or clear text methods of authentication. This option is ignored if shared secret is not configured. It is, however, mandatory if it is configured.

—

key

This is the encoded SHA1/MD5Message Digest 5. The MD5 algorithm is a widely used hash function producing a 128-bit hash value from the data input.hash of shared secret or plaintext shared secret.

This option is ignored if shared secret is not configured on the switch.

The actualMD5Message Digest 5. The MD5 algorithm is a widely used hash function producing a 128-bit hash value from the data input./SHASecure Hash Algorithm. SHA is a family of cryptographic hash functions. The SHA algorithm includes the SHA, SHA-1, SHA-2 and SHA-3 variants.-1 hash is 16/20 bytes and consists of binary data. It must be encoded as anASCIIAmerican Standard Code for Information Interchange. An ASCII code is a numerical representation of a character or an action.based HEX string before sending. It must be present when theMobility Masteris configured with an xml-apiApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.key for the server. Encoded hash length is 32/40 bytes forMD5Message Digest 5. The MD5 algorithm is a widely used hash function producing a 128-bit hash value from the data input./SHASecure Hash Algorithm. SHA is a family of cryptographic hash functions. The SHA algorithm includes the SHA, SHA-1, SHA-2 and SHA-3 variants.-1.

version

The version 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.APIApplication Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.interface available inMobility Master. This field is mandatory in allXMLExtensible 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.requests.

Current version 1.0
/*]]>*/
Baidu