Version 9.00

Author: dgalan-xxia

CHANGELOG.rst

@@ -14,4 +14,12 @@ API library release corresponding to IxNetwork 8.40 EA.
 
 API library release corresponding to IxNetwork 8.50 EA.
 This version supports both IxNetwork Windows and Linux API Server.
-Connections to IxNetwork Windows on the REST port or to Linux API Server are secured.
+Connections to IxNetwork Windows on the REST port or to Linux API Server are secured.
+
+
+**9.00**
+
+----
+
+API library release corresponding to IxNetwork 9.00 EA.
+This version adds support for IPv6.

IxNetwork/IxNetwork.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Copyright 1997 - 2018 by IXIA Keysight
+# Copyright 1997 - 2019 by IXIA Keysight
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),
@@ -21,6 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+
 import sys
 import socket
 import select
@@ -39,7 +40,7 @@ class IxNet(object):
     """
 
     def __init__(self):
-        self._version = '8.50.1501.10'
+        self._version = '9.00.1915.16'
         self.OK = '::ixNet::OK'
         self.ERROR = '::ixNet::ERROR'
         self._transportType = None
@@ -82,7 +83,13 @@ def _log(self, msg):
             if (len(msg) > 1024):
                 msg = ''.join([msg[:1024], '...'])
             print('[{timestamp}] [IxNet] [debug] {msg}'.format(timestamp=dt, msg=msg))
-    
+
+    def _is_ipv6(self, hostname):
+        if len(hostname.split(':')) > 1:
+            return True
+        else:
+            return False
+
     def _detectTransport(self, hostname, port= None):
         self._log("Detecting transport type...")
 
@@ -95,7 +102,10 @@ def _detectTransport(self, hostname, port= None):
         else:
             usingDefaultPorts = False
         try:
-            _socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            if self._is_ipv6(hostname):
+                _socket = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
+            else:
+                _socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
             _socket.settimeout(_timeout)
             _socket.setblocking(True)
             _socket.connect((hostname, port))

IxNetwork/IxNetworkLegacy.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Copyright 1997 - 2018 by IXIA Keysight
+# Copyright 1997 - 2019 by IXIA Keysight
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),
@@ -65,7 +65,7 @@ def __init__(self):
         self._timeout = None
         self._transportType = 'TclSocket'
         self._OK = '::ixNet::OK'
-        self._version = '8.50.1501.10'
+        self._version = '9.00.1915.16'
 
     def setDebug(self, debug):
         self._debug = debug
@@ -94,14 +94,23 @@ def _isConnected(self,raiseError=False):
         else:
             return True
 
+    def _is_ipv6(self, hostname):
+        if len(hostname.split(':')) > 1:
+            return True
+        else:
+            return False
+
     def __initialConnect(self, address, port, options):
         # make an initial socket connection
         # this will keep trying as it could be connecting to the proxy
         # which may not have an available application instance at that time
         attempts = 0
         while True:
             try:
-                self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+                if self._is_ipv6(address):
+                    self._socket = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
+                else:
+                    self._socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
                 self._socket.connect((address, port))
                 break
             except (socket.error,):
@@ -128,6 +137,7 @@ def __initialConnect(self, address, port, options):
                 self._socket.sendall(options.encode('ascii'))
                 self._connectTokens = str(self.__Recv())
                 connectTokens = dict(list(zip(self._connectTokens.split()[::2], self._connectTokens.split()[1::2])))
+                print('connectiontoken is %s' %(connectTokens))
                 self._proxySocket = self._socket
                 self._socket = None
                 self.__initialConnect(address, int(connectTokens['-port']), '')
@@ -166,6 +176,12 @@ def connect(self, address, *args):
                 serverusername = nameValuePairs['-serverusername']
             if '-connectTimeout' in nameValuePairs:
                 options += ' -connectTimeout ' + nameValuePairs['-connectTimeout']
+            if '-applicationVersion' in nameValuePairs:
+                options += ' -applicationVersion ' + nameValuePairs['-applicationVersion']
+            if '-persistentApplicationVersion' in nameValuePairs:
+                options += ' -persistentApplicationVersion ' + nameValuePairs['-persistentApplicationVersion']
+            if '-forceVersion' in nameValuePairs:
+                options += ' -forceVersion ' + nameValuePairs['-forceVersion']
             if '-closeServerOnDisconnect' in nameValuePairs:
                 options += ' -closeServerOnDisconnect ' + nameValuePairs['-closeServerOnDisconnect']
             else:
@@ -519,7 +535,11 @@ def __Recv(self):
 
         if len(self._decoratedResult) > 0 and self._decoratedResult[0].startswith('\01'):
             self._decoratedResult[0] = self._decoratedResult[0].replace('\01', '')
-            return eval(''.join(self._decoratedResult))
+            try :
+                return eval(''.join(self._decoratedResult))
+            except :
+                self._decoratedResult[0] = self._decoratedResult[0].replace('\01', '').replace('\r\\n', '')
+                return eval(''.join(self._decoratedResult))
         else:
             return ''.join(self._decoratedResult)
 
@@ -533,4 +553,4 @@ def _log(self, msg):
             dt = datetime.now().strftime("%a %b %d %X %Y")
             if (len(msg) > 1024):
                 msg = ''.join([msg[:1024], '...'])
-            print('[{timestamp}] [IxNet] [debug] {msg}'.format(timestamp=dt, msg=msg))
+            print('[{timestamp}] [IxNet] [debug] {msg}'.format(timestamp=dt, msg=msg))

IxNetwork/IxNetworkSecure.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Copyright 1997 - 2018 by IXIA Keysight
+# Copyright 1997 - 2019 by IXIA Keysight
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"),
@@ -21,6 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+
 import getpass
 import io
 import os
@@ -66,9 +67,14 @@
             missingDependencies.append('backports.ssl')
 try: 
     import urllib3
+    try:
+        import urllib3.contrib.pyopenssl as pyopenssl
+        pyopenssl.inject_into_urllib3()
+    except :
+        missingDependencies.append('pyopenssl')
 except ImportError: 
     missingDependencies.append('urllib3')  
-            
+
 if 'urllib3' not in missingDependencies and 'requests' not in missingDependencies:
     if sys.version_info[0] == 2 and ((sys.version_info[1] == 7 and sys.version_info[2] < 9) or sys.version_info[1] < 7):
         import requests.packages.urllib3
@@ -77,7 +83,8 @@
         except AttributeError:
             raise ImportError('You are using an old urllib3 version which does not support handling the certificate validation warnings. Please upgrade urllib3 using: pip install urllib3 --upgrade')
         if 'backports.ssl' not in missingDependencies and hasattr(urllib3.util, 'IS_PYOPENSSL') and not urllib3.util.IS_PYOPENSSL:
-            missingDependencies.append('pyopenssl')
+            if 'pyopenssl' not in missingDependencies :
+                missingDependencies.append('pyopenssl')
     else:
         try:
             urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
@@ -120,7 +127,7 @@ def _setDefaults(self):
         self._async = False
         self._timeout = None
         self._transportType = 'WebSocket'
-        self._version = '8.50.1501.10'
+        self._version = '9.00.1915.16'
         self.OK = '::ixNet::OK'
         self.ERROR = '::ixNet::ERROR'
         self.VERIFY_CERT = False
@@ -172,7 +179,7 @@ def getApiKey(self, hostname, *args):
 
         port = sessionArgs['-port']
         apiKeyFile = sessionArgs['-apiKeyFile']
-        url = 'https://{hostname}:{port}/api/v1/auth/session'.format(hostname=hostname, port=port)
+        url = 'https://{hostname}:{port}/api/v1/auth/session'.format(hostname=self._ip_encloser(hostname), port=port)
         if not self._isConnected(raiseError=False):
             self._createHeaders()
 
@@ -391,7 +398,7 @@ def connect(self, hostname, *args):
             self._connectionInfo['sessionUrl'] = '{url}/{id}'.format(url=self._connectionInfo['url'], id=self._connectionInfo['sessionId'])
             self._connectionInfo['backendType'] = self._tryGetAttr(session, 'backendType', default='LinuxAPIServer')
             self._connectionInfo['wsUrl'] = '{websocket}://{hostname}:{port}/ixnetworkweb/ixnrest/ws/api/v1/sessions/{id}/ixnetwork/globals/ixnet?closeServerOnDisconnect={closeServerOnDisconnect}&clientType={clientType}&clientUsername={clientusername}'.format(websocket=self._connectionInfo['wsVerb'],
-                                                hostname=self._connectionInfo['hostname'],
+                                                hostname=self._ip_encloser(self._connectionInfo['hostname']),
                                                 port=self._connectionInfo['port'],
                                                 id=self._connectionInfo['sessionId'],
                                                 closeServerOnDisconnect= self._connectionInfo['closeServerOnDisconnect'],
@@ -436,6 +443,7 @@ def connect(self, hostname, *args):
             if self._connectionInfo['sessionUrl'] and self._connectionInfo['closeServerOnDisconnect']:
                 self._cleanUpSession(self._connectionInfo['sessionUrl'])
             self._close()
+            self._deleteSession(self._connectionInfo['sessionUrl'])
             portValueString = ''
             if '-port' in connectArgs:
                 portValueString = connectArgs['-port']
@@ -450,8 +458,9 @@ def connect(self, hostname, *args):
     def disconnect(self):
         if self._isConnected():
             self._close()
-            if self._connectionInfo['closeServerOnDisconnect']:
-                self._cleanUpSession(self._connectionInfo['sessionUrl'])
+            # bye, bye self._cleanUpSession() forever 
+            #if self._connectionInfo['closeServerOnDisconnect']:
+            #    self._cleanUpSession(self._connectionInfo['sessionUrl']) 
             self._setDefaults()
         else:
             return 'not connected'
@@ -591,10 +600,16 @@ def _createHeaders(self, apiKey=None, apiKeyFile=None):
             'Content-Type': 'application/json'
         }
 
+    def _ip_encloser(self, hostname):
+        if len(hostname.split(':')) > 1:
+            return '[{hostname}]'.format(hostname=hostname)
+        else:
+            return hostname 
+    
     def _createUrl(self, verb, hostname, port):
         return '{verb}{verbSeparator}{hostname}{portSeparator}{port}/api/v1/sessions'.format(verb=verb,
                                                                 verbSeparator='://',
-                                                                hostname=hostname,
+                                                                hostname=self._ip_encloser(hostname),
                                                                 portSeparator=':',
                                                                 port=port)
 
@@ -606,7 +621,11 @@ def _setConnectionInfo(self, verb, hostname, port, url):
             self._connectionInfo['wsVerb'] = 'ws' 
         else:
             self._connectionInfo['wsVerb'] = 'wss'
-        self._connectionInfo['hostname'] = hostname
+        m = re.match('\[(?P<hostname>.*)\]', hostname)
+        if m:
+            self._connectionInfo['hostname'] = m.group('hostname')
+        else:
+            self._connectionInfo['hostname'] = hostname
         self._connectionInfo['port'] = port
         self._connectionInfo['url'] = url
 

IxNetwork/requirements.txt

@@ -1,5 +1,5 @@
-backports.ssl>=0.0.9; python_version < '2.7.9'
-backports.ssl-match-hostname>=3.5.0.1; python_version < '2.7.9'
-pyopenssl>=17.5.0; python_version < '2.7.9'
+backports.ssl>=0.0.9
+backports.ssl-match-hostname>=3.5.0.1
+pyopenssl>=17.5.0
 requests>=2.18.4
 websocket-client>=0.47.0

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright 1997 - 2018 by IXIA Keysight
+Copyright 1997 - 2019 by IXIA Keysight
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -35,15 +35,15 @@ Testing
 
 Documentation
 =============
-| For general language documentation of IxNetwork API see the `Low Level API Guide <http://downloads.ixiacom.com/library/user_guides/ixnetwork/8.50/EA_8.50_Rev_A/QuickReferenceGuides/LLAPI_reference_guide.pdf>`_ and the `IxNetwork API Help <http://downloads.ixiacom.com/library/user_guides/ixnetwork/8.50/EA_8.50_Rev_A/IxNetwork_HTML5/IxNetwork.htm>`_.
+| For general language documentation of IxNetwork API see the `Low Level API Guide <http://downloads.ixiacom.com/library/user_guides/ixnetwork/9.00/EA_9.00_Rev_A/QuickReferenceGuides/LLAPI_reference_guide.pdf>`_ and the `IxNetwork API Help <http://downloads.ixiacom.com/library/user_guides/ixnetwork/9.00/EA_9.00_Rev_A/IxNetwork_HTML5/IxNetwork.htm>`_.
 | This will require a login to `Ixia Support <https://support.ixiacom.com/user-guide>`_ web page.
 
 
 IxNetwork API server / Python Support
 =====================================
-IxNetwork.py lib 8.50.1501.9 supports:
+IxNetwork.py lib 9.00.1915.16 supports:
 
-* Python 2.7, 3.3, 3.4, 3.5 and 3.6
+* Python 2.7, 3.3, 3.4, 3.5, 3.6, 3.7
 * IxNetwork Windows API server 8.40+
 * IxNetwork Web Edition (Linux API Server) 8.50+