Software Download & Update

Latest Releases

NSG Appliance Release

The below update package is to be used only on our Sangoma NSG appliances. It will update the TDM card driver and NSG application modules

Upgrade Release

Open  nsg-5.2.0-121-GA.update.tgz     NSG appliance Update package Open | version 5.2.0-121 | Added: 15/12/2016 | Changelog

ISO Release

NSG Software Release

The below package is to be used on your own Linux platform to update your NSG Software version to the current release.

ISO Installation

1. Burn the nsg ISO on to a CDROM 

2. Insert CDROM into a server CDROM drive.

3. Boot from CDROM

4. Follow step by step installation.

5. Each ISO comes with a default DEMO License
   You must purchase a real license from Sangoma Sales. 

Updating NSG Appliance

Backup 

Best practice before an update is to backup full user configuration, which is the procedure described below.

The following backup procedure is a complete backup including the following files:

• license

• NSG user configuration

• TDM card configuration

• Dial plan

• SIP profiles

• NSG network configuration

The backup can be used to restore on a new NSG Gateway installation in the case of a catastrophic failure.

• Log into the NSG web-GUI with your log in credentials
  
  
  

• Click on Backup - Restore located under Configuration -> Management
  
  

  
  
  

• Click on the Backup and Download Now button

   

• A backup file should now be saved on your local system with the following name format:
  > backup-localhost.localnet-<time & date>.tar

Update

The information below provides instructions to update the NSG Gateway appliance

• Verify the NSG Gateway is stopped before performing the update procedure.

  • If you need to stop the NSG Gateway you can do so by following two below methods:

    • From the WebGUI navigate to NSG Control Panel and press the 'stop' button for Media Gateway and TDM Driver
      
      

      • Download the NSG Appliance update release

        • Navigate to NSG Appliance Update and click the download button, as seen in the screen below :
          
          

        • You will be prompted to save the download package on the local machine you are accessing the web browser from.

          • The downloaded package must be saved in a location on the NSG Gateway

          • To save the file directly on the NSG Gateway, log into the appliance's command line

          • To log into the appliance's command line, ssh using a program of your choice (we use a program called Putty for the rest of this process)

            • Open putty and type root@<NSG Gateway IP address> in the text box as seen below
              
              

            • You will be required to type in the root password  

            •  Once logged in you should see a screen similar to the below
              
              
              

• Save the NSG update package in the /root directory

  • To navigate to the root directory simply type:
    > cd /root
    > press the <enter> key 

  • Now insert the download package here

  • If you don't know how to save the downloaded NSG update package in this directory follow the below procedure:

    • Navigate back to the NSG update package download link, right click on the Download button and Copy the Link

    • Navigate to the NSG's command line, type 'wget' and then paste the the copied link
      (the NSG appliance will require internet access for this step)
      
      

    • The package should download within minutes, based on the internet connection

    • To verify that the package was successfully downloaded type ls in the current directory (which should be the root directory if the above steps were followed)

• Install the NSG Update package on the NSG Gateway.  From within the NSG command line, type:

  • Create a new directory to contain the archieve contents

    • mkdir update.<version>  (<version> is used as a placeholder for the actual version because this document will not be updated for every new release that is created)

  • un-compress the downloaded NSG package by typing:

    • tar xzvf nsg-<version>-GA.update.tgz -C update.<version>  (<version> is used as a placeholder for the actual version because this document will not be updated for every new release that is created)
      An update directory will have been created

• Initialize the update archive: 

  • update.<version>/update/scripts/update.sh initialize

