Loading API Index...
Open Automation Software API Documentation
Show / Hide Table of Contents

Update Version

GetAvailableVersionsFromDownloadServer

  • Returns a sorted list of available versions from a download server.
  • Parameter CustomServerFilePath: Will allow you to use your own hosting server as an http or ftp file path to download. When left blank the OAS download server will be used.
  • Parameter FTPUser: The user for your own download server when using ftp.
  • Parameter FTPPassword: The password for your own download server when using ftp.
  • Returns: Sorted array of available versions.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string path = "";
            string user = "";
            string pw = "";
            string[] versionsavailable = oasc.GetAvailableVersionsFromDownloadServer(path, user, pw);

            foreach (var Version in versionsavailable){
                Console.WriteLine(Version);
            }            
        }
    }
}
VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim path As String = ""
            Dim user As String = ""
            Dim pw As String = ""
            Dim versionsavailable As String() = oasc.GetAvailableVersionsFromDownloadServer(path, user, pw)

            For Each Version In versionsavailable
                Console.WriteLine(Version)
            Next
        End Sub
    End Class
End Namespace

GetProductVersion

  • Returns the installed product version from the OAS Engine.
  • Parameter NetworkNode: The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Parameter RemoteSCADAHostingName: The name of the Live Data Cloud OAS Service to connect to.
  • Returns: Product version in the format of 00.00.0000 if successful. Returns Error if unsuccesful.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string NetworkNode = "";
            string scadahost = "";
            string version = oasc.GetProductVersion(NetworkNode, scadahost);
            Console.WriteLine(version);
        }
    }
}
VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim NetworkNode As String = ""
            Dim scadahost As String = ""
            Dim version As String = oasc.GetProductVersion(NetworkNode, scadahost)
            Console.WriteLine(version)
        End Sub
    End Class
End Namespace

GetServiceVersion

  • Returns the installed service version from the OAS Engine.
  • Parameter NetworkNode: The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Parameter RemoteSCADAHostingName: The name of the Live Data Cloud OAS Service to connect to.
  • Returns: Service version in the format of 0.0.0.0 if successful. Returns Error if unsuccesful.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string NetworkNode = "";
            string remoteSCADA = "";
            string serviceversion = oasc.GetServiceVersion(NetworkNode, remoteSCADA);

                Console.WriteLine(serviceversion);
            
        }
    }
}
VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim NetworkNode As String = ""
            Dim remoteSCADA As String = ""
            Dim serviceversion As String = oasc.GetServiceVersion(NetworkNode, remoteSCADA)
            Console.WriteLine(serviceversion)
        End Sub
    End Class
End Namespace

UpdateOASVersion

  • Starts an automated update.
  • Parameter NetworkNode: The name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Parameter RemoteSCADAHostingName: The name of the Live Data Cloud OAS Service to connect to.
  • Parameter CustomServerFilePathOAS: Will allow you to use your own hosting server as an http or ftp file path to download a specific version of the oas platform. When left blank the OAS download server will be used with the latest version available from the OAS download server. Example: https://filedownloads.openautomationsoftware.com/windows/V15.00.0014/ for - - Windows and https://filedownloads.openautomationsoftware.com/linux/V15.00.0014/ for Linux.
  • Parameter CustomServerFilePathOASUpdate: Will allow you to use your own hosting server as an http or ftp file path to download a specific version of the update application. When left blank the OAS download server will be used with the latest version available from the OAS download server. Example: https://filedownloads.openautomationsoftware.com/windows-update/V15.00.0014/ for Windows and https://filedownloads.openautomationsoftware.com/linux-update/V15.00.0014/ for Linux.
  • Parameter FTPUser:The user for your own download server when using ftp.
  • Parameter FTPPassword: The password for your own download server when using ftp.
  • Returns: Success if update begins or Error if parameter is invalid.
C#
using System;

namespace OASDataSample
{
    class Program
    {
        static OASConfig.Config oasc = new OASConfig.Config();
        static void Main(string[] args)
        {
            string NetworkNode = "";
            string remoteSCADA = "";
            string filepathOAS = "";
            string filepathUpdate = "";
            string ftpuser = "";
            string pw = "";

            string result = oasc.UpdateOASVersion(NetworkNode, remoteSCADA, filepathOAS, filepathUpdate, ftpuser, pw);

            Console.WriteLine(result);
            
        }
    }
}
VB
Imports System

Namespace OASDataSample
    Class Program
        Shared oasc As OASConfig.Config = New OASConfig.Config()

        Public Shared Sub Main(ByVal args As String())
            Dim NetworkNode As String = ""
            Dim remoteSCADA As String = ""
            Dim filepathOAS As String = ""
            Dim filepathUpdate As String = ""
            Dim ftpuser As String = ""
            Dim pw As String = ""
            Dim result As String = oasc.UpdateOASVersion(NetworkNode, remoteSCADA, filepathOAS, filepathUpdate, ftpuser, pw)
            Console.WriteLine(result)
        End Sub
    End Class
End Namespace
Back to top Copyright (c) Open Automation Software. All rights reserved.