Skip to main content

Loading a new scripted target system type

Some target system types listed on the Target system information page are defined by scripted platform definition files that call a binary agent such as the SSH scripted agent (agtssh) and specify a configuration script that defines supported operations.

Scripted platform definition files are written in the following format:

# KVGROUP-V2.0
   <name> = {
     agent = <binaryToRun>;
     script = <script>;
     category = <category>;
     platform = <platformId>;
     description = <languageTagName>;
   }

for example:

# KVGROUP-V2.0
   agtssh-sample = {
     agent = agtssh.exe;
     script = sampleScript.cfg;
     category = SCRIPT;
     platform = AGTSSH-SAMPLE;
     description = !!!AGTSSH-SAMPLE-DESC;
   }

The keys in the scripted platform definition file are all required and are all case-sensitive. The "category" must be a valid platform category. These are described in platcat.csv in the agent\dat directory.

To load a new scripted target system type:

  1. Write a configuration script in the format described in Script systems in the Connector Pack documentation .

  2. Write a scripted platform definition file in the format described on this page.

  3. Add both the configuration script and the .con file to the agent directory.

  4. From the util directory, run:

    loadplatform -a <con filename>.con

    This loads the new target system type into the instance database.

Scripted platform definition files and configuration scripts can also be loaded from other directories outside the agent directory. To do this, place both the configuration script and the .con file into the desired directory and run loadplatform with the absolute or relative path to the .con file. For example:

loadplatform -a <con filename>.con -d "C:\path\to\agent"

SQL scripted connectors also support defining managed identities by using a configuration file in following format:

 # KVGROUP-V2.0
   <name> = {
     agent = <binaryToRun>;
     script = <script>;
     category = <category>;
     platform = <platformId>;
     description = <languageTagName>;
     objects = <object type>;
   }

for example:

  # KVGROUP-V2.0
   agtoracustom = {
     agent = agtorascript.exe;
     script = agtoracustom.cfg;
     category = ATTAP;
     platform = ORACUSTOM;
     description = "Custom oracle target";
     system = false;
     objects = {ACCT;ASSET;GRP;ROLE;};
  }

Providing managed identities in the configuration file allows connectors to be loaded with only operations related to the specified objects.