• Check update (list RPM to be updated only, doesn't display other steps)

  • update.<version>/update/scripts/update.sh check 

• Display update version information

  • update.<version>/update/scripts/update.sh version

• Install the NSG update package by typing:

  • update.<version>/update/scripts/update.sh install

• Retrieve log:

  • update.<version>/update/scripts/update.sh logs

• The upgrade process will take a few minutes.  The upgrade will update the Appliance and then restart the NSG services automatically to bring your production back up.

Updating NSG Software Install

Backup 

Best practice before an update is to backup full user configuration, which is the procedure described below.

The following backup procedure is a complete backup including the following files:

• license

• NSG user configuration

• TDM card configuration

• Dial plan

• SIP profiles

• NSG network configuration

The backup can be used to restore on a new NSG Gateway installation in the case of a catastrophic failure.

• Log into the NSG Linux Command line using a terminal program of your choice (example: putty)

  • Example:
    
    

  •  

• Navigate to the NSG directory /usr/local/nsg/ :

  • Type the following on the Linux command line:

    • cd  /usr/local/nsg

    • press <enter>
      
      

       

• Type the following command within the /usr/local/nsg directory to create the backup package

  • tar cfz nsg-backup.tgz conf/ .   (make sure to include the '.' at the end which saves the backup in the same directory)
    example:
    
    

     

• A file called nsg-backup.tgz will be saved in the current directory.  To verify simply type the following command and look for your file:

  • ls
    example: 
    
    

     

  • This process has backed up the NSG Gateway configuration

  • Move this file to a directory of your choice for safe keeping. For example, you can move this to the root directory by typing:
    -> cp nsg-backup.tgz /root

•  To backup the TDM configuration follow the same process inside the /etc/wanpipe directory

  • Change directory to /etc/wanpipe:

    • type: cd /etc/wanpipe

    • press <enter>
      example: 
      
      

    • type: tar cfz wanpipe-backup.tgz wan* .   (make sure to include the '.' at the end which saves the backup in the same directory)
      example:
      
      

    • Move this file to a location of your choice.  For example to move to the root directory type:
      > cp wanpipe-backup.tgz /root
      
      

• The NSG Gateway is now completely backup up

  • nsg-backup.tgz contains the NSG Gateway portion

  • wanpipe-backup.tgz contains the TDM card(s) backup

Update

The information below provides instructions to update the NSG Software version on your Linux platform. It requires a complete install/re-install of the software to the current version.

• Verify the NSG Gateway is stopped before performing the update procedure.

  • If you need to stop the NSG Gateway, you can do so by following either of the two below methods:

    • From WebGUI: Navigate to NSG Control Panel and press the 'stop' button for Media Gateway and TDM Driver
      
      
      

       

    • From Linux CLI: Type the following command from any directory

      • > nsg service stop

• Download the latest/current NSG Software Release to a directory on your Linux system (we will use /usr/src/ as the directory to download to)

  • Go to the /usr/src directory 

    • type: cd /usr/src/

    • press the <enter> key

  • Download the NSG Software release 

    • Navigate to NSG Software Update and click the download button, as seen in the screen below :
      
      

    • Your Linux system will prompt you where to store the NSG Software download.  Save the software package in /usr/src directory of the same system NSG is located.

      • Instructions to perform this step are skipped as they are assumed understood by the user.

    • Alternatively you can right-click on the download button and save the link, then use the 'wget' Linux command to directly paste the NSG software download link in the CLI.  To do this type:

      • cd /usr/src/

      • wget nsg-<version>.x86_64.tar.gz   (you must replace <version> with the current version number. It has been left blank here since NSG versions change overtime and this documentation does not update with each released version).  A real example is: "wget nsg-5.2.0-121.x86_64.tar.gz"
         

      • The below screenshots show this procedure:
        
        NSG Software Update
        
        

         
        
        Linux CLI:
        
        

         

  • Verify the download has been saved in the /usr/src/ directory

    • Navigate to /usr/src/ by typing:

      • cd /usr/src

      • press the <enter> key

    • list all the files in /usr/src/ and verify you see the downloaded NSG software package 

      • type: ls

    • example: 
       

  • uncompress the downloaded NSG Software package which is now located in the /usr/src/ directory

    • type: > tar xfz nsg-<version>.x86_64.tar.gz (you must replace <version> with the current version number. It has been left blank here since NSG versions change overtime and this documentation does not update with each released version).  A real example is: "tar xfz nsg-5.2.0-121.x86_64.tar.gz"

      • example: 
        
        
        

    • This will create an nsg directory 

      • verify by typing ls in the /usr/src/ directory
        example:
        
        

  • Install the NSG Software package.  Type:

    • cd nsg-<version>.x86_64.tgz    (you must replace <version> with the current version number. It has been left blank here since NSG versions change overtime and this documentation does not update with each released version).  A real example is: "cd nsg-5.2.0-121.x86_64.tar.gz"

    • make install

    • The upgrade is now complete

  • Start the NSG Gateway 

    • In any directory in the Linux command line type:

      • service nsg start

  • Make some test call to verify everything is working on the updated NSG release

    • If there are any issues and you would like to restore your configuration on this new NSG release follow the below instructions:

      • Stop the NSG Gateway by typing service nsg stop in your Linux command line

      • Verify there is an nsg backup file saved in the system. (It should be in the /root directory based on the backup instructions on this wiki). The backup file should be called nsg-backup.tgz

      • move the current nsg directory to another location, as we will overwrite it with the backed up nsg directory

        • type: mv /usr/local/nsg/conf /root  (this will move the /nsg/ directory to the /root directory for safe keeping)

      • type: cp /root/nsg-backup.tgz /usr/local/nsg/   (this will copy the nsg-backup.tgz file which was created prior to the upgrade into the /usr/local/nsg directory)

      • overwrite the current /usr/local/nsg/conf directory by uncompressing the nsg backup.  Type:

        • tar xfz nsg-backup.tgz

        • the new /conf directory will include all the saved /conf files which is the complete information of when NSG was working

      • start NSG Gateway

        • in any directory, type: nsg service start

  • If issue are still present after the upgrade, please contact our support team at support.sangoma.com