Skip to main content

Command: --discoverAddOns

Function: The command finds all add-ons in the specified channel which fulfill the specified search criteria.

Call: APInstaller.CLI

Table 17. Options

--searchCriteria <search criteria>

A serialized list of serialized search criteria

--serarchCriteriaFile <search criteria file>

Fully qualified path to a file containing a serialized list of serialized search criteria

--channel <channel>

Name of the setup channel

Mutually exclusive with --channelFile

--channelFile <channel file>

Fully qualified path to a file containing the channel information.

Mutually exclusive with --channel

--outputfile <output file>

Fully qualified path to a file where the result of the command is to be written.

If the option is not specified, then the result is written to the console.

--complete

If set, then the first result found for each search criterion is returned. This allows for a direct assignment of search criterion and result. If nothing was found for a search criterion, then an empty entry (empty GUID) is returned at this point.



Example 6. Examples

APInstaller.CLI --discoverAddOns --searchCriteria "[{\"id\":\"Test.Id.1\"},{\"id\":\"c55fcb5d-3ba7-4f72-b4f9-5a02b501ee7a\"}]"  --outputfile "C:\Temp\out.json" --complete

APInstaller.CLI --discoverAddOns --searchCriteria "[{\"id\":\"IdOrId2\",\"versionRangeFrom\":\"1.0.0\",\"versionRangeTo\":\"5.0.0.0\"}]\"     

Description: Search for the add-on with the ID or ID2 "IdOrId2" and with the version between 1.0.0 and 5.0.0.0

APInstaller.CLI --discoverAddOns --searchCriteria \"[{\"id\":\"IdOrId2\",\"versionRangeFrom\":\"1.0.0\",\"versionRangeTo\":\"5.0.0.0\",\"requiredInstallerVersionRangeFrom\":\"6.0.0.0\",\"requiredInstallerVersionRangeTo\":\"7.0.0.0\",\"etag\":\"MyFancyEtag\",\"name\":\"PackageName\",\"vendor\":\"AnyVendorName\",\"copyright\":\"anyCopyrightText\",\"description\":\"anyDescriptionText\",\"plugIn\":\"{\"AssemblyName\":\"PlugInAssemblyName\",\"ProcessorArchitecture\":1,\"Title\":\"PlugInTitle\",\"Description\":\"PlugInDescription\",\"Company\":\"PlugInCompanyName\",\"Product\":\"PlugInProductName\",\"Copyright\":\"pluginCopyright\",\"Trademark\":\"PlugInTrademarkText\",\"LicenseProtectionData\":\"CodeMeter;101597;602009;http://license.codesys.com;support@3s-software.com;AllowNetwork\",\"Guid\":\"606bd719-1aa9-425a-9fbd-c0ec2ab48d17\",\"Version\":\"1.2.3.4\",}\",\"tag\":\"['ThisIsATag']\"}]\"

Description: Search with all possible search fields

"[
   { 
     "id":"IdOrId2",
      "versionRangeFrom":"1.0.0",
      "versionRangeTo":"5.0.0.0",
      "requiredInstallerVersionRangeFrom":"6.0.0.0",
      "requiredInstallerVersionRangeTo":"7.0.0.0",
      "etag":"MyFancyEtag",
      "name":"PackageName",
      "vendor":"AnyVendorName",
      "copyright":"anyCopyrightText",
      "description":"anyDescriptionText",
      "plugIn":"{ 
        "AssemblyName":"PlugInAssemblyName", 
        "ProcessorArchitecture":1, 
        "Title":"PlugInTitle",
         "Description":"PlugInDescription", 
        "Company":"PlugInCompanyName", 
        "Product":"PlugInProductName",
         "Copyright":"pluginCopyright", 
        "Trademark":"PlugInTrademarkText", 
        "LicenseProtectionData":"CodeMeter;101597;602009;http://license.codesys.com;support@3s-software.com;AllowNetwork",   
        "Guid":"606bd719-1aa9-425a-9fbd-c0ec2ab48d17", 
        "Version":"1.2.3.4",
      }",
      "tag":"['ThisIsATag']"   
    }
]"