Authentication allows XML API interaction with the Cisco IMC. It provides a way to set permissions and control the operations that can be performed.
Most code examples in this guide substitute the term
To log in, the XML API client establishes a TCP connection to the Cisco IMC HTTP (or HTTPS) server and posts an XML document containing the aaaLogin method.
In the following example, the Telnet utility is used to establish a TCP connection to port 80 of the Cisco IMC with IP address 22.214.171.124. The path used is /nuova.
$ telnet 126.96.36.199 80 POST /nuova HTTP/1.1 USER-Agent: lwp-request/2.06 HOST: 188.8.131.52 Content-Length: 62 Content-Type: application/x-www-form-urlencoded
Next, the client specifies the aaaLogin method and provides a user name and password:
<aaaLogin inName='admin' inPassword='password'> </aaaLogin>
Do not include XML version or DOCTYPE lines in the XML API document. The inName and inPassword attributes are parameters.
Each XML API document represents an operation to be performed. When the request is received as an XML API document, Cisco IMC reads the request and performs the actions as provided in the method. Cisco IMC responds with a message in XML document format and indicates success or failure of the request.
The following is a typical successful response:
1 <aaaLogin 2 response="yes" 3 outCookie="<real_cookie>" 4 outRefreshPeriod="600" 5 outPriv="admin"> 6 </aaaLogin>
Each line in the response should be interpreted as follows:
Specifies the method used to login.
Confirms that this is a response.
Provides the session cookie.
Specifies the recommended cookie refresh period. The default login session length is 600 seconds.
Specifies the privilege level assigned to the user account (this can be admin, user, or readonly).
Alternatively, you can use the cURL utility to log in to the XML API, as shown in the following example:
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" http://184.108.40.206/nuova
If HTTPS is enabled, you must use HTTPS in the cURL command, as shown in the following example:
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" https://220.127.116.11/nuova
Refreshing the Session
Sessions are refreshed with the aaaRefresh method, using the 47-character cookie obtained either from the aaaLogin response or a previous refresh.
<aaaRefresh cookie="<real_cookie>" inCookie="<real_cookie>" inName='admin' inPassword='password'> </aaaRefresh>
Logging Out of the Session
Use the following method to log out of a session:
<aaaLogout cookie="<real_cookie>" inCookie="<real_cookie>" </aaaLogout>
<aaaLogin cookie="" response="yes" errorCode="551" invocationResult="unidentified-fail" errorDescr="Authentication failed"> </aaaLogin>
Nonexistent object (blank return indicates no object with the specified DN):
<configResolveDn cookie="<real_cookie>" response="yes" dn="sys/rack-unit-1chassis-1/server-1/adaptor-9999"> <outConfig> </outConfig> </configResolveDn>
<configConfMo cookie="<real_cookie>" response="yes" dn="sys/rack-unit-1chassis-1/server-1/adaptor-1/ext-eth-0"> errorCode="103“ invocationResult="unidentified-fail“ errorDescr="can't create; object already exists."> </configConfMo>