Hi Alfred,
CSM 4.7 onwards includes a demo license. If not, you need a license to use API. Simplest way to test it using 'Advanced REST Client' extension in chrome.
These are relevant snippets from the Python script I use for working with CSM API.
import re
import csv
import logging
import datetime
from httplib2 import Http
from bs4 import BeautifulSoup
headers = {'Content-Type': 'application/xml'}
connection = Http(disable_ssl_certificate_validation=True)
csm = {}
csm['reqid'] = '123'
####### MAIN STARTS HERE #######
def main():
# Log all the messages
logging.basicConfig(
filename='C:/Users/Chetan/Documents/CSM/nb api/output.txt',
level=logging.DEBUG,
format='%(asctime)s-%(levelname)s: %(message)s',
datefmt='%m/%d/%Y %I:%M:%S %p')
# Login to CSM
response_login = api_login('10.1.1.10', 'csmuser', 'password')
if response_login[0]:
logging.debug('Successful Login!')
else :
logging.debug('Login FAILED')
print_response(response_login)
# Verify Service Info - can use as heartbeat
response_srvInfo = getServiceInfo()
if response_srvInfo[0]:
logging.debug(
'Service Info: ' + response_srvInfo[1].servicedesc.string)
else :
logging.debug('getServiceInfo FAILED')
print_response(response_srvInfo)
######### ADD SCRIPT HERE ##########
response_getGroupList = getGroupList()
if response_getGroupList[0]:
logging.debug(
'Service Info: ' + response_getGroupList[1].prettify() )
else :
logging.debug('getGroupList FAILED')
print_response(response_getGroupList)
response_logout = api_logout() # Logout CSM API session
logging.debug('Logout response: ' + str(response_login[0]))
####### MAIN ENDS HERE #######
def make_tuple(response):
"""Returns a tuple of usable objects from the HTTP server response.
USAGE:
tuple_resp = make_tuple(response)
tuple_resp[0]: TRUE for successful server response
tuple_resp[1]: BeatifulSoup object for XML payload
"""
tuple_resp = (response[0]['status'] == '200', BeautifulSoup(response[1]))
return tuple_resp
def print_response(response):
"""Print XML response data returned by CSM API in BeautifulSoup
format. Note that BeautifulSoup module converts all XML tags to
lower case.
"""
logging.debug(response[1].prettify())
def api_login(csmanager, csm_user='csmuser', csm_pass='password', reqid='123'):
"""CSM API CLIENT AUTHENTICATION
csmanager: CSM Server IP address or hostname
csm_user: username
csm_pass: password
reqid (optional): CSM API request ID. Default is '123'
After successful login, cookies are updated in the HTTP header for
further communication.
"""
csm['host'] = csmanager # CSM Server IP address or hostname
csm['reqid'] = reqid # CSM API request ID
url = 'https://' + csm['host'] + '/nbi/login'
body = '<?xml version="1.0" encoding="UTF-8"?>'
body += '<ns1:loginRequest xmlns:ns1="csm">'
body += '<protVersion>1.0</protVersion><reqId>'+ csm['reqid'] +'</reqId>'
body += '<username>' + csm_user + '</username>'
body += '<password>' + csm_pass + '</password>'
body += '<heartbeatRequested>false</heartbeatRequested>'
body += '</ns1:loginRequest>'
response = connection.request(url, "POST", body, headers)
if response[0]['status'] == '200':
# Update the HTTP header with cookies received from the server.
headers['Cookie'] = response[0]['set-cookie']
return make_tuple(response)
def api_logout():
"""Log out of current CSM API session. Old cookies are removed from
the HTTP header.
"""
url = 'https://' + csm['host'] + '/nbi/logout'
body = '<?xml version="1.0" encoding="UTF-8"?>'
body += '<ns1:logoutRequest xmlns:ns1="csm">'
body += '<protVersion>1.0</protVersion><reqId>'+ csm['reqid'] +'</reqId>'
body += '</ns1:logoutRequest>'
response = connection.request(url, "POST", body, headers)
headers.pop('Cookie') # Remove the cookie from HTTP header
return make_tuple(response)
### GET-SERVICE-INFO
def getServiceInfo():
url = 'https://' + csm['host'] + '/nbi/configservice/GetServiceInfo'
body = '<?xml version="1.0" encoding="UTF-8"?>'
body += '<ns1:getServiceInfoRequest xmlns:ns1="csm">'
body += '<protVersion>1.0</protVersion><reqId>'+ csm['reqid'] +'</reqId>'
body += '</ns1:getServiceInfoRequest>'
response = connection.request(url, "POST", body, headers)
return make_tuple(response)
### GET GROUP LIST
# The GetGroupList method returns the list of devices groups.
def getGroupList():
url = 'https://' + csm['host'] + '/nbi/configservice/getGroupList'
body = '<?xml version="1.0" encoding="UTF-8"?>'
body += '<ns1:groupListRequest xmlns:ns1="csm">'
body += '<protVersion>1.0</protVersion><reqId>'+ csm['reqid'] +'</reqId>'
body += '<includeEmptyGroups>false</includeEmptyGroups>'
body += '</ns1:groupListRequest>'
response = connection.request(url, "POST", body, headers)
return make_tuple(response)
# Standard boilerplate to call main() function.
if __name__ == '__main__':
main()
Hope this helps!
Chetan
