Administrator SDK 1.3 Release Notes

Article:HOWTO5355  |  Created: 2007-01-12  |  Updated: 2007-01-12  |  Article URL http://www.symantec.com/docs/HOWTO5355
Article Type
How To


Question
What do I need to know about the 1.3 release of the Administrator's SDK?

Answer

Altiris ASDK Version 1.3 Release Notes

New Features
Release 1.3 implements the following new features:

  • A TaskManagement library has been added. This library supports Task Management Solution functionality.
    • Currently includes APIs for:
      • GetTasks: Get the GUIDs of all tasks and jobs under the given parent folder.
      • GetTasksByType: Get the GUIDs of all tasks and/or jobs of a given type under the given parent folder.
      • GetTask: Get detailed information for a specific task.
      • ExecuteTask: Immediately executes a task or job.
      • ScheduleTaskShared: Creates a schedule for a task or job using a shared schedule.
      • ScheduleTaskCustom: Creates a schedule for a task or job using a custom schedule.
      • GetExecutedTaskInstances: Gets the GUIDs of task instances that have already executed.
      • GetTaskStatus: Gets the status information of a task or job.
      • GetTaskResourceStatus: Gets the status information of a given task executed on a given resource.
  • A new API set has been added to automate Deployment Solution functionality.
    • Note: The APIs within the Altiris.ASDK.DS namespace were tested using Deployment Server version 6.8.206.0.
    • This API includes the following libraries and methods:
      • Computer Management:
        • AddBasicVirtualComputer: Adds a virtual computer to the Deployment Solution database.
        • AddVirtualComputer: Adds a virtual computer to the Deployment Solution database.
        • DeleteComputer: Deletes the computer record from the Deployment Solution database.
        • DeleteComputerByAttribute: Overloaded function which allows the user to call DeleteComputer without the computer ID.
        • GetComputerID: Finds the computer ID associated with the given search criteria.
        • GetComputerIDsInGroup: Returns a list of the computers that belong to the given group ID.
        • GetComputerInfo: Returns computer information for a computer.
        • GetComputerInfoByAttribute: Returns computer information for a computer identified by other than computerID.
        • GetComputerList: Returns a list of computer IDs that meet the requirements of the given search phrase.
        • GetComputerSchedules: Returns a list of the jobs assigned to the computer and their status.
        • GetSchedulesByAttribute: Returns a list of the jobs assigned to a computer identified by other than computer ID, and their status.
        • MoveComputer: Moves the computer to the given group.
        • MoveComputerByAttribute: Moves a computer identified by other than computer ID to the given group.
        • MoveComputerByGroupName: Moves a computer identified by other than computer ID and with a full group name other than a group ID.
        • RenameComputer: Changes the computer name associate with the given computer ID to the new name provided.
        • RenameComputerByAttribute: Changes the computer name associate with a computer identified by other than computer ID to the new name provided.
      • Folder Management:
        • CreateFolder: Adds a folder to the Deployment Solution database.
        • Delete Folder: Deletes the folder from the Deployment Solution database.
        • DeleteFolderByName: Deletes the folder with the given name from the Deployment Solution database.
        • DeleteFolders: Deletes the given folders from the Deployment Solution database.
        • GetFolderID: Deletes the given folders from the Deployment Solution database.
        • MoveFolder: Moves the folder to the given parent folder.
        • RenameFolder: Renames the folder with the given name.
      • Group Management:
        • CreateGroup: Adds a group to the Deployment Solution database.
        • DeleteGroup: Deletes the given group from the Deployment Solution database (won't delete All Computers or New Computers).
        • DeleteGroupByName: Deletes the group with the given name from the Deployment Solution database (won't delete All Computers or New Computers).
        • DeleteGroups: Deletes the groups from the Deployment Solution database (won't delete All Computers or New Computers).
        • GetGroupID: Returns the group ID that matches the full group name provided.
        • MoveGroup: Moves a group to the given parent group.
        • RenameGroup: Renames the given group in the Deployment Solution database (does not work on New Computers or All Computers).
      • Job Management:
        • CreateJob: Creates a new job record from the Deployment Solution database.
        • DeleteJob: Deletes a job record from the Deployment Solution database.
        • DeleteJobs: Deletes the job records from the Deployment Solution database.
        • GetJob: Deletes the job records from the Deployment Solution database.
        • GetJobIDs: Returns the Job IDs from the Deployment Solution database that meet the search criteria.
        • GetJobIDsByTask: Returns the job IDs from the Deployment Solution database that meet the search criteria.
        • GetJobIDsInFolder: Returns the Job IDs from the Deployment Solution database that meet the search criteria.
        • GetJobInfo: Returns general job information from the Deployment Solution database for the given job ID.
        • GetJobSchedules: Returns schedule information for the job in the Deployment Solution database.
        • MoveJob: Moves a job to the specified folder.
        • MoveJobs: Moves each job in the list to the specified folder.
        • RenameJob: Changes the name of the job in the Deployment Solution database.
        • SetJobDescription: Changes the description of the job in the Deployment Solution database.
        • UpdateJob: Updates a job.
      • Schedule Management:
        • CreateJobSchedule: Creates a schedule on the computer for the given job.
        • CreateJobScheduleByName: Creates a schedule on the computer for the given job.
        • CreateJobSchedules: Creates schedules on the computers for the given jobs.
        • DeleteJobSchedule: Deletes the schedule from the Deployment Solution database.
        • RegisterExternalApp: Register external application with DS.
  • The AssetManagement library has a new API:
    • CreateResourceAssociation: Creates a new resource association between a given parent resource and a given child resource.
  • The SoftwareDelivery library (Altiris.ASDK.NS.SoftwareDelivery) has a new API:
    • SetAdvertisementExAgentSettings2: sets the Advance options for a task, including Agent name and description. This API should be used for all new code and scripts. However, SetAdvertisementExAgentSettings is still supported for existing code and scripts.

Fixes
Release 1.3 has fixed the following issues:

  • Previously, when a CLI command was called with the wrong number of parameters, the error message stated: "An Exception occured. Unknown metho:<method name>". This error message has been modified to indicate that the problem may lie with the wrong number of parameter.
  • The TaskManagement.GetTask method, when called through the COM layer (VBScript), did not work. This has been fixed.
  • TaskManagement.ExecuteTask previously threw an exception due to lack of permission when the given computer collection was "All Computers" or "All Win32 Computers". This has been fixed.
  • Previously, when a CLI command returned data that contained nested arrays of data, the nested arrays were not properly displayed. This has been fixed.
  • ScheduleTaskShared, ScheduleTaskCustom and ExecuteTask in the TaskManagement library allow an empty string to be passed into the "inputParameters" parameter. This parameter is for passing Xml-formatted input parameters to the task or job. Some tasks or jobs do not require input parameters; however, for those that do, an empty string would cause the API to silently fail.  These API's will now throw an exception if the proper input parameters are not given.
  • Previously, the ASDK modules "Altiris ASDK Task Management Solution" and "ASDKAsset" incorrectly appeared in the NS 6.0 Console as items under the Solutions Settings folder on the Configuration tab, instead of appearing as installed solutions in the Solution Center page, as they should have. This has been fixed.
  • Previously, there was an unspecified limit to the number of ASDK modules that would install from the installation wizard. For example, if all the checkboxes were checked by the user upon install for all ASDK features/modules (and most or all ASDK-supported NS solutions were already installed in NS), the last two or three checked items might not be installed. This has been fixed so that all checked items will now be installed.
  • Previous versions of the Early Access release of the Altiris.ASDK.DS library sometimes threw a NullReferenceException when DS security is enabled and a DS ASDK library call was made without first having passed in DS credentials in the calling code/script. This has been fixed so that a more informative security exception will be thrown in this case to inform the user that DS credentials need to be set before making the call.
  • In prior releases, the Altiris.ASDK.DS module had two different methods both named "GetSchedules", one in the ComputerManagement library and the other in the JobManagement library.  This caused a naming conflict that made one of the methods unusable from the CLI interface. The names of these methods have been changed to GetComputerSchedules and GetJobSchedules, respectively, and both methods may now be called from the CLI as well as from the other interfaces.
  • NS security issues in the Altiris.ASDK.NS.SoftwareDelivery module have been addressed.

Known Issues
Release 1.3 has the following known issues:

  • GetScheduleXml doesn't work correctly for SWD advertisements.
  • When using SetItemsSchedule on an advertisement object, your NS may hang for several minutes.
  • Some API(s) from the SWD Basic Library (Altiris.ASDK.SWD) may cause your NS to hang for several minutes.
  • CreateLocalInstance as described in the Com Programming Guide is currently only available for NS APIs. It is not implemented for Helpdesk and SWD.  
  • ComputerManagement.GetComputerIDsInGroup method in the Deployment Server API set returns an error if a group folder is empty.
  • FolderManagement.DeleteFolderByName in the Deployment Server API set will delete the parent folder instead of the (lowest-level) child folder if the child folder does not exist.  For example, if a relatvie path of "folder1\folder2" exists, the calling DeleteFolderByName will correctly delete "folder2" the first time it is run.  However, if the method is run again with the same input of "folder1\folder2", folder1 will be deleted.
  • ComputerManagement.GetComputerInfo in the Deployment Server API set does not work due to a missing publisher policy in the Global Assembly Cache (GAC).
  • Any VB Script (COM) API call in the Altiris.ASDK.DS.ScheduleManagement library that takes a Schedule Attribute argument comprised of an XML string with an embedded date in it, does not work correctly when using CreateLocalInstance(). As a workaround, avoid calling CreateLocalInstance() and instead use the web service by setting the TargetServer property and calling Authenticate() (see the documentation help files for how to make this change in your script).
  • Calling ComputerManagement.GetComputerInfo() in the Altiris.ASDK.DS namespace on a "virtual computer" created by a previous call to ComputerManagement.AddBasicVirtualComputer() or AddVirtualComputer(), will result in an exception.  This is to be expected, since a virtual computer is meant as a placeholder and it does not have any data in the the database that would be returned by GetComputerInfo() on an actual computer.

Upgrade Instructions
To upgrade your version of the ASDK you must first completely uninstall the current version, including any previously-installed Early Access version of the 1.3 Release, and then install the new version. Complete the following steps:

Part I—Uninstall

  1. Go to Start > Control Panel > Add or Remove Programs.
  2. In the Add or Remove Programs window click on Altiris ASDK.
  3. Click Remove.
  4. A dialog will appear warning you that this will remove all the ASDK components on this computer. Click OK.
  5. After a few minutes a dialog will appear indicating the ASDK has been uninstalled. Click OK.
Part II—Install
  1. Download and unzip the ASDK installation file.
  2. In the extracted directory, double-click the executable Altiris_ASDK_1_3.exe
  3. Complete the installation as outlined in the installation section of the ASDK documentation (available for separate download).
Part III—Install to other computers

If you have installed the ASDK or any portion of the ASDK onto another computer, be sure to update those files as well. You will need to login to that computer, uninstall the current version, and then install the new version.



Legacy ID



28299


Article URL http://www.symantec.com/docs/HOWTO5355


Terms of use for this information are found in Legal Notices