You require the following properties for creating a group:
Specifies the name of the group to be created.
Specifies the description of the group.
Specifies the True or False depending on the groupDescription value.
Set the value to true if you want the group members to inherit the security permissions of the group.
Specifies the True or False depending on the membersInheritPermissions value.
Specifies the uuid of the query that must be linked to the newly created group. If you do not specify, no query is linked to the group.
Specifies theTrue or false depending on the value of queryUUID.
Specifies the name of the query evaluation engine to be associated with the unit group.
Specifies the True or False depending on the engineName value.
Specifies the Period, in which the query is evaluated, in minutes.
1440 minutes.
10080 minutes.
Specifies the True or False depending on the value of evaluation period.
The createAssessmentTemplate method creates an assessment template
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the information required to create an assessment template. The assessment template name must be unique.
Return Values
Returns zero, if the assessment template is successfully created; otherwise, throws AutomationWebServiceException as a fault.
The updateAssessmentTemplate method updates an assessment template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the old assessment template.
Specifies the information required to create an assessment template. The assessment template name must be unique.
Return Values
Returns zero, if the assessment template is successfully updated; otherwise, throws AutomationWebServiceException as a fault.
The deleteAssessmentTemplates method deletes a list of assessment templates.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the list of the assessment template names you want to delete.
Return Values
Returns zero on successful deletion of all the assessment templates; otherwise, throws AutomationWebServiceExceptionList as a fault.
The getAssessmentTemplate method returns the properties of a specified assessment template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the assessment template you want to retrieve.
Return Values
Contains the properties of the assessment template on success; otherwise, throws AutomationWebServiceException as a fault.
The getAssessmentTemplateList method returns a list of assessment templates names and their last modified dates, based on the specified filter criteria.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter condition on some of the assessment template properties.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns a list of assessment templates names and their last modified dates, on success; otherwise, throws AutomationWebServiceException as a fault.
The getAssessmentTemplateListDetailed method returns a list of assessment templates and their details based on the specified filter criteria.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter on some of the assessment template properties.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the list of Assessment templates, filtered and sorted as specified.
The createAssessmentTask method creates an assessment job.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of group to be assessed.
Specifies the information required to create an assessment task. The assessment task name must be unique.
Return Values
Returns zero, if the assessment template is successfully created; otherwise, throws AutomationWebServiceException as a fault.
The executeAssessmentTask method runs an assessment job.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the assessment task you want to run.
Return Values
Returns zero, if the assessment task is successfully executed; otherwise, throws AutomationWebServiceException as a fault.
The getAssessmentStatus method returns the status of assessment for a particular assessment task.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the assessment task.
Return Values
Returns the status of assessment for the assessment task; otherwise, throws AutomationWebServiceException as a fault.
The getAssessmentResult method gets the results of the assessment task.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the assessment task, the results of which you want to retrieve.
Return Values
Returns the assessment results of the executed assessment task on success; otherwise, throws AutomationWebServiceException as a fault.
The getAssessmentTask method returns information about the assessment task.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies assessment task name for which you need the information.
Return Values
Returns the following sequence as a response on success; otherwise, throws AutomationWebServiceException as a fault.
Contains information about the assessment task.
The getAssessmenTaskList method returns information about all assessment tasks, based on the specified filter and sort criteria.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter on some of the assessment task properties.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Returns the list of assessment tasks based on the mentioned filter and sort properties.
The deleteAssessmentTasks method deletes a list of assessment tasks.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the list of the assessment task names you want to delete.
Return Values
Returns zero on successful deletion of all the assessment tasks; otherwise, throws AutomationWebServiceExceptionList as a fault.
The createOSIMTemplate method creates an OSIM Template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies attributes required to create the OSIM template.
Return Values
Returns zero on successful creation of OSIM template; otherwise, throws AutomationWebServiceException as a fault.
The updateOSIMTemplate method updates an OSIM template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the old OSIM template.
Specifies attributes required to update an OSIM template.
Return Values
Returns zero on successful update of OSIM template; otherwise, throws AutomationWebServiceException as a fault.
The deleteOSIMTemplates method deletes a list of OSIM templates.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the list of OSIM template names you want to delete.
Return Values
Returns zero on successful deletion of all templates; otherwise, throws AutomationWebServiceExceptionList as a fault.
The getOSIMTemplate method returns the properties of an OSIM template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies OSIM template name for which you want to retrieve the properties.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Returns OSIM template properties.
The getOSIMTemplateList method returns a list of OSIM template names and their last modified date, based on the specified filter and sort criteria.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter condition on the OSIM template properties.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains a list of OSIM template names and their last modified date.
The getOsimTemplateListDetailed method returns the OSIM templates objects list, based on filter and sort criteria.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter condition on the OSIM template properties.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Specifies the list of OSIM templates with all fields based on the mentioned filter and sort properties.
The createSoftwareDeploymentTemplate method creates a software deployment template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the properties required to create software deployment template.
Return Values
Returns zero on successful creation of software deployment template; otherwise, throws AutomationWebServiceException as a fault.
The updateSoftwareDeploymentTemplate method updates a software deployment template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the old software deployment template.
Specifies properties you want to update in the software deployment template.
Return Values
Returns zero on successful update of the template; otherwise, throws AutomationWebServiceException as a fault.
The deleteSoftwareDeploymentTemplates method deletes a list of software deployment templates.
Parameters
Specifies the session ID obtained from the DSM web services login.
List of software deployment template names you want to delete.
Return Values
Returns zero on successful deletion of all the software deployment templates; otherwise, throws AutomationWebServiceExceptionList as a fault.
The getSoftwareDeploymentTemplate method gets the properties of a software deployment template.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the software deployment template for which you want to retrieve the properties.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Returns software deployment template properties.
The getSoftwareDeploymentTemplateList method returns a list of software template names and their last modified date, based on filter and sort criteria specified.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter condition on the properties of the software deployment template.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Specifies whether you want to recompute the result set for each call.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains a list of software template names and their last modified date.
The getSoftwareDeploymentTemplateListDetailed method returns the software deployment templates object list based on filter and sort criteria specified.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter condition on the properties of the software deployment template.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains the list of software templates along with their details, retrieved based on the specified filter and sort properties.
The createAutomationProcess method creates an automation process (migration job).
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the properties of the automation process.
Specifies a list of computer groups to be migrated.
Specifies a list of computers to be migrated.
Specifies the handle to the machine mapping file.
Return Values
Returns zero on successful initiation of job creation task else throws Automation Web Service Exception.
The deleteAutomationProcesses method deletes a list of automation processes.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the list of automation process names you want to delete.
Return Values
Returns zero on successful deletion of all processes; otherwise, throws AutomationWebServiceExceptionList as a fault.
The executeAutomationProcess method initiates the migration or revalidation of an automation process.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the name of the automation process you want to execute.
Specifies the type of action.
Return Values
Returns zero on successful execution; otherwise, throws AutomationWebServiceException as a fault.
The getAutomationProcessList method returns basic information about the automation processes, based on the filtering criteria.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter condition on some of the properties of the automation process.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Returns a list automation process names and their last modified date.
The getAutomationProcessListDetailed method returns a list of automation process names and their last modified dates, based on the filtering criteria.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the filter condition on some of the properties of the automation process.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Returns the properties of the filtered automation processes.
The getAutomationResult method returns the result of the automation process.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the automation process name for which you want to retrieve the results.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains the automation process results.
The getAutomationResult2 method returns the results of the automation process. This methods supports sort and filtering operations.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the automation process name for which you want to retrieve the results.
Specifies the filter on some of the automation result properties.
Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.
Specifies the property based on which you want to sort the results.
Specifies whether you want to sort the list in ascending order.
Specifies an index number from which you want the objects to be returned from the result set. This is a zero based index.
Specifies the number of objects you want to retrieve from the startIndex position.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains the automation process results.
The getAutomationProcessTargetStatus method returns the migration status for the specified target computer.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the automation process name. The process name must be a valid and the automation process must at least be in the Validation phase. Otherwise, an error message "No Activity information available" is returned.
Specifies the target computer name.
Specifies the source computer name.
Specifies the UUID of the target computer.
Specifies the UUID of the source computer.
Specifies the IT PAM process instance name.
Specifies the migration status of the target computer.
Return Values
Returns Automation Process Target Status on success; otherwise, throws AutomationWebServiceException as a fault.
The getAutomationProcessStatus method returns the migration job status.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the automation process name. The process name must be a valid and the automation process must at least be in the Validation phase. Otherwise, an error message "No Activity information available" is returned.
Return Values
Returns the automation process status; otherwise, throws AutomationWebServiceException as a fault.
The runAutomationSoftwareJobContainer method launches the software job container execution from CA IT PAM process.
Note: This method can only be called from a workflow within CA IT PAM process and cannot be used as a standalone method.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies whether to run the preinstall or postinstall job container. Following are valid values:
Defines a generic job container. When this parameter is set, the generic job execution is initiated, using the information provided in SD template.
Defines a pre-install job container. When this parameter is set, the pre-install job execution is initiated, using the information provided in SD template.
Defines a post-install job container. When this parameter is set, the post-install job execution is initiated, using the information provided in SD template.
Specifies the ID of the automation job which has spawned the CA IT PAM process.
Specifies the UUID of the computer participating in automated migrations. This ID identifies an CA IT PAM instance launched for the computer. This ID is unique for each computer participating in the automation job.
Return Values
Returns the following information on success; otherwise, throws AutomationWebServiceException as a fault.
Contains a handle that is used in subsequent calls related to automation job container. There will be one unique automation service JobID per computer regardless of how the jobs are optimized in Client Automation.
The runAutomationOSInstallJob method launches the OS deployment execution from CA IT PAM process.
Note: This method can only be called from a workflow within CA IT PAM process and cannot be used as a standalone method.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the ID of the automation job which has spawned this CA IT PAM process.
Specifies the UUID of the computer participating in automated migrations. This ID identifies an CA IT PAM instance launched for the computer. This ID is unique for each computer, participating in an automation job.
Return Values
Returns the following information on success; otherwise, throws AutomationWebServiceException as a fault.
Contains a handle that is used in subsequent calls related to automation job container.
The runAutomationGenericJobContainer method executes the automation generic job container. This method will be called from CA IT PAM process. Once a job is scheduled for execution, the job cannot be rerun because the JobID cannot be used to rerun the job. This eliminates the need to call a method to close the generic job container. Based on the BatchMode, the success status of the generic job container is determined.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specified the ID that identifies the automation job that has spawned this ITPAM process.
Specifies the ID that identifies the machine participating in automated migrations. Automation services provides this ID to ITPAM process instance.
Specifies software container data.
Specifies software job data.
Return Values
Returns the following information on success; otherwise, throws AutomationWebServiceException as a fault.
Contains a handle that is used in subsequent calls related to automation generic job container.
The getActivityLog method provides the activity log for a computer participating in the automation process, identified by computer name.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the automation process name. The process name must be a valid and the automation process must at least be in the Validation phase. Otherwise, an error message "No Activity information available" is returned.
Specifies the computer name for which activity log is required. The computer name must be valid, and must be the original name of the machine. For example, if machine Test001-XP was submitted for Win7 deployment and is being renamed as Test001-W7, then this parameter should be Test001-XP. Otherwise an error "Invalid machine name" is returned.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains the ActivityLog, which provide chronically ordered activities for each requested state.
The getActivityLog2 method provides the activity log for a computer participating in the automation process, identified by the computer UUID.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the automation process name. The process name must be a valid and the automation process must at least be in the Validation phase. Otherwise, an error message "No Activity information available" is returned.
Specifies the computer UUID for which activity log is required.
Return Values
Returns the following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains the ActivityLog, which provide chronically ordered activities for each requested state.
The setActivationStatus method enables or disables a list of computers for migrations.
Parameters
Specifies the session ID obtained from the DSM web services login.
Specifies the automation process name. The process name must be a valid and the automation process must at least be in the Validation phase. Otherwise, an error message "No Activity information available" is returned.
Specifies the list of computers on which you want to enable or disable migration.
Specifies whether you want to enable the list of computer for migration.
Return Values
Returns 0 on success; otherwise, throws AutomationWebServiceException as a fault.
The getSupportedOSForAssessment method returns a list of OS family ClassIDs supported for assessment.
Parameters
Specifies the session ID obtained from the DSM web services login.
Return Values
Returns the list of following sequence on success; otherwise, throws AutomationWebServiceException as a fault.
Contains operating system name and its classID.
The SDTemplateProperties sequence includes the properties of CA Service Desk templates.
Specifies the template Name.
Specifies the template ID.
The BootServerFilter sequence specifies a search filter that you can use for searching or listing boot servers.
Specifies the filter condition you want to apply.
Specifies the property you want to filter.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
Specifies the search value for xsd:long type properties.
Specifies the search value for dsm:SoftwarePackagingType type properties.
Specifies the search value for dsm:PackageFormat type properties.
Specifies the search value for dsm: SoftwarePackageFiledBy type properties.
Specifies the search value for dsm:ArchivePath type properties.
The SoftwarePackageProperties2 sequence contains the software package properties.
Specifies the UUID identifying the software package.
Specifies the name of the software package.
Specifies the version of the software package.
Specifies the UUID of the software package based on which this software package is created or from which this software package is imported. A software package can be created or imported based on another software package.
Specifies the name of the software package based on which this software package is created or from which this software package is imported. A software package can be created or imported based on another software package.
Specifies the version of the software package based on which this software package is created or from which this software package is imported. A software package can be created or imported based on another software package.
Specifies the vendor of the software package.
Specifies the comment for the software package.
Specifies the package source path.
Specifies the type of software package.
Specifies whether the package is selectable from the SD Catalog.
Specifies the source medium for the software package data source.
Specifies the user who created the software package.
Specifies the date and time the software package was created.
Specifies the date and time the software package was last changed.
Specifies the type of the software package. The only type of package you can create is a GENERIC package type.
Specifies the package size.
Specifies the build on size of the package.
Specifies the archive path of the package, if the package is archived.
Specifies the archive comment, if the package is archived.
Specifies the user who performed the archive, if the package is archived.
Specifies the archive flag of the package, if the package is archived.
Specifies the date and time when the package was archived, if the package is archived.
The SDProperties sequence includes the software delivery properties of a computer.
Specifies the name of the job calendar, if any.
Specifies whether to push only the packages created by CA software packager to the computer.
Specifies the RAC Policy for the computer.
Specifies the download method configured for the computer.
The ManagerProperties sequence includes the manager properties.
Specifies the UUID of the manager.
Specifies whether the manager is an enterprise manager or domain manager.
Specifies the installed language on manager.
Specifies the manager version.
The ManagerVersion sequence specifies the different versions of the manager that are retrieved.
Specifies the Client Automation major version on the manager.
Specifies the Client Automation minor version on the manager.
Specifies the Client Automation build number on the manager.
Specifies the Client Automation patch number on the manager.
The CreateSoftwareJobContainerProperties4 sequence of elements specifies the job container properties you want initialize when a software job container is created. This sequence is derived from the CreateSoftwareJobContainerProperties3 sequence and includes additional parameters for opening a CA Service Desk ticket when a job fails.
Specifies the parent software job container ID. If no value is provided, the root “__SD_Jobs” is used as the parent.
Specifies true or false depending on whether the parentSoftwareJobContainerId parameter is supplied.
Specifies the name of the software job container.
Specifies the comment for the software job container.
Specifies true or false depending on whether the comment parameter is supplied.
Specifies the priority that can range from 1 (highest) to 10 (lowest), If no value is provided, the default value, 5, is used.
Specifies true or false depending on whether the priority parameter is supplied.
Specifies the mask for the software job container property. If no value is provided, the default value, linkageBatch and Cascade, is used.
Specifies true or false depending on whether the softwareJobContainerPropertyMask parameter is supplied.
Specifies the custom administrator message.
Checks whether or not the custom administrator message is provided.
Specifies whether to create a CA Service Desk ticket on failure of jobs in job container.
Specifies the name of the CA Service Desk ticket template for creating ServiceDesk requests. Set this parameter only if you have set the openTicketOnFailure parameter to True.
The BootImageFilter sequence specifies a search filter that you can use for searching or listing boot images.
Specifies the filter condition you want to apply.
Specifies the property you want to filter.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
The BootImageProperties sequence specifies the boot image properties.
Specifies the name of the boot image.
Specifies the type of the boot image.
Specifies the operating system of the boot image.
Specifies the date and time of the boot image registration.
Specifies the software delivery package associated with the boot image.
Specifies the version of the software delivery package associated with the boot image.
Specifies the comment included in the software delivery package associated with the boot image.
Specifies the FIPS image flag associated with the boot image.
The BootServerProperties sequence contains the boot server properties.
Specifies the boot server name.
Specifies the boot server status.
Specifies the operating system of the boot server.
Specifies the NFS support for boot server.
Specifies the access method configured for the boot server.
Specifies the date and time of last boot server report.
Specifies the date and time of last boot server response.
Specifies the date and time when the last boots server was requested.
Specifies the configured PXE interface.
Specifies the software delivery package name for Windows.
Specifies the software delivery package name for Linux.
Specifies the software delivery package for r11 version.
The OSIMTargetProperties includes the following parameters:
Specifies the name of the target computer.
Specifies MAC address of the target computer.
Specifies the configuration state of the target computer.
Specifies the changed or activated date and time of the target computer.
Specifies the name of the OS image.
Specifies the created date and time of the target computer.
The following are the OSIMTargetProperties:
Specifies the name of the target computer.
Specifies MAC Address of the target computer.
Specifies the configuration state of the target computer.
Specifies the changed or activated date and time of the target computer.
Specifies the name of the OS image.
The BootServerFilter sequence specifies a search filter that you can use for searching or listing boot servers.
Specifies the filter condition you want to apply.
Specifies the property you want to filter.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
The following sequences of elements specify the properties required when you are retrieving the properties of a computer.
Specifies the UUID of the computer.
Specifies the display name of the computer.
Specifies the UUID identifying the Client Automation domain of the computer.
Specifies the IP address of the computer in 0.0.0.0 format.
Specifies the agent-generated UUID that identifies the computer.
Specifies the UUID identifying the common CA asset to which this computer is linked.
Specifies the host name of the computer.
Specifies the serial number of the computer.
Specifies the serial number of the computer disc.
Specifies the MAC address of the computer. The string must have a maximum length of 64 characters.
Specifies the string value that identifies a computer asset.
Specifies the numeric value indicating the class of the computer object. For example, Operating System.
Specifies the computer usage list mask.
Specifies the fully qualified Uniform Resource Identifier of the computer.
Specifies the user-defined identifier for computer.
Specifies the name of the computer vendor.
Specifies the display name of the DSM domain to which the computer belongs.
Specifies the name of the user account that created the computer record.
Specifies the computer creation date and time.
Specifies the name of the user account that last updated the computer properties.
Specifies the date and time when the computer properties were last updated.
Specifies the version number of the computer record.
Note: The version number is incremented each time a record is updated.
Specifies the agent name of the computer.
Specifies the agent restrictions.
Specifies the agent description.
Specifies the user defined data1.
Specifies the user defined data2.
Specifies the user defined data3.
Specifies the user defined data4.
Specifies the name of the scalability server that the agent is pointing to.
Specifies the agent creation data and time.
Specifies the agent last run date and time.
Specifies the IP address of the agent.
Specifies the trust level of the agent.
Specifies the origin of the agent.
Specifies the AM Agent status.
Specifies the SD Agent status.
Specifies the RC Agent status.
Specifies the Protection Agent status.
Specifies the ASP status.
Specifies the AV status.
Specifies the HIPS status.
The QueryFilter sequence specifies a search filter that you can use for searching or listing queries.
Specifies the filter condition you want to apply.
Specifies the property you want to filter.
Specifies the string you want to search in the name property.
Specifies the query target type.
The QueryProperties2 sequence contains the properties of a query.
Specifies the UUID of the query.
Specifies the name of the query.
Specifies the type of the query.
Specifies whether is query is replicated from enterprise manager. If true, it indicates that the query is replicated from enterprise manager.
The QueryProperty sequence specifies the query properties on which you can apply the sort and filter conditions.
Specifies the name of the query.
Specifies the target type of the query.
The QueryFolderProperties sequence contains the properties of a query folder.
Specifies the name of the query folder.
Specifies the ID of the query folder.
The HWModelFilter sequence specifies a search filter that you can use for searching or listing unique hardware models.
Specifies the filter condition you want to apply.
Specifies the string you want to search in the hardware model name.
The properties of the HM Alert to be updated.
Specifies the state of alert. When set to false, the state of the alert is not updated. However, the userMessage is modified.
Defines the state of alert. When set to true, no error message is seen when new state of alert matches with the old state.
Indicates enumerated elements (New = 0, FollowUp = 1 and Cleared = 2), to change the state of the HM Alert.
Specifies True or False depending on the value of userMessage.
Indicates the user description with the HM Alert.
The Automation Services uses the sequences listed in the subsequent section for automated OS migration functionality.
The AssessmentTemplate sequence contains the properties of an assessment template. You can use this sequence to refer to a new or existing template.
Specifies the name of the assessment template.
Specifies the assessment template type.
Specifies an array of operating system types.
Specifies the assessment attributes supplied, which needs to be used for assessment. There could be ‘n’ number of parameters. However each type of assessment will use only a fixed set of parameters.
Retrieves the last updated date of the template. This parameter contains null value for createAssessmentTemplate and updateAssessmentTemplate methods.
Retrieves the creation date of the template. This parameter contains null value for createAssessmentTemplate and updateAssessmentTemplate methods.
Retrieves the last modified user of the template. This parameter contains null value for createAssessmentTemplate and updateAssessmentTemplate methods.
Retrieves the creation user of the template. This parameter contains null value for createAssessmentTemplate and updateAssessmentTemplate methods.
Retrieves the description of the template.
The AssessmentTask sequence contains the properties of an assessment job.
Specifies the name for the assessment job.
Specifies the super user name. Super user is the administrator of the computer on which the automation service runs.
Specifies the super user password.
Specifies the assessment template to be used for running the job.
The ArrayOfParameter sequence specifies the array of assessment parameters.
Specifies an array of assessment parameters.
The Parameter sequence specifies the name, data type, and value of a parameter.
Specifies the data type of the assessment parameter.
Specifies the name of the assessment parameter.
Specifies the value for the assessment parameter.
The AssessmentTemplateFilter sequence specifies the search filter for searching and listing assessment templates.
Specifies the property you want to filter.
Specifies the filter condition you want to apply.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
The GetTemplateListResponse sequence returns the number of templates and basic information about the templates.
Specifies the total number of templates available.
Specifies the array of template properties.
The TemplateProperties sequence specifies the properties of the template.
Specifies the name of the template.
Specifies the last modified date of the template.
Retrieves the creation date of the template. This parameter contains null value for createAssessmentTemplate and updateAssessmentTemplate methods.
Retrieves the last modified user of the template. This parameter contains null value for createAssessmentTemplate and updateAssessmentTemplate methods.
Retrieves the creation user of the template. This parameter contains null value for createAssessmentTemplate and updateAssessmentTemplate methods.
Retrieves the description of the template.
The GetAssessmentTemplateListDetailedResponse sequence contains the list of templates and the number of records retrieved.
Contains the total number of records retrieved after applying the filter condition.
Specifies the array of assessment templates.
The AssessmentResult sequence contains the result of an assessment job.
Specifies the group type. The assessment job creates various groups depending on whether computers are ready for OS. This parameter contains the different groups.
Specifies the group UUID.
The AssessmentTaskInfo sequence specifies the details of the assessment job.
Specifies the assessment task name.
Contains assessment template properties.
Specifies the group name on which this assessment task was executed.
Specifies the assessment task status.
Specifies creation time of the task.
Specifies who created the task.
Specifies completion time of the task.
Specifies the start time of execution of the task.
Specifies execution user who executed the job.
The AssessmentTaskFilter sequence specifies the search filter for searching and listing assessment jobs.
Specifies the property you want to filter.
Specifies the filter condition you want to apply.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
The GetAssessmentTaskListResponse sequence contains the list of assessment jobs and the number records retrieved.
Contains the total number of records retrieved after applying the filter condition.
Specifies the array of assessment tasks.
The OsimTemplate sequence contains the details of an OSIM template.
Specifies OSIM template name.
Specifies OSIM template type.
Specifies the OS image information as given in ImageType.
Specifies the array of group information mapped against the OS template.
Specifies the array of hardware models mapped against the OS template.
Specifies the last modified date of the OSIM template.
Retrieves the creation date of the template. This parameter contains null value for createOsimTemplate and updateOsimTemplate methods.
Retrieves the last modified user of the template. This parameter contains null value for createOsimTemplate and updateOsimTemplate methods.
Retrieves the creation user of the template. This parameter contains null value for createOsimTemplate and updateOsimTemplate methods.
Retrieves the description of the template.
The CustomizationParameter sequence specifies the OS installation parameters.
Specifies OS installation parameter name.
Specifies OS installation parameter value.
The ImageType sequence specifies the OS image you want to use in the OSIM template.
Specifies the OS image name.
Specifies the UUID of the OS Image ID. This ID is used to uniquely identify the OS image to be deployed.
Specifies an array of OS installation parameters. This is a key-value pair.
The OsimTemplateFilter sequence specifies the search filter for searching and listing OSIM templates.
Specifies the property you want to filter.
Specifies the filter condition you want to apply.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
The GetOsimTemplateListDetailedResponse sequence contains the list of OSIM templates and the number records retrieved.
Contains the total number of records retrieved after applying the filter condition.
Specifies the array of osim templates
The SoftwareDeploymentTemplate sequence contains the properties of a software deployment template. You can use this sequence to refer to a new or existing template.
Specifies a unique name for the software deployment.
Specifies the software packages to be installed before the OS Deployment.
Specifies the software packages to be installed after the OS Deployment.
Defines the mapping between an old and new software packages.
Specifies last modified date of the template.
Retrieves the creation date of the template. This parameter contains null value for createSoftwareDeploymentTemplate and updateSoftwareDeployemntTemplate methods.
Retrieves the last modified user of the template. This parameter contains null value for createSoftwareDeploymentTemplate and updateSoftwareDeployemntTemplate methods.
Retrieves the creation user of the template. This parameter contains null value for createSoftwareDeploymentTemplate and updateSoftwareDeployemntTemplate methods.
Retrieves the description of the template.
The SoftwareJobContainerType sequence specifies the job properties of the software job container.
Specifies the array of software packages.
Specifies the user message.
Specifies whether you want to prompt the user with the message.
Specifies whether you want to allow the user to cancel the job.
Specifies whether you want to execute jobs, if the user prompt times out.
Specifies whether you want to prevent users from logging in while job executes.
Specifies the number of hours for which you want to display a user prompt before forced execution of the job starts.
Default: 24 hours
Specifies the time (in hours) after which, if the job is unable to complete, the job will cease attempts to complete.
Default: 48 hours
Specifies whether you want to store packages in the scalability server library.
The SoftwarePackageType sequence specifies the properties of the software package.
Specifies the software package name.
Specifies the software package version.
Specifies the software package procedure you want to use.
Specifies the restart options requested for the software job before the job is executed.
Default: noReboot
Specifies the restart options requested for the software job after the job is executed.
Default: noReboot
Specifies the user message.
The SoftwarePackageMappingType sequence specifies the mapping between an old and a new software package. If you want to replace a software with a newer version of the software after OS deployment, you can map such software using this sequence.
Specifies the package type defining the source software package.
Specifies the package type defining the target software package.
The SoftwareDeploymentTemplateFilter sequence specifies the search filter for searching and listing software deployment templates.
Specifies the property you want to filter.
Specifies the filter condition you want to apply.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
The GetSoftwareDeploymentTemplateListDetailedResponse sequence contains the list of software deployment templates and the number records retrieved.
Contains the total number of records retrieved after applying the filter condition.
Specifies the array of available software deployment templates.
The AutomationProcess sequence contains the details of an automation process.
Specifies automation process name. The name must be unique.
Specifies OSIM template name.
Specifies software deployment template name.
Specifies process instance name.
Specifies the user name of the CA IT PAM users that you have configured in Client Automation.
Specifies the password of the CA IT PAM users that you have configured in Client Automation.
Specifies the execution time of the process.
Specifies automation process mode.
Specifies automation process status.
Specifies additional information regarding status of the automation job created.
The AutomationProcessFilter sequence specifies the search filter for searching and listing automation processes.
Specifies the property you want to filter.
Specifies the filter condition you want to apply.
Specifies the string you want to search in the name property.
Specifies the date and time value you want to search in the last modified date property.
The GetAutomationProcessListResponse sequence contains the list of automation processes and the number records retrieved.
Contains the total number of records retrieved after applying the filter condition.
Specifies the list of automation processes basic information.
The GetAutomationProcessListDetailedResponse sequence contains the details of the automation processes.
Specifies the total number of available automation processes.
Specifies the list of automation processes.
The AutomationProcessListDeailed contains the detailed information about the automation process.
Specifies the OSIM template parameters used in the automation process.
Specifies the software deployment template parameters used in the automation process.
Provides additional information in case of a failure.
Specifies the creation time of the job.
Specifies the user who created the job.
Specifies the completion time of the job.
Specifies the start time of the job execution.
Specifies the super user name provided while creating the job.
Specifies the name of the job.
Specifies the mode of the created job.
Specifies the current status of the job.
The AutomationProcessBasicInfo contains the details of the basic information about the automation processes.
Specifies the automation process name.
Specifies process instance name.
Specifies automation process mode.
Specifies automation process status.
Provides additional information in case of job execution or job creation failure.
Specifies creation time of the job.
Specifes the user who created the job.
Specifies the completion time of the job.
Specifies the start time of the job.
Specifies the user who executed the job.
The SoftwareContainerData sequence contains details about the software container used in automation process.
Specifies whether you want to execute the jobs in batch mode. If set to false the jobs will execute in No Linkage mode.
Specifies the software container name.
Specifies the job priority.
Range: 1 (highest) to 10 (lowest)
Default: 5
Specifies the custom user message.
The SoftwareJobData sequence contains details about the software jobs.
Specifies the execution date. If not specified, the default value is the current date and time of the domain manager computer.
Allows end users to cancel the prompt for the software job.
Specifies the restart options required for the software job after the job is executed.
Default: 0 (noReboot)
Specifies the restart options required for the software job before the job is executed.
Default: 0 (noReboot)
Specifies the name of a delivery calendar to be used for scheduling the job. The calendar controls the days, dates, and times when delivery is permitted. The time cells that are not set in the calendar define the exclusion intervals. If the name of the calendar is unknown to SD, the job is not created.
Specifies the delivery date and time. If not supplied, the default value is the current date and time of the domain manager computer.
Specifies whether to execute jobs, if prompt times out.
Specifies whether to ignore job calendars, if any, on target computers.
Specifies the number of hours after the job the will timeout if it was unable to complete.
Default: 168 hours
Specifies whether the job must trigger the scalability server.
Specifies whether to prevent users from being logged on while job executes.
Specifies the software job name.
Specifies the number of hours for which you want to display a user prompt before forced execution of the job starts.
Default: 24 hours
Specifies a message to be prompted on the target computer before the job starts.
Specifies whether to resolve the target groups before the job is set up.
Specifies whether to run while the system is allowed to shutdown.
Specifies whether to execute procedure offline from the scalability server.
Specifies the software package data.
Specifies whether to store the packages in the scalability server library.
Specifies whether the time is relative to enterprise manager.
Specifies whether the deliveryCalendar parameter is supplied.
Specifies the user-defined parameters.
The SoftwarePackageData sequence contains details about the software package.
Specifies the software package name.
Specifies the name of the procedure to be run.
Specifies the version number of the software package.
The AutomationResultResponse sequence contains the result of the automation process.
Specifies the number of computers involved in the automation process.
Specifies the job status. This is the overall job status.
Specifies the array of target status.
Specifies additional information in case of job execution failure.
The SoftwareJobContainerParameter sequence specifies the details of software job container.
Specifies the name of the software job container parameter.
Specifies the value of the software job container parameter.
The ActivityLog sequence contains the activity log details:
Specifies the activity message.
Specifies the log level.
Specifies the timestamp of the message.
The ActivityLogResponse sequence contains the following information:
Specifies an array of activity log entries.
The GlobalType sequence contains the following information:
Specifies information about the OS image that is applicable for all the target computers.
The GroupType sequence specifies the following information about the group type. This sequence can have multiple group information mapped against an OS image.
Specifies the name of the group.
Specifies information about the OS image mapped to the group.
The HardWareModelType sequence contains the following information:
Specifies name of the hardware model.
Specifies information about the OS image mapped to the hardware model.
The AutomationProcessTargetStatus sequence contains the following information:
Specifies the target name.
Specifies the UUID of the target computer.
Specifies the automation status of the target computer.
The ArrayOfAutomationProcessTargetStatus sequence contains the following information:
Specifies an array of target status.
The AutomationResultFilter sequence contains the following information:
Specifies the automation result property.
Specifies the filter condition.
Specifies the string you want to search in the specified property.
Specifies the target status.
The AutomationWebServiceException sequence contains the following information:
Specifies the error code.
Specifies the error message.
Specifies additional error details, if any.
The AutomationWebServiceExceptionList sequence contains the following information:
Specifies the array of AutomationWebServiceExceptions.
The ArrayOfAutomationWebServiceException sequence contains the following information:
Specifies the array of AutomationWebServiceExceptions.
The OperatingSystemType sequence contains the following information:
Specifies the operating system name.
Specifies the operating system classID.
The ArrayOfAutomationProcessListDetailed sequence includes the automation process properties.
Specifies the list of automation processes with detailed information about OSIM and SD Options.
The ArrayOfAutomationProcess sequence includes the automation process properties.
Specifies an array of automation process properties.
The ArrayOfAutomationProcessBasicInfo sequence contains basic information about the automation process.
Specifies an array of basic information about the automation processes.
The ArrayOfAutomationProcessTargetStatus sequence specifies a list of target statuses.
Specifies the list of target statuses.
The ArrayOfActivityLog sequence contains the following information:
Specifies the array of activity logs.
The ArrayOfAssessmentTaskInfo sequence contains the following information:
Specifies an array of assessment tasks.
The ArrayOfAssessmentTemplate sequence contains the following information:
Specifies an array of assessment templates.
The ArrayOfGroupType sequence contains the following information:
Specifies an array of group type. This parameter can have multiple group information mapped against an OS image. For example: Group1 -> OSImage1, Group3-> OSImage2.
The ArrayOfHardWareModelType sequence contains the following information:
Specifies an array of hardware model types. This parameter can have multiple hardware models mapped against OS images. For example:HWModelName->OSImage1, HWModel2->OSImage3.
The ArrayOfOsimTemplate sequence contains the following information:
Specifies the array of osim templates
The ArrayOfSoftwareDeploymentTemplate sequence contains the following information:
Specifies an array of software deployment templates.
The ArrayOfSoftwarePackageMappingType sequence contains the following information:
Specifies an array of software package mapping types.
The ArrayOfSoftwarePackageType sequence contains the following information:
Specifies an array of software package types.
The ArrayOfTemplateProperties sequence contains the following information:
Specifies an array of template properties.
The ArrayOf_xsd_string sequence contains the following information:
Specifies an array of string values.
The ArrayOfCustomizationParameter sequence contains the following information:
Specifies an array OS installation parameters that you want to customize. This parameter provides a placeholder for OS deployment parameters.
The ArrayOfOperatingSystemType sequence contains the following information:
Specifies the array of operating system type.
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|