CA Itcm Connector Enu

CA IT Client Manager Connector Guide
r1
CA IT Process Automation
Manager

This documentation and any related computer software help programs (hereinafter referred to as the
"Documentation") are for your informational purposes only and are subject to change or withdrawal by CA at any time.
This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part,
without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may
not be used or disclosed by you except as may be permitted in a separate confidentiality agreement between you and
CA.
Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation,
you may print a reasonable number of copies of the Documentation for internal use by you and your employees in
connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.
The right to print copies of the Documentation is limited to the period during which the applicable license for such
software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify
in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION "AS IS" WITHOUT
WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER
OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION,
INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR
LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
The use of any software product referenced in the Documentation is governed by the applicable license agreement and
is not modified in any way by the terms of this notice.
The manufacturer of this Documentation is CA.
Provided with "Restricted Rights." Use, duplication or disclosure by the United States Government is subject to the
restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section
252.227-7014(b)(3), as applicable, or their successors.
Copyright 2010 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein
belong to their respective companies.

Contact CA
Contact Technical Support
For your convenience, CA provides one site where you can access the
information you need for your Home Office, Small Business, and Enterprise CA
products. At http://ca.com/support, you can access the following:
Online and telephone contact information for technical assistance and
customer services
Information about user communities and forums
Product and documentation downloads
CA Support policies and guidelines
Other helpful resources appropriate for your product
Provide Feedback
If you have comments or questions about CA product documentation, you can
send a message to techpubs@ca.com.
If you would like to provide feedback about CA product documentation, complete
our short customer survey, which is also available on the CA Support website,
found at http://ca.com/docs.

Contents 5

Contents

Chapter 1: Overview 11
Intended Audiences ........................................................................... 11
Terminology .................................................................................. 12
Chapter 2: Installing the CA IT Client Manager Module 13
Prerequisites ................................................................................. 13
Installation ................................................................................... 13
CA IT Client Manager Default Module Settings .................................................. 15
Chapter 3: Using the CA IT Client Manager Module 17
ITCM Login Operator .......................................................................... 17
Operator Input Parameters ................................................................ 17
Operator Outputs ......................................................................... 18
Operator Ports ............................................................................ 18
ITCM Logout Operator ........................................................................ 18
Operator Ports ............................................................................ 19
Find Computer Operator ...................................................................... 20
Operator Ports ............................................................................ 23
Find Software Job Operator ................................................................... 24
Operator Ports ............................................................................ 26
Find Software Package Operator ............................................................... 26
Operator Ports ............................................................................ 28
Find Software Package Group Operator ........................................................ 29
Operator Ports ............................................................................ 31
Find Software Package Procedure Operator ..................................................... 31

6 CA IT Client Manager Connector Guide

Operator Ports ............................................................................ 33
Find Software Package Procedure Group Operator .............................................. 34
Operator Ports ............................................................................ 36
Get Computer Operator ....................................................................... 36
Operator Ports ............................................................................ 40
Get Deployment Job Status Operator .......................................................... 40
Operator Ports ............................................................................ 43
Get Deployment Packages ..................................................................... 44
Operator Ports ............................................................................ 52
Get Software Package Operator ............................................................... 53
Operator Ports ............................................................................ 57
Get Software Packages Operator .............................................................. 57
Operator Ports ............................................................................ 62
Get Software Package Group Operator ......................................................... 63
Operator Ports ............................................................................ 65
Get Software Package Groups Operator ........................................................ 66
Operator Ports ............................................................................ 69
Get Software Package Procedure Operator ..................................................... 70
Operator Ports ............................................................................ 74
Get Software Package Procedures Operator .................................................... 75
Operator Ports ............................................................................ 81

Contents 7

Get Software Package Procedure Group Operator ............................................... 81
Operator Ports ............................................................................ 84
Get Software Package Installations Operator ................................................... 84
Operator Ports ............................................................................ 90
Get Software Package Group Software Packages Operator ....................................... 90
Operator Ports ............................................................................ 94
Get Software Package Group Software Packages Recursive Operator ............................. 95
Operator Ports ............................................................................ 99
Evaluate Software Policy Operator ............................................................ 100
Operator Input Parameters ............................................................... 100
Operator Outputs ........................................................................ 102
Operator Ports ........................................................................... 102
Deploy Package Operator .................................................................... 102
Operator Ports ........................................................................... 105
Create Activate Software Job Operator ........................................................ 105
Operator Ports ........................................................................... 111
Suspend Deployment Job Operator ........................................................... 112
Operator Ports ........................................................................... 114
Suspend Software Jobs Operator ............................................................. 114
Operator Ports ........................................................................... 116
Create Computer Operator ................................................................... 116
Operator Ports ........................................................................... 121
Abort Deployment Job Operator .............................................................. 121


Operator Ports ........................................................................... 123
Cancel Software Jobs Operator ............................................................... 123
Operator Ports ........................................................................... 125
Create Software Package Operator ............................................................ 125
Operator Ports ........................................................................... 127
Create Software Package Group Operator ..................................................... 128
Operator Ports ........................................................................... 130
Create Software Package Procedure Operator ................................................. 130
Operator Ports ........................................................................... 136
Create Software Package Procedure Dependency Operator ..................................... 137
Operator Ports ........................................................................... 139
Create Software Package Procedure Group Operator ........................................... 139
Operator Ports ........................................................................... 141
Create Software Policy Operator .............................................................. 142
Operator Ports ........................................................................... 146
Set Software Group Operator ................................................................. 146
Operator Ports ........................................................................... 148
Set Software Job Operator ................................................................... 149
Operator Ports ........................................................................... 154
Set Software Package Operator ............................................................... 154
Operator Ports ........................................................................... 157

Contents 9

Set Software Package Procedure Operator..................................................... 157
Operator Ports ........................................................................... 165
Set Software Package Procedure Group Operator .............................................. 165
Operator Ports ........................................................................... 167
Scan Package on Target Computers Operator .................................................. 168
Operator Ports ........................................................................... 171
Get Unit Group Operator ..................................................................... 171
Operator Ports ........................................................................... 177
Get Unit ID Operator ......................................................................... 178
Operator Ports ........................................................................... 182
ITCM Base Interface Operator ................................................................ 183
Operator Ports ........................................................................... 187
Chapter 4: Troubleshooting 189
A CA IT Client Manager Module Operator Fails during Execution of a Process ..................... 189
Cannot Connect via CA IT Client Manager Operators ........................................... 193
Problem Retrieving Service URL Field (ITCM1000) ............................................. 194
Problem Retrieving Username Field (ITCM1001) ............................................... 194
Problem Retrieving Password Field (ITCM1002) ................................................ 194
Problem Retrieving Hostname Field (ITCM1003) ............................................... 195
Failed to create ITCM Session (ITCM1004) .................................................... 195
Failed to Retrieve List Handle (ITCM1005) ..................................................... 196
Failed to Identify Group Type (ITCM1006) ..................................................... 196
Problem Retrieving the List of Units (ITCM1007) ............................................... 197
Parent Software Package Group does not exist (ITCM1008) .................................... 197
Failed to Retrieve the Query ID of the Query Name (ITCM1011) ................................ 198
Failed to Retrieve the UUID of the Group Name (ITCM1011) .................................... 198
ITCM related error messages ................................................................. 199


Index 201

Chapter 1: Overview 11

Chapter 1: Overview

The CA IT Client Manager Connector (CA ITCM) integrates CA IT Client Manager
with CA IT Process Automation Manager (CA IT PAM) to automate the tasks
associated with the administration of the various devices within your IT
department, and offer a complete management of all IT client resources.
The CA IT Client Manager Module supports CA IT Client Manager r11.2 SP4 and
r12.0 SP1. CA IT PAM r2.2 and CA IT PAM r2.1SP3 CP02 support the CA IT Client
Manager Module.
This section contains the following topics:
Intended Audiences (see page 11)
Terminology (see page 12)
Intended Audiences
The CA IT Client Manager Connector Guide is intended for these primary
audiences:
Administrators who install or maintain the CA IT Client Manager Connector or
a CA IT Process Automation Manager (CA IT PAM) instance.
Administrators, Developers, and Designers of CA IT PAM Processes who want
their Processes to interact with CA IT Client Manager.
If you are a CA IT PAM Administrator or a CA IT Client Manager Administrator,
this guide assumes that you have read and you understand the content
described in both the CA IT Process Automation Manager Administration Guide
and the CA IT Client Manager Administration Guide.
If you are a CA IT PAM Process Developer, Designer, or Administrator, this
guide assumes that you have read and you understand these concepts and
associated procedures:
How to create and run CA IT PAM Processes (as described in the CA IT
Process Automation Manager User Guide).
How to create Process and Named Datasets (as described in the CA IT
Process Automation Manager User Guide).
How to use the SOAP Client Call and XML Extraction Operators of the
SOAP Module (as described in the CA IT Process Automation Manager
Reference Guide).
For more information on CA IT Client Manager (CA ITCM), refer to the product
documentation.
Terminology


Terminology
Connector
A module that integrates with software external to CA IT PAM.
Module
A set of functionally related Operators sharing a common configuration.
Operator
A software element that implements an action and is one of the building
blocks of a CA IT PAM Process.


Chapter 2: Installing the CA IT Client
Manager Module

Prerequisites (see page 13)
Installation (see page 13)
CA IT Client Manager Default Module Settings (see page 15)
Prerequisites
The ITCM Web Service is not installed with the custom installation; it must be
installed for the target CA IT Client Manager instance.
Installation
The CA IT Client Manager Connector software has a standalone installer. There
are two versions of the installer provided:
IT_PAM_connector_installer_CA_ITCM_1_0.exe for installing on a Primary
Domain Orchestrator running on Windows
IT_PAM_connector_installer_CA_ITCM_1_0.sh for installing on a Primary
Domain Orchestrator running on Linux and UNIX
Before installing the CA IT Client Manager Connector software, you must first
shut down the Primary Domain Orchestrator.
In a cluster configuration, the first Orchestrator installed is the Primary
Orchestrator, and this can be confirmed by seeing that
oasis.server.isPrimary=true is set in the OasisConfig.properties file found in
<itpam_root_directory>\server\c2o\.config, where
<itpam_root_directory> is the directory where CA IT PAM was installed.
In a non-clustered configuration, the sole Domain Orchestrator is the
Primary Domain Orchestrator.
Installation


Install the Connector
1. Log onto the machine and account used to install the CA IT PAM Primary
Domain Orchestrator.
2. Run the appropriate version of the installer for your operating system. For
Linux and UNIX systems, run the installer as follows to ensure that it is run
under the Bourne shell, and to avoid the need to use chmod to set this file as
an executable.
sh IT_PAM_connector_installer_CA_ITCM_1_0.sh
3. When the Welcome screen displays, click Next to proceed or click Cancel to
exit the installation.
The Licensing terms for this Connector display.
4. If you choose to accept the licensing terms, select "I accept the agreement",
and click Next to proceed; otherwise click Cancel to terminate the
installation.
5. Specify the directory where the CA IT PAM Primary Domain Orchestrator was
installed (if it differs from the default value) by entering the complete path to
the directory, or by clicking Browse and locating the directory.
6. Click Next.
The installer will verify that the Primary Domain Orchestrator is down. It will
deploy the components of the new module to the Primary Domain
Orchestrator (this may take a few minutes).
7. Click Finish to complete the installation.
8. Restart the Primary Domain Orchestrator.
The installation.log file is located here:
<itpam_root_directory>\server\c2o\.install4j where
<itpam_root_directory> is the folder specified in Step 5.
The newly installed module will not be available immediately on any
secondary Orchestrators, but all components will be mirrored within the time
specified by the mirroring interval for the secondary Orchestrator.
9. After all components have been mirrored, you must stop and restart each
Orchestrator and Agent to make the new module available for use.
Important! If you installed the Connector software in an existing CA IT PAM
r2.1 environment, you must use the Configuration Browser to enable the newly
installed module in each environment, on each Orchestrator, and on each Agent
where the new module and its Operators will be used.
CA IT Client Manager Default Module Settings


You can set the following default properties for the CA IT Client Manager Module
in the Configuration Browser.
Maximum result length
Specifies the maximum size (in bytes) of XML values received and stored in
CA IT PAM datasets.
Results exceeding the maximum length are truncated. The default is
1048576.
Default ITCM WebService URL
Specifies the default web service URL.
Note: This field is mandatory and should be provided at the module level or
Operator level for each Operator.
Default ITCM User
Specifies the default user name. The format is as follows:
For Windows, use winnt:\\<hostname>\<username>
For UNIX, use unixl://<hostname>/<username>
Default Users Password
Specifies the user password.


Default Host Name
Specifies the host name of CA IT Client Manager.
To specify default module properties
1. In the CA IT PAM Client, select File, Open Configuration Browser (if it is not
already open).
2. On the left side of the window, right-click the desired component, and select
Lock:
Domain (Browser palette)
Environment (Browser palette)
Orchestrator (Orchestrators palette)
Agent (Agents palette)
3. Click the Modules tab in the right pane of the window.
4. Double-click the CA IT Client Manager Module to display the Properties tab
for this module.
5. Specify the appropriate default settings for this module.
6. Click Apply.
7. Click the Save toolbar button.
8. Right-click the component you locked in Step 2 and select Unlock to unlock
the component.
The CA IT Client Manager Module Operators will use the default properties unless
you specify Operator-specific properties for each Operator.


Chapter 3: Using the CA IT Client
Manager Module

This chapter contains information about all of the Operators for the CA IT Client
Manager Module.
ITCM Login Operator
The Login Operator authenticates and obtains authorization from CA IT Client
Manager.

Operator Input Parameters
CA IT Client Manager Server Login Parameters
Service URL
Specifies the web service URL. This parameter is required if it has not been
specified at the module level.
Username
Specifies the name of a valid user account that has the permission to
authenticate with the CA IT Client Manager in the following format:
On Windows: winnt:\\<hostname>\<username>
On UNIX: unixl://< hostname >/<username>
This parameter is required if it has not been specified at the module level.
Password
Specifies the user password that corresponds to the given user name. This
parameter is required if it has not been specified at the module level.
Hostname
Specifies the host name of the CA IT Client Manager to which the Operator
should attempt to connect (required).
ITCM Logout Operator


Operator Outputs
Operator Results
LoginReturn
Indicates the unique session ID to use as an input parameter for all further
calls to the web services exposed by CA IT Client Manager.
Operator Ports
Success
Indicates that the Operator executed successfully; the following parameters
are displayed:
SOAP Response Body
Stores the complete SOAP response XML.
SOAP response Data
Stores the SOAP response in the respective dataset variables.
Failure
Indicates that the Operator execution failed; the following parameters are
displayed:
SOAP Response Body
Fault Message
Contains the fault code and fault string.
The Logout Operator closes the web service connection to the CA IT Client
Manager, closes the web service session, and performs cleanup operations.



CA IT Client Manager Server Logout
ITCM Session ID
Specifies the session ID that identifies the web service session to perform
close and clean up operations (required).
Service URL
Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
Find Computer Operator


The Find Computer Operator finds a computer unit when you provide its name.

Find Computer
Computer Name
Specifies the computer name to search for (required). The value may contain
wildcard characters such as "*".
Number Of Computers
Specifies the number of computers (if more than one match is found) to
return from the search.
Computer Properties Required
Specifies the list of parameters that can be used to search for a computer. If
the value specified in Number Of Computers is greater than 0, this field is
mandatory.
If no properties are selected, a fault/exception displays. The following
properties are required when retrieving a computer's properties:
Computer UUID
Specifies the computer UUID.
Computer Label
Specifies the computer name.
Computer DomainUUID
Specifies the UUID of the CA IT Client Manager domain for a given
computer.
Computer Primary Network Address
Specifies the IP address of the given computer in 0.0.0.0 format.
Computer HostUUID
Specifies an agent-generated UUID that identifies the computer.


Computer AssetSourceUUID
Specifies the UUID of the common CA asset to which this computer is
linked.
Computer Host Name
Specifies the computer hostname.
Computer SerialNumber
Specifies the computer serial number.
Computer DiscSerialNumber
Specifies the serial number of a computer disc.
Computer Primary MACAddress
Specifies the MAC address of the computer. The string value can have a
maximum length of 64 characters.
Computer AssetTag
Specifies a string value that identifies a computer asset.
Computer ClassID
(Optional) Specifies a numeric value that indicates class of the computer
object, for example, Operating System.
Computer UsageList
Specifies the computer usage list mask.
Computer URI
Specifies the fully qualified Uniform Resource Identifier (URI) of the
computer.
Computer SystemID
Specifies a user-defined identifier for the computer system.
Computer VendorName
Specifies the vendor name of the computer unit.
Computer DomainLabel
Specifies the CA IT Client Manager domain name to which the computer
unit belongs.
Computer CreationUser
Specifies the user account name that created the computer unit's record.
Computer CreationDate
Specifies the date and time of the computer unit's record creation.


Computer LastUpdatedUser
Specifies the user account name that last updated the computer
properties.
Computer LastUpdatedDate
Specifies the date and time when the computer properties were last
updated.
Computer VersionNumber
(Optional) Specifies the version number of the computer record. A
version number is incremented each time a record is updated.
Service URL
Username
This parameter is required if one of the following conditions hold true:
The parameter ITCM Session ID has not been specified at the Operator
level.
The parameter Default ITCM User has not been specified at the module
level.
Password
level.
The parameter Default Users Password has not been specified at the
module level.


Hostname
should attempt to connect. This parameter is required if one of the following
conditions hold true:
level.
The parameter Default Host Name has not been specified at the
module level.
CA IT Client Manager Session Parameters
ITCM Session ID
Specifies the CA IT Client Manager Session ID. The Operator uses the CA IT
Client Manager Session ID instead of creating an ID using the CA IT Client
Manager server login parameters. This parameter is required if the CA IT
Client Manager server login Username, Password, and Hostname are not
provided both at the module level and at the Operator level.
Operator Outputs
Find Computer Operator Results
FindComputerReturn
Indicates an array of computer property structures, one for each computer
matched by a search. The array is either the size of the number of computers
matched by a search, or of the number of computers requested by the
Operator, whichever is lower.
totalNoOfComputersFound
Indicates the total number of computers that matched a search. You can use
this field to indicate that more matches were found than the requested
number of computers.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Find Software Job Operator


Failure
displayed:
SOAP Response Body
Fault Message
The Find Software Job Operator finds a software job when you provide the
package name, package version, procedure name, and procedure task.

Find Software Job
Software Package Name
Specifies the software package name (required).
Software Package Version
Specifies the software package version (required).
Software Package Procedure Name
Specifies the installation procedure name for the software package
(required).
Software Package Procedure Task
Specifies one of the following types of software packages to find:
Install
Uninstall
Configure
Activate


Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Find Software Package Operator


Operator Outputs
Operator Results
softwareJobId
Returns the UUID of the software job.
softwareJobContainerId
Returns the UUID of the software job container.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Find Software Package Operator lets you find a software package given its
name and version.



Find Software Package
Defines the software package name to search for. The software package
name is case insensitive (required).
Defines the software package version to search for (required).
Service URL
Username
level.
level.
Password
level.
module level.


Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
FindSoftwarePackageReturn
Returns the UUID of a software package.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Find Software Package Group Operator


Fault Message
The Find Software Package Group Operator finds a software package group
given its name and parent software package group name.

Find Software Package Group
Parent Software Package Group Name
Defines the parent group name of a software package group to search for.
The parent software package group name is case insensitive.
If you do not specify the parent software package Group UUID, the Find
Software Package Group Operator finds the software package group under
the Software Package Group superfolder, for example: Software Library.
Software Package Group Name
Defines a software package group name to search for (required).
The software package group name is case insensitive.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Find Software Package Procedure Operator


Operator Outputs
Operator Results
FindSoftwarePackageGroupReturn
Returns the UUID of a software package group.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Find Software Package Procedure Operator finds a software package
procedure given its name, task type, and the name and version of the software
package with which it is associated.



Find Software Package Procedure
Specifies the name of the software package to which the requested
procedure should belong (required).
The software package name is case insensitive.
Specifies the software package version to which the requested procedure
belongs to (required).
Specifies the software package procedure name (required).
The software package procedure name is case insensitive.
Specifies one of the following software package procedure types to search
for:
Install
Uninstall
Configure
Activate
Service URL
Username
level.
level.


Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
FindSoftwarePackageProcedureReturn
Returns the UUID of a find software package procedure.
Operator Ports
Success
are displayed:
SOAP Response Body
Find Software Package Procedure Group Operator


SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Find Software Package Procedure Group Operator finds a software package
procedure group given its name and parent software package procedure group
name.

Find Software Package Procedure Group
Parent Software Package Procedure Group Name
Defines the name of the parent software package procedure group.
Note: The parent software package procedure name is case insensitive.
Software Package Procedure Group Name
Defines the name of the software package procedure group to search for
(required).
Note: The software package procedure group name is case insensitive.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Get Computer Operator


Operator Outputs
Operator Results
FindSoftwarePackageProcedureGroupReturn
Returns the UUID of a software package procedure group.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Get Computer Operator retrieves a computer identified by its UUID.



Get Computer
Computer ID
Specifies the UUID of the computer to retrieve (required).
Computer Properties Required
This parameter specifies the computer properties to retrieve (required).
Computer UUID
Specifies the computer UUID.
Computer Label
Specifies the computer name.
Computer DomainUUID
Specifies the UUID of CA IT Client Manager domain for a given computer.
Specifies the IP address of the given computer in 0.0.0.0 format.
Computer HostUUID
Specifies an agent-generated UUID that identifies the given computer.
Computer AssetSourceUUID
Specifies the UUID of the common CA asset to which this computer is
linked.
Computer Host Name
Specifies the computer hostname.
Computer SerialNumber
Specifies the computer serial number.
Computer DiscSerialNumber
Specifies the serial number of a computer disc.
Computer Primary MACAddress
Specifies the MAC address of the computer. The string value can have a
maximum length of 64 characters.
Computer AssetTag
Specifies a string value that identifies a computer asset.
Computer ClassID
(Optional) Specifies a numeric value that indicates class of the computer
object, for example, Operating System.
Computer UsageList


Specifies the computer usage list mask.
Computer URI
Specifies the fully qualified Uniform Resource Identifier (URI) of the
computer.
Computer SystemID
Specifies a user-defined identifier for the computer system.
Computer VendorName
Specifies the vendor name of the computer unit.
Computer DomainLabel
Specifies the CA IT Client Manager domain name to which the computer
unit belongs to.
Computer CreationUser
Specifies the user account name that created the computer unit's record.
Computer CreationDate
Specifies the date and time of the computer unit's record creation.
Computer LastUpdatedUser
Specifies the user account name that last updated the computer
properties.
Computer LastUpdatedDate
Specifies the date and time when the computer properties were last
updated.
Computer VersionNumber
Specifies the version number of the computer record. A version number
is incremented each time a record is updated.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Get Deployment Job Status Operator


Operator Outputs
Operator Results
GetComputerReturn
Returns the computer properties.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Get Deployment Job Status Operator retrieves the current deployment
status from the DMDeploy manager referenced by the job identifier. The
Operator returns the status of the scan or deployment at that time.

Get Deployment Job Status
Job ID
Defines a Job ID of the deployment or scan operation.


Computer Status Info Required
Specifies the deployment status information to retrieve for a job ID.
This field contains following flags:
Computer Name
Specifies the name of the computer.
Computer Type
Specifies the type of the computer (OS type).
Computer Description
Specifies the computer properties.
IP Address
Specifies the IP Address of the computer.
Computer Status Code
Specifies the status code returned during scan or deployment.
Computer Status Code Ex
Specifies the extended status code.
Computer Status Message
Specifies the Status message if any.
Primer Exists
Specifies the DmPrimer existence.
Credentials Necessary
Specifies the necessary credentials for the flag.
Note: Call this Operator repeatedly (generally with a time lapse) until the
bNoNoreComputers flag is true to track and retrieve the deployment status.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID


Operator Outputs
Operator Results
bNoMoreComputers
Returns a value of True or False.
True indicates that there is no status information to retrieve, or the required
task is complete.
False specifies that the scan or deploy operation is still in progress and to call
the method again to retrieve further status information.
arrayOfcomputerStatusInfo
Returns an array of ComputerStatusInfo structures that contains a snapshot
of the scan or deployment status.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
Get Deployment Packages


The Get Deployment Packages Operator retrieves deployment packages known
to the DM Deployment Manager.
Note: The Get Deployment Packages Operator is not supported for CA IT Client
Manager r11.

Get Deployment Packages Properties Required
Specifies the list of properties that can be retrieved for deployment packages
(required).
This field contains the following flags:
Product Name
Defines the name of the product.
Package Name
Defines the name of the package.
Package Version
Defines the package version.
Product Display Name
Defines the product display name.
Package Display Name
Defines the package display name.
Package Version Extended
Defines the extended form of the package version.
Display Sort Order
Display the sort order.
Platform
Defines the platform of the package.


Language
Defines the package language.
Description
Defines the package description.
Windows Command
Defines the windows installation command.
Unix Command
Specifies the Unix installation command.
Operating System Type
Specifies the operating system type in hexadecimal format.

Operating System Value
Aix 0x090000
Aix_3_2_Rs_6000 0x090101
Aix_4_1_Rs_6000 0x090201
Aix_4_2_Rs_6000 0x090202
Aix_4_3_Rs_6000 0x090203
Aix_5_0_Rs_6000 0x090301
Aix_5_1_Rs_6000 0x090302
Aix_5_2_Rs_6000 0x090303
Aix_5_3_Rs_6000 0x090304
Aix_5_4_Rs_6000 0x090305
Aix_5_5_Rs_6000 0x090306
Aix_5_6_Rs_6000 0x090307
Aix_5_7_Rs_6000 0x090308
Aix_5_8_Rs_6000 0x090309
Any 0x030000
Compaq_Tru64_5_X_Alpha 0x0d0401
Compaq_Tru64_Dec 0x0d0000
Dec_3_0_Alpha 0x0d0101


Dgux 0x0a0000
Dgux_4_1_Intel 0x0a0201
Dgux_4_1_Mc88 0x0a0101
Dgux_4_2_Intel 0x0a0301
Dos 0x010000
Drs_Nx_7_Sparc 0x160101
Drs_Nx_7mp_Sparc 0x160102
Drs_Nx_Sparc 0x160000
Dynix 0x120000
Dynix_4_2_X_Intel 0x120101
Dynix_4_4_X_Intel 0x120201
Hpux 0x070000
Hpux_10 0x070200
Hpux_10_700 0x070201
Hpux_10_800 0x070202
Hpux_11 0x070300
Hpux_11_700 0x070301
Hpux_11_800 0x070302
Hpux_11_ia64 0x070303
Hpux_11_iv2 0x070304
Hpux_12 0x070400
Hpux_12_700 0x070401
Hpux_12_800 0x070402
Hpux_12_ia64 0x070403
Hpux_12_iv2 0x070404
Hpux_9 0x070100
Hpux_9_700 0x070101
Hpux_9_800 0x070102
Irix 0x130000
Irix_6_2 0x130101


Irix_6_3 0x130301
Irix_6_4 0x130201
Irix_6_5 0x130401
Linux 0x170000
Linux_2_1_Intel 0x170101
Linux_2_2_S_390 0x170202
Linux_2_3_S_390 0x170302
Linux_2_4_S_390 0x170402
Linux_2_5_S_390 0x170502
Linux_2_6_Intel_64 0x170603
Linux_2_6_S_390 0x170602
Macintosh 0x1b0000
Macintosh_10_0_Ppc 0x1b0101
Ncr_Sst 0x150000
Ncr_Sst_S4_Intel 0x150101
Ncr_Sst_S4i_Intel 0x150201
Ncr_Sv 0x0c0000
Ncr_Sv_2x_Intel 0x0c0101
Ncr_Sv_3x_Intel 0x0c0201
Netware 0x0b0000
Netware_3_Intel 0x0b0101


Nokia_Adminsuite 0x1a0000
Nokia_Adminsuite_1_0 0x1a0001
Openvms 0x0e0000
Openvms_5_5_Vax 0x0e0101
Openvms_6_0_Alpha 0x0e0202
Os2_16 0x000000
Os2_32 0x040000
Palm_Os 0x190000
Sco 0x0f0000
Sco_3_2_V5_Intel 0x0f0101
Sco_5_2_V5_Intel 0x0f0201
Sinix 0x100000
Sinix_5_42_R4000 0x100101
Sinix_5_43_R4000 0x100201
Sinix_5_44_R4000 0x100301
Sinix_5_45_R4000 0x100401


Solaris 0x080000
Solaris_10_Intel 0x080802
Solaris_10_Sparc 0x080801
Solaris_2_3_Sparc 0x080101
Solaris_2_4_Intel 0x080202
Sunos 0x110000
Sunos_4_1_4_Sparc 0x110101
Unix 0x060000
Unixware 0x140000
Unixware2_0_Intel 0x140101
Unixware2_1_Intel 0x140201
Unixware7_X_Intel 0x140301
Win_2000 0x050100
Win_2000_Intel 0x050101
Win_Ce 0x180000
Win_Ce_2_00_Mips 0x180101
Win_Ce_2_00_Sh3 0x180102
Win_Ce_2_01_Sh3 0x180202


Win_Ce_2_11_Arm 0x180301
Win_Ce_2_11_Sh3 0x180303
Win_Ce_2_11_Sh4 0x180304
Win_Ce_3_00_Arm 0x180401
Win_Ce_3_00_Ppc2002_Arm 0x180501
Win_Ce_3_00_Sh3 0x180403
Win_Ce_3_00_Sh4 0x180404
Win_Ce_4_20_Arm 0x180601
Win_Ce_5_00_Arm 0x180701
Win_Longhorn_Intel 0x050501
Win_Longhorn_Itanium 0x050502
Win_Longhorn_x64 0x050503
Win_Nt 0x050000
Win_Nt_Alpha 0x050002
Win_Nt_Intel 0x050001
Win_Nt_Mips 0x050003
Win_Server_2003 0x050300
Win_Server_2003_Intel 0x050301
Win_Server_2003_Itanium 0x050302
Win_Server_2003_x64 0x050303
Win_Vista_Intel 0x050401
Win_Vista_Itanium 0x050402
Win_Vista_x64 0x050403
Win_Xp 0x050200
Win_Xp_Intel 0x050201
Win_Xp_Itanium 0x050202
Win_Xp_x64 0x050203
Windows_16 0x020000


Windows_32 0x020100
Windows_95 0x020101
Windows_98 0x020102
Windows_Me 0x020103
MSI Product Code
Defines the MSI product code.
PIF Product Code
Defines the PIF product code.
Parameter Info
Defines the deployment package parameters list.
Service URL
Username
level.
level.
Password
level.
module level.


Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
arrayOfDMPackageProperies
Returns the package properties.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Get Software Package Operator


Fault Message
The Get Software Package Operator retrieves a software package identified by
its UUID.

Get Software Package
Software Package ID
Defines the UUID of the software package to retrieve (required).
Software Package Properties Required
Specifies the software package properties to retrieve (required). All values
are selected by default.
This field contains the following required flags:
Software Package Id
Specifies the UUID identifying the software package.
Specifies the name of the software package.
Specifies the version of the software package.
Based On Software Package Id
Specifies a software package that can be created or imported based on
another software package, this element specifies the UUID of the other
software package.


Based On Software Package Name
Specifies a software package that can be created or imported based on
another software package, this element specifies the name of the other
software package.
Based On Software Package Version
Specifies a software package that can be created based on another
software package, this element specifies the version of the other
software package.
Supplier
Specifies the supplier of the software package.
Comment
Specifies a comment for the software package.
Source Path
Specifies the source path of the software package.
Software Package Type
Defines the type of software package.
User Selectable
Allows the user to ordered from the CA IT Client Manager Catalog.
Software Package Data Source
Specifies the source medium for the software package data source.
Software Package Filed By
Specifies the user who created the software package.
Registration Date Time
Specifies the date and time the software package was created.
Change Date Time
Specifies the date and time the software package was last changed.


Software Packaging Type
Specifies the possible software packaging types.
Packet Size
Returns the Standard Size of the package in kilobytes.
Build On Size
Returns the Extended package size in kilobytes. It includes the added
procedures.
Archive Path
Indicates if the software package has been archived and specifies the
archive path.
Archive Comment
Indicates if the software package has been archived and specifies the
archive comment.
Archived By
Indicates if the software packages have been archived and specifies who
performed the archive.
Archive Flag
Indicates whether the path that is referred to can be found at the server
or the enterprise manager.
Arch Date Time
Specifies the date and time when the software package was archived.
Software Package Mask
Specifies a sequence that specifies the software package attributes. It
contains only one flag 'checksum' which indicates whether a checksum is
performed to ensure package consistency.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Get Software Packages Operator


Operator Outputs
Operator Results
GetSoftwarePackageReturn
Returns the software package properties.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Get Software Packages Operator retrieves software packages from the
software package list.



Get Software Packages
Software Package Mask Type
Specifies the types of software packages (required). All options are selected
by default.
This contains the following options:
All
Defines all types of software.
Ordinary software
Defines ordinary software.
Detected software
Defines a detected software.
User Selectable
Allows the user to order from the CA IT Client Manager Catalog.
CA ITCM software
Defines the CA IT Client Manager software.
Number Of Software Packages
Defines the total number of software packages to retrieve from the list
(required). The value must be less than or equal to the total number
available software packages.
If the number supplied exceeds the total number of software packages, then
the Operator internally replaces the "number of software packages" with the
"total number of software packages".


Specifies the software package properties to retrieve (required). All options
are selected by default.
This field contains the following properties:
Software Package Id
Defines the UUID identifying the software package.
Defines the name of the software package.
Defines the version of the software package.
Defines a software package that can be created or imported based on
software package.
Defines a software package that can be created or imported based on
software package.
Defines a software package that can be created based on another
software package.
Supplier
Defines the supplier of the software package.
Comment
Defines a comment for the software package.
Source Path
Defines the source path of the software package.
Defines the type of software package.
User Selectable
Allows the user to ordered from the CA IT Client Manager Catalog.
Defines the source medium for the software package data source.


Defines the user who created the software package.
Defines the date and time when the software package was created.
Change Date Time
Defines the date and time when the software package was last changed.
Defines the software packaging types.
Packet Size
Build On Size
procedures.
Archive Path
Defines the path where the software package has been archived.
Archive Comment
Defines the archive comment.
Archived By
Provides the details of the person who archived the software packages.
Archive Flag
or enterprise manager.
Arch Date Time
Defines the date and time when the software package was archived.
Defines a sequence that specifies the software package attributes. It
contains only one flag 'checksum' which indicates whether a checksum is
performed to ensure package consistency.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID


Operator Outputs
Operator Results
GetSoftwarePackagesReturn
Returns an array of SoftwarePackageProperites, one for each software
package requested from the list.
If the number of software packages supplied exceeds the total number of
software packages, then the following parameters display:
Warning
Indicates that the number of Software Packages provided exceeds the
total number of available Software Packages.
TotalNoOfSoftwarePackages
Returns the total number of available software packages.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
Get Software Package Group Operator


The Get Software Package Group Operator retrieves a software package group
identified by its UUID.

Get Software Package Group
Software Package Group ID
Defines the UUID of the software package group to retrieve (required).
Software Package Group Properties Required
Specifies which software package group properties to retrieve (required). All
options are selected by default.
Software Package Group Id
Defines the UUID identifying the software package group.
Number Of Parent Software Package Groups
Defines the number of parent software package groups to which this
group is linked.
Number Of Child Software Package Groups
Defines the number of software package groups linked to this group.
Defines the number of software packages contained in the software
package group.
Name
Defines the display name of the software package group.
Comment
Defines a comment for the software package group.


Creation Date
The date and time at which the software package group was created.
Change Date
Defines the date and time at which the software package group was last
updated.
Attribute Mask
Defines a series of attributes that describe the software package group.
Software Package Group Property
Indicates the catalog status of the software package group.
Service URL
Username
level.
level.
Password
level.
module level.


Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
GetSoftwarePackageGroupReturn
Identifies the software package group properties.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Get Software Package Groups Operator


Fault Message
The Get Software Package Groups Operator retrieves the software package
groups from a software package group list.

Get Software Package Groups
Software Package Group ID
Specifies the UUID identifying the software package group whose member
groups should be listed. If not supplied the root package group is opened.
Number Of Software Package Groups
Defines the total number of software package groups to get from the list
(required). The value must be less than or equal to the total number
available. If the number of software package groups supplied exceeds the
total number of software package groups, then the Operator internally
replaces the "number of software package groups" with the "total number of
software package groups".


Software Package Group Properties Required
Specifies which software package group properties to retrieve (required). All
options are selected by default.
Software Package Group Id
Defines the UUID identifying the software package group.
Number Of Parent Software Package Groups
Defines the number of parent software package groups to which this
group is linked.
Number Of Child Software Package Groups
Defines the number of software package groups linked to this group.
Defines the number of software packages contained in the software
package group.
Name
Defines the display name of the software package group.
Comment
Defines a comment for the software package group.
Creation Date
Defines the date and time at which the software package group was
created.
Change Date
Defines the date and time at which the software package group was last
updated.
Attribute Mask
Defines a series of attributes that describe the software package group.
Software Package Group Property
Indicates the catalog status of the software package group.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID


Operator Outputs
Operator Results
GetSoftwarePackageGroupsReturn
Returns an array of SoftwarePackageGroupProperites - one for each group
requested from the list.
If the number of software package groups supplied exceeds the total number
of software package groups, then the following additional parameters or
variables display:
Warning
Indicates that the number of Software Package Groups provided exceeds the
total number of available Software Package Groups.
TotalNoOfSoftwarePackageGroups
Returns the total number of available software package groups.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
Get Software Package Procedure Operator


The Get Software Package Procedure Operator retrieves a software package
procedure identified by its UUID.

Get Software Package Procedure
Software Package Procedure ID
Defines the UUID of the software package procedure to retrieve (required).
Software Package Procedure Properties Required
Specifies which software package procedure properties to retrieve
(required). All options are selected by default.
Software Package Procedure Id
Defines the UUID identifying the software package procedure.
Defines the name of the software package procedure.
Defines the task type of the software package procedure.
Software Package Procedure Type
Defines the type of the software package procedure.
Comment
Defines a comment for the software package procedure.
User Selectable
Indicates whether the procedure is allowed to be included in the
Software Delivery Catalog.
External Procedure
Defines a flag that indicates whether the procedure is external to SD or
not.
Filed By
Defines the entity by which the software package procedure was filed.


Note: For more information on the Operating System Type, see the
Operating System Type table in Get Deployment Packages (see page 44) .
Sub Path
Defines the path of the procedure within the volume.
Proc To Run
Defines the procedure command to be run.
Parameters
Defines a string value containing the input parameters for the
procedure.
Procedure Relation
Defines the path of the procedure, relative to the path of the software
package to which the procedure belongs.
Activated By
Defines the entity by which the software package procedure was
activated.
Activated Date Time
Defines the time or date that the procedure was activated.
Software Package Id
Defines the UUID identifying the software package to which the
procedure is associated.
Defines the name of the software package to which the procedure is
associated.


Defines the version identifier of the software package to which the
Defines the type of the software package to which the procedure is
associated.
Software Package Volume Id
Defines the UUID identifying the volume of the software package to
which the procedure is associated.
Software Package Volume Name
Defines the name of the volume of the software package to which the
Operation Mask
Defines the operation property for the procedure operation.
Boot Before Mask
Indicates the reboot options requested for the software package
procedure before the procedure is executed.
Boot After Mask
procedure after the procedure is executed.
Dependency Query Id
Defines a prerequisite defined for the procedure, this is the UUID of the
query that checks if the condition is fulfilled.


Management Type Mask
Indicates whether the requested software package for the procedure is
allowed to run on Software Managed software targets.
Note: If you do not select any property, the Operator returns the following
default properties:
externalProcedure
filedBy
userSelectable
softwarePackageType
operatingSystemType
activatedBy
softwarePackageProcedureTask
softwarePackageProcedureType
procedureRelation
Service URL
Username
level.
level.
Password
level.
module level.


Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
getSoftwarePackageProcedureReturn
Returns the software package procedure properties to retrieve.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Get Software Package Procedures Operator


Fault Message
The Get Software Package Procedures Operator retrieves the procedures from a
software package procedure list.

Get Software Package Procedures
Software Package ID
Specifies the UUID of the software package (required).
Specifies the Software Package Procedure types (required). All options are
selected by default.
This field contains the following options:
All
Defines all types of procedures.
User Selectable
Defines a procedure that can be used from the CA IT Client Manager
catalog.
Embedded
Defines a procedure included in the original package (not added).


Added
Defines a procedure added to a sealed software.
Converted
Defines an added procedure with already registered or external files.
Detected
Defines a virtual procedure for detecting a software.
Install
Defines a procedure used to install a software.
Uninstall
Defines the procedure used to uninstall a software.
Configure
Defines the procedure used to configure a software.
Activate
Defines the procedures used to activate a software.
Software Package Procedure Properties Required
Specifies the list of Software Package Procedure Properties to retrieve
(required). All options are selected by default.
Defines the UUID identifying the software package procedure.
Defines the name of the software package procedure.
Defines the task type of the software package procedure.
Defines the type of the software package procedure.
Comment
User Selectable
Indicates whether the procedure is allowed to be included in the
Software Delivery Catalog
External Procedure
Defines a flag that indicates whether the procedure is external to SD.


Filed By
Defines the entity by which the software package procedure was filed.
Operating System Type table in Get Deployment Packages (see page 44).
Sub Path
Defines the path of the procedure within the volume.
Proc To Run
Defines the procedure command to be run.
Parameters
Defines a string value containing the input parameters for the
procedure.
Procedure Relation
Defines the path of the procedure, relative to the path of the software
package to which the procedure belongs.
Activated By
Defines the entity by which the software package procedure was
activated.
Activated Date Time
Defines the time or date that the procedure was activated.
Software Package Id
Defines the UUID identifying the software package to which the


Defines the name of the software package to which the procedure is
associated.
Defines the version identifier of the software package to which the
Defines the type of the software package to which the procedure is
associated.
Software Package Volume Id
Defines the UUID identifying the volume of the software package to
which the procedure is associated.
Defines the name of the volume of the software package to which the
Operation Mask
Defines the operation property for the procedure operation.
Boot Before Mask
procedure before the procedure is executed.
Boot After Mask
procedure after the procedure is executed.
Dependency Query Id
Defines a prerequisite defined for the procedure, this is the UUID of the
query that checks if the condition is fulfilled.


Indicates whether the requested software package for the procedure is
default properties:
externalProcedure
filedBy
userSelectable
softwarePackageType
operatingSystemType
activatedBy
softwarePackageProcedureTask
softwarePackageProcedureType
procedureRelation
Number Of Software Package Procedures
Defines the total number of procedures to get from the list (required). The
field value must be less than or equal to the total number available. If "No Of
Software Package Procedures" supplied exceeds the total number of
software package procedures, then the Operator internally replaces the
"number of software package procedures" with the "total number of software
package procedures".
Service URL
Username
level.
level.


Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
getSoftwarePackageProcedures
Returns an array of SoftwarePackageProcedureProperites - one for each
group requested from the list.
If the number of software package procedures supplied exceeds the total
number of software package procedures, then the following parameters or
variables display:
Warning
Indicates that the number of Software Package Procedures provided exceeds
the total number of available Software Package Procedures.
TotalNoOfSoftwarePackageProcedures
Returns the total number of available software package procedures.
Get Software Package Procedure Group Operator


Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Get Software Package Procedure Group Operator retrieves a software
package procedure group identified by its UUID.

Get Software Package Procedure Group
Software Package Procedure Group ID
Defines the UUID of the software package procedure group to retrieve
(required).


Software Package Procedure Group Properties Required
Specifies the software package procedure group properties to retrieve
(required).
This field contains the following attributes:
Software Package Procedure Group Id
Specifies the UUID identifying the software package procedure group.
Number Of Parent Software Package Procedure Groups
Specifies the number of parent software package procedure groups to
which this group is linked.
Number Of Software Package Procedures
Specifies the number of software package procedures linked to the
procedure group.
Name
Specifies the display name of the software package procedure group.
Comment
Specifies a comment for the software package procedure group.
Creation Date
Specifies the date and time at which the software package procedure
group was created.
Change Date
Specifies the date and time at which the software package procedure
group was last updated.
Attribute Mask
Specifies a series of attributes that describe the software package
procedure group.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Get Software Package Installations Operator


Operator Outputs
Operator Results
GetSoftwarePackageProcedureGroupReturn
Returns the software package procedure group properties.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Get Software Package Installations Operator retrieves the installations from
a software package installation list.



Get Software Package Installations
Software Package ID
Specifies the UUID identifying the software package whose installations
should be listed (required).
Unit Group ID
Specifies the UUID identifying a group of units by which to filter the list of
installations. You can use this parameter to return a list of software package
installations to only those units within a specific group.
Unit Software Job Properties Required
Specifies the properties that are required while getting an individual
installation from the list (required). All the properties are selected by default.
This field contains the following required attributes:
Unit Software Job Id
Specifies the UUID identifying the software job for a specific unit.
Unit Id
Specifies the UUID identifying the unit to which the software job has
been applied.
Unit Name
Specifies the name of the unit to which the software job has been
applied.
Unit Type
Specifies the type of the unit to which the software job has been applied.
Unit Net Address
Specifies the network address of the unit to which the software job has
been applied (where appropriate for the unit type).
Software Job Id
Specifies the UUID of the software job that has been applied to the given
unit.
Software Job Name
Specifies the name of the software job that has been applied to the given
unit.
Software Job State
Specifies the current state of the specified software job on the given unit.
Software Job Order Number
Specifies the order number for the unit's given software job.


Software Package Id
Specifies the UUID identifying the software package associated with the
unit's given software job.
Specifies the name of the software package associated with the unit's
given software job.
Specifies the version of the software package associated with the unit's
given software job.
Specifies the class of the software package associated with the unit's
given software job.
Specifies the UUID identifying the software package procedure
associated with the unit's given software job.
Specifies the name of the software package procedure associated with
the unit's given software job.
Activation Date Time
Specifies the date and time at which the unit's given software job was
activated.
Creation Date Time
Specifies the date and time at which the unit's given software job was
created.
Completion Date Time
Specifies the date and time at which the unit's given software job
completed.
Software Job Type
Specifies the type of the unit's given software job.
Ordered By
Specifies the user account that started or ordered the unit's software
job.
Unit Software Job State
Specifies the current state of the unit's given software job.
Unit Software Job Renew State
Indicates the current state of the job that has been renewed.


Unit Software Job Permission Mask
Specifies the permissions applicable to the unit's software job.
Error Message
Specifies the text of an error message that has been generated by the
software job.
Error Code
Specifies the code of the error (if any) generated by the software job.
User Defined Name
Specifies a user-defined identifier for this unit software job.
Comment
Specifies a comment for the unit's software job.
Unit Installation Software Job Id
Specifies the UUID of the installation job associated with this unit
software job.
Unit Installation Software Package Procedure Id
Specifies the UUID of the installation procedure associated with this unit
software job.
Unit Installation Software Package Procedure Name
Specifies the name of the installation procedure associated with this unit
software job.
Software Job Task Mask
Specifies the type of the task the unit software job is concerned with, for
example, install or configure.
Percent Sent
Specifies the percentage of the software job that has been sent to its
target.
Specifies the type of the software package, for example, generic, PIF, or
MS.
User Params
Specifies a string value containing the user-defined parameters for the
given unit's software job.
Unit Host UUID
Specifies an agent-generated UUID that identifies the given unit.
default properties:


softwarepackingtype
softwarepackagetype
unittype
unitsoftwarejobstate
softwarejobtype
errorcode
softwarejobordernumber
percentsent
unitsoftwarejobrenewstate
softwarejobstate
Number Of Software Package Installations
Specifies the total number of installations to retrieve from the list (required).
The value must be less than or equal to the total number available. If
"Number Of Software Package Installations" supplied exceeds the total
number of software package installations, then the Operator internally
replaces the "Number of software package installations" with the "total
number of software package installations.
Service URL
Username
level.
level.


Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
GetSoftwarePackageInstallationsReturn
Returns an array of UnitSoftwareJobProperties - one for each software
package installation requested from the list.
If the number of software package installations supplied exceeds the total
number of software package installations, then the following parameter or
variable appears:
Warning
Indicates that the number of Software Package Installations provided
exceeds the total number of available Software Package Installations.
TotalNoOfSoftwarePackageInstallations
Returns the total number of available software package installations.
Get Software Package Group Software Packages Operator


Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Get Software Package Group Software Packages Operator retrieves the
software packages from software package group packages.

Get Software Package Group Software Packages
Specifies a software package group to search for (required).
Number of Software Packages
Specifies the total number of packages to get from the software package list
(required). If the value is greater than the total number of packages
available, then the Operator throws a warning message and retrieves the
number of packages available.


Specifies the properties that are required to retrieve a software package
(required). All the fields are selected by default.
Software Package Id
A software package may be created or imported based on another
software package, this element specifies the UUID of the other software
package.
A software package may be created or imported based on another
software package, this element specifies the name of the other software
package.
A software package may be created based on another software package,
this element specifies the version of the other software package.
Supplier
Comment
Source Path
Specifies a source path for the software package.
Specifies the type of software package.
User Selectable
Allows the user to order from the CA IT Client Manager Catalog.


Specifies the date and time when the software package was created.
Change Date Time
Specifies the date and time when the software package was last
changed.
Packet Size
Build On Size
procedures.
Archive Path
If the software package has been archived this specifies the archive
path.
Archive Comment
If the software package has been archived this specifies the archive
comment.
Archived By
If the software package has been archived this specifies who performed
the archive.
Archive Flag
Arch Date Time
If the software package has been archived this specifies the date and
time the archive took place.
This sequence specifies the software package attributes. It contains only
one flag 'checksum' which indicates whether a checksum is performed to
ensure package consistency.
default properties:
packageType
userSelectable
buildOnSize


softwarePackageType
softwarePackageDataSource
archiveFlag
packetSize
softwarePackageFiledBy
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.


ITCM Session ID
Operator Outputs
Operator Results
GetSoftwarePackageGroupSoftwarePackagesReturn
Specifies an array of SoftwarePackageProperties - one for each package
If the number of software package groups supplied exceeds the total number
of software packages, then the Operator displays the following variables or
parameters:
Warning
Indicates that the number of Software Packages provided exceeds the total
number of available Software Packages.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Get Software Package Group Software Packages Recursive Operator


Fault Message
Get Software Package Group Software Packages Recursive
Operator
The Get Software Package Group Software Packages Recursive Operator
displays a list of the software packages from a given software package group or
sub groups contained within that group. The Operator expands all member
groups in the hierarchy recursively and then retrieves the software packages
from a software package group package list.

Get Software Package Group Software Packages Recursive
Defines the name of the software package group to search for (required).
Specifies the required properties to retrieve a package from the list
(required). If "No Of Software Packages" supplied exceeds the total number
of software packages, then the Operator internally replaces the "number of
software packages" with the "total number of software packages.
Software Package Id
Specifies a software package that may be created or imported based on
software package.


Specifies a software package that may be created or imported based on
software package.
Specifies a software package that may be created based on another
software package.
Supplier
Comment
Source Path
Specifies a source path of the software package.
Specifies the type of software package.
User Selectable
Allows the user to order from CA IT Client Manager Catalog.
Specifies the date and time when the software package was created.
Change Date Time
Specifies the date and time when the software package was last
changed.


Packet Size
Build On Size
procedures.
Archive Path
Specifies the path where the software package has been archived.
Archive Comment
Defines the archive comment.
Archived By
Provides the details of the person who archived the software packages.
Archive Flag
Arch Date Time
Specifies the date and time when the software package was archived.
Flags
Specifies the software package attributes. It contains only one flag
'checksum' which indicates whether a checksum is performed to ensure
package consistency.
default properties:
packageType
userSelectable
buildOnSize
softwarePackageType
softwarePackageDataSource
archiveFlag
packetSize
softwarePackageFiledBy


Specifies the total number of packages to get from the list (required). If this
value is greater than the total number of packages available, then the
Operator displays a warning message and retrieves the number of software
packages available.
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.


ITCM Session ID
Operator Outputs
Operator Results
GetSoftwarePackageGroupSoftwarePackagesRecursiveReturn
Returns an array of SoftwarePackageProperties - one for each package
If the number of software packages supplied exceeds the total number of
software packages, then the Operator displays the following
parameters/variables:
Warning
Indicates that the number of Software Packages provided exceeds the total
number of available Software Packages.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Evaluate Software Policy Operator


Fault Message
The Evaluate Software Policy Operator evaluates a software policy identified by
its Name.

Evaluate Software Policy
Software Policy Name
Specifies the software policy name to search for (required).
Software Policy Evaluation Type
Specifies a type of evaluation to use for the software policy as follows:
ET-POPULATEEXCEPTIONS
Defines a conformance check for all members in the group. If any
nonconforming members are found, they are added to the Violators
folder.
ET-SETUPJOBS
Defines a conformance check for all members in the group and to set up,
but not activate, jobs for members not conforming to the policy
conditions. The job container containing the jobs is not sealed.
ET-SETUPANDEXECUTEJOBS
Defines a conformance check for all members in the group, and to set
up, and activate, jobs for members not conforming to the policy
conditions. The job container containing the jobs is sealed and the jobs
executes at the specified time.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Deploy Package Operator


Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Deploy Package Operator deploys a package on the target computers.

Deploy Package
Job Id
Defines Job ID returned from a scan method. The job ID identifies the list of
computers on which the deployment takes place. Use the Operator "Scan
package on target computers" to get the job ID.


Deployment Information
The Deployment Information contains information about the target machines
credentials and scalability server. If you do not have access to all the machines
targeted for deployment, then use "Target Machine Credentials" field to provide
machine-specific credentials. If deployment is required to take place from a
scalability server, then provide the scalability server details.
Target User Name
Specifies the user name for deployment.
Target Password
Scalability Server
Specifies the server name to facilitate the deployment process.
Scalability Server User Name
Specifies the scalability server user name.
Scalability Server Password
Specifies the user password for the scalability server.
Target Machine Credentials
Specifies the machine name, the username, and the password for each of
the target machines.
Deployment Package Information
Product Name
Specifies the product name pertaining to the package.
Package Name
Specifies the package name.
Package Version
Specifies the package version.
Platform
Specifies the package platform.
Language
Specifies the language of the selected package.
Parameter Values
Specifies an array of ParameterValue structures that contain parameter
values required for the package installation.


Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Create Activate Software Job Operator


Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Create Activate Software Job Operator creates a software Activate job.

Create Activate Software Job
Specifies the UUID of the software package procedure (required). The "Find
software package procedure" Operator returns this ID.


Software Package Install Procedure Id
Specifies the UUID of the install software package procedure (required). The
"Find software package procedure" Operator returns this ID.
Software Job Container Name
Specifies the name of the software job container to search for (required).
Software Package Installation Ids
Specifies an array of UUIDs for the installation jobs on which this activation
job must be based. The Operator "Get software package installations"
returns this ID.
Note: If you do not provide a value in this field, then you must supply the
unitId or UnitGroupid.
Unit Group Ids
Specifies an array of UUIDs for the unit groups to which the job must be
applied to. The "Get Unit Group" Operator returns this ID.
Unit Ids
Specifies an array of UUIDs for the units. The "Get UnitID" Operator returns
this ID.
Software Job Order Properties
Execution Date
Specifies the software job execution dates. The default is the current date
and time of the manager computer.
Timeout Hours
Specifies the timeout hours. The default is 168 hours.


Startup When
Specifies the software job startup time. The default is EXACT_LOCAL_TIME.
This field contains the following options:
BOOT-LOCAL-TIME
The server will not trigger the agent to start the job. The job will be
started the first time the agent starts after the start time has occurred.
Normally, when the agent-machine is re-booted, the start time is based
on that of the domain manager.
EXACT-LOCAL-TIME
The server will trigger the agent to start the job as soon as the start time
has occurred. The start time is based on that of the domain manager.
BOOT-GLOBAL-TIME
The server will not trigger the agent to start the job. The job will be
started the first time the agent starts after the start time has occurred.
Normally, when the agent-machine is re-booted, the start time is based
on that of the enterprise manager.
EXACT-GLOBAL-TIME
The server will trigger the agent to start the job as soon as the start time
has occurred. The start time is based on that of the enterprise manager.
Job Name
Defines a software job name (required).
Boot Before Mask
Specifies the reboot options for a software job. The default is noReboot.
Contains the following options:
noReboot
Do not reboot the computer before starting the job.
reboot
Reboot the computer before starting the job.
logoff
If logoff is set to true, the user agent logs off the user and the machine
agent logs off all users before the job starts.
rebootAfterLast
Not applicable.
logoffAfterLast
Not applicable.


Boot After Mask
Specifies the reboot option for a software job. The default is noReboot.
noReboot
Do not reboot the computer after the job has ended.
reboot
Reboot the computer after the job has ended.
logoff
If logoff is set to true, the user agent logs off the user, and the machine
rebootAfterLast
Reboot the computer when last job in the container has ended.
logoffAfterLast
If logoffAfterLast is set to true, the user agent logs off the user and the
machine agent logs off all users when the last job in the container has
ended.


Operation Mask
Specifies a software job operation mask. The default is calendarControl.
Contains following multiple options:
offline
Execute procedure offline from the Scalability Server.
prompt
Display a message on the target computer before the job starts.
calendarControl
Control the execution by the job execution calendar defined for this
target agent.
shield
Prevent user from being logged-on while the job executes.
noPromptCancel
Allows user to cancel a prompt user job.
rerun
Run the activate/configure job every time the software policy is
Evaluated.
execPromptTimeout
Job will execute if prompt timeout expires (not set - job is postponed).
resolveQueryGroups
Resolve the target groups before the job is set up.
autoDeliverItem
Store the package in the Scalability Server Library.
defaultItemProc
This is the default procedure for this package with the task defined for
this procedure.
renewFailedOnly
Only failed jobs can be renewed.
runAtShutdown
To Run while the system is allowed to shut down.
User Parameters
Specifies the user parameters.
Prompt Timeout Hours
Specifies the timeout hours. The default is 24 hours.


Delivery Calendar
Specifies the delivery calendar.
Delivery Date
Specifies the delivery date. The default is the current date and time of the
manager computer.
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.


ITCM Session ID
Operator Outputs
Operator Results
CreateActivateSoftwareJobReturn
Returns the UUID of a new job.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
Suspend Deployment Job Operator


The Suspend Deployment Job Operator suspends a running deployment job
referenced by the deployment job identifier. The system suspends the
installation at a safe point in the deployment for all the specified targets. For
targets where package transfer has started, the job suspends at the current
point, and where the package installer has started, the installation is completed.

Suspend Deployment Job
Job Id
Specifies the job ID returned from the scan method (required). The ID
identifies the list of computers from the scan on which the deployment has to
take place. Use the Operator "Scan Package On Target Computers" to get
the ID.
Notes:
Operator-specific properties will override the module level properties.
Success of an Operator suggests the Operator completed its operation;
failure suggests that the Operator failed.
Suspending a suspended job does not return an error.
Suspend Operation on an aborted or discarded job will return an error.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Suspend Software Jobs Operator


Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Suspend Software Jobs Operator suspends the delivery of the files for one or
more software jobs that are in progress to the scalability server.

Suspend Software Jobs
Software Jobs
Defines an array of software job ID (required). Use "Find Software Job" to
retrieve the ID.


Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Create Computer Operator


Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Create Computer Operator creates a computer.



Create Computer
Computer Label
Specifies the computer label.
Computer Host Name
Specifies the computer host name. The default is Computer Label.
Specifies the primary network address of the computer (required).
Computer Type
Specifies the computer type. The computer types are as follows:
MACHINE (the default)
SCALABILITY-SERVER
DOCKING-DEVICE
Specifies the operating system type in hexadecimal format (required).
Scalability Server Name
Specifies the scalability server name. If you do not provide the value,
internally the system fetches and sets the manager name.


Create Agent Components
Specifies the following agent components (required). At least one agent
component must be available.
AM agent
The AM agent needs to be created when set to true.
AM software usage agent
The AM software usage agent needs to be created when set to true.
AM performance agent
The AM performance agent needs to be created when set to true.
SD agent
The SD agent needs to be created when set to true.
DTS agent
The DTS agent needs to be created when set to true.
RC agent
The RC agent needs to be created when set to true.
User
Specifies the user name. The default value is blank.
Phone
Defines the user phone.
Location
Specifies the user location. The default value is blank.
Comment
Specifies the user comment.
Computer Primary MAC Address
Specifies the computer MAC Address.
OSIM Image
Specifies the OSIM image.
OSIM Boot Server Name
Specifies the OSIM boot server name. The default is the scalability server
name taken as the OSIM boot server name.


SD Agent Properties
The Operator defines the properties that are set for SDAgent. The properties are
required only to create the SD agent.
Job Calendar
Specifies the job calendar name.
Software Managed System.
Specifies the software managed system. By default the checkbox is clear.
RAC Policy
Specifies the type of Reinstall After Crash (RAC) policy as follows:
RAC_COMMON (the default)
The common RAC policy is used for this computer.
RAC_AUTOMATIC
The RAC job container is created and activated automatically. Policy is
used for this computer.
RAC_DEFERRED
A RAC job container is created. You can review and modify it manually.
RAC_DISABLED
The RAC policy is disabled for this computer.
Download Method
Specifies the download method for software delivery as follows:
INTERNAL_NOS (the default)
Download method for software delivery is internal NOS.
INTERNAL_NOSLESS
Download method for software delivery is Internal NOSLESS.
DTS_NOSLESS
Download method for software delivery is DTS.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Abort Deployment Job Operator


Operator Outputs
Operator Results
uuidOfCreatedComputer
Returns the UUID of the new computer.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Abort Deployment Job Operator halts a running deployment job referenced
by the deployment job identifier.

The system aborts the installation at a safe point for all the specified targets.
For targets where deployment has not yet started, the deployment stops.
For targets where package transfer has started, the deployment stops and
the temporary files are deleted.
For targets where the package installer has started the installation, the jobs
are completed.


Abort Deployment Job
Job Id
Specifies the job ID (required). The job ID defines the list of computers from
the scan, on which the deployment has to take place. Use the "Scan Package
On Target Computers" to get the ID.
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
Cancel Software Jobs Operator


ITCM Session ID
Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Cancel Software Job Operator cancels software jobs.



Cancel Software Jobs
Software Jobs
To cancel a Particular Job the Corresponding SoftwareJobids needs to be
passed in the ArrayOfString (required). At least one softwarejobIds should
be available. Use the "Find Software Job" to retrieve the ID.
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
Create Software Package Operator


ITCM Session ID
Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Create Software Package Operator creates a software package.



Create Software Package
Specifies the software package name (required).
Specifies the software package version (required).
Supplier
Specifies the software package supplier.
Comment
Specifies the software comment.
Specifies the UUID of other software package. (A software package may be
created or imported based on another software package.)
Checksum
Ensures that a checksum is performed to maintain package consistency. By
default the checkbox is selected.
Service URL
Username
level.
level.


Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
CreateSoftwarePackageReturn
Returns the UUID of the new package.
Operator Ports
Success
are displayed:
SOAP Response Body
Create Software Package Group Operator


SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Create Software Package Group Operator creates a software package group.

Create Software Package Group
Specifies the name of the parent software package group to search for. If not
supplied, the root folder '__SD_Software Library' is used as the parent.
Specifies the name of the software package group (required).
Comment
Specifies the comment for the software package group.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Create Software Package Procedure Operator


Operator Outputs
Operator Results
CreateSoftwarePackageGroupReturn
Returns the UUID of the new group.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Create Software Package Procedure Operator creates a new software
package procedure.



Create Software Package Procedure
Software Package Id
Specifies the software package ID (required). Use the
"FindSoftwarePackage" to retrieve the ID.
Specifies the software package procedure name (required).
Specifies an enumerated list of possible software procedure task types. The
types are as follows:
INSTALL (the default)
UNINSTALL
CONFIGURE
ACTIVATE
Specifies an enumerated list of possible external file types of the software
package procedures. The types are as follows:
SIP
CMDFILE
EXEFILE (the default)
SWDET
MSI
SXP
PKG
PIF
IPS
PALM
WINCE


Comment
User Selectable
Ensures that the procedure is allowed in the Software Delivery Catalog. By
default this checkbox is clear.
External Procedure
Specifies whether the procedure is external to SD or not. By default this
checkbox is unselected.
Specifies the type of the operating system.
Default: SDAPI_OS_ANY
Sub Path
Specifies the path of the procedure within the volume.


Proc To Run
Specifies the procedure command to run (required).
Parameters
Specifies the string value that contains the input parameters for the
procedure.
Specifies the Software package volume name (required).
Software Package Procedure Operation Mask
Specifies a series of flags for a software package procedure.
Contains the following multiple options:
offline
Execute procedure offline from the Scalability Server
prompt
Display a message on the target computer before the job starts
calendarControl
target agent.
shield
lock
This option is obsolete.
noPromptCancel
Allows user to cancel a prompt user job
background
rerun
Evaluated.
permActArea
execPromptTimeout
Job will execute if prompt timeout expires (not set - job is postponed)
resolveQueryGroups
Resolve the target groups before the job is set up


autoDeliverItem
Store the package in the Scalability Server Library
defaultItemProc
this procedure.
renewFailedOnly
Boot Before Mask
Specifies a series of flags that indicate the reboot options for a software
package procedure as follows:
noReboot (the default)
reboot
Re boot the computer before starting the job.
logoff
If logoff is set to True, then the user agent logs off the user and the
machine agent logs off all users before the job starts.
rebootAfterLast
Reboot the computer after the last job in the container is complete.
logoffAfterLast
machine agent logs off all users when the last job in the container is
complete.
Boot After Mask
Specifies a series of flags that indicate the reboot options for a software
package procedure as follows:
noReboot (the default)
reboot
logoff
If logoff is set to True, then the user agent logs off the user and the
machine agent logs off all users before the job starts.


rebootAfterLast
Reboot the computer after the last job in the container is complete.
logoffAfterLast
machine agent logs off all users when the last job in the container is
complete.
Dependency Query Name
Specifies the name of the query that checks if there is a prerequisite defined
for the procedure.
Specifies whether the requested software package for the procedure is
allowed to run on Software Managed software targets. The default value is
SD. The options are as follows:
sd (the default)
Execute by the ordinary sd agent.
sm
Execute by the agent that handles packages created by CA Software
Management Packager.
Service URL
Username
level.
level.


Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
CreateSoftwarePackageProcedureReturn
Returns the UUID of a new procedure.
Operator Ports
Success
are displayed:
SOAP Response Body
Create Software Package Procedure Dependency Operator


SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Create Software Package Procedure Dependency Operator creates a
software package procedure dependency.

Create Software Package Procedure Dependency
Specifies the UUID of the software package procedure with which the
dependency is associated (required). Use the "Find Software Package
Procedure" Operator to retrieve the ID.
Dependant Software Package Procedure Id
Specifies the UUID of the software package procedure on which the
procedure is dependant (required). Use the "Find Software Package
Procedure" Operator to retrieve the ID.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Create Software Package Procedure Group Operator


Operator Outputs
Operator Results
CreateSoftwarePackageProcedureDependencyReturn
Returns the UUID of the new dependency.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Create Software Package Procedure Group Operator creates a software
package procedure group.



The Create Software Package Procedure Group Operator specifies which
procedure group properties are initialized when a software package procedure
group is created.
Specifies parent software package group name. If this parameter is not
supplied, the root folder '__SD_Software Library' is used as the parent.
Software Package Procedure Group Name
Specifies the Software package procedure group name (required).
Comment
Specifies the comments.
Service URL
Username
level.
level.
Password
level.
module level.


Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
CreateSoftwarePackageProcedureGroupReturn
Returns the UUID of the new group.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Create Software Policy Operator


Fault Message
The Create Software Policy Operator creates a new software policy.

Create Software Policy
Unit Group Id
Specifies the UUID of the unit group whose associated query you want to
revaluate (required). Use the Operator "GetUnitGroup" to get the ID.
Software Policy Name
Specifies the software policy name (required).
Comment
Software Policy Evaluation Type
Specifies the evaluation type used for the software policy. The default value
is ET-SETUPANDEXECUTEJOBS.
The policy types are as follows:
ET-POPULATEEXCEPTIONS
Defines a conformance check for all members in the group. If any
nonconforming members are found, they are added to the Violators
folder.
ET-SETUPJOBS
Defines a conformance check for all members in the group and to set up
(not to activate) jobs for members not conforming to the policy
conditions. The job container containing the jobs is not sealed.
ET-SETUPANDEXECUTEJOBS
Defines a conformance check for all members in the group, to set up,
and activate, jobs for members not conforming to the policy conditions.
The job container containing the jobs is sealed and the jobs are executed
at the specified time.


Software Job Container Property Mask
Specifies a number of properties related to the creation and setup of a
software job container. Also specifies the rules that you must apply to the
jobs within the container. The default values are linkageBatch and cascade.
The options are as follows:
linkageNone
The Jobs in the container runs independently from one another.
linkageSequence
The jobs in the container are only activated, when the previous job in the
container is successfully completed for all of its targets.
linkageBatch (the default)
For each target, all jobs in the container runs as a single task. If a job
fails for any target, the remaining jobs in the container for that target are
aborted.
rollback
This parameter should be only used when linkageBatch is set to true. If
the option is true it is treated as Enable Transaction. In case of a failure
during evaluation, the already evaluated jobs for the target within the
batch will fail. In case of a failure during execution, jobs for the target
within the batch will be rolled back(SXP, PIF and PKG only).
cascade (the default)
This value can only be set to true if linkageNone is set to false. If you
select this field, then any procedure that is to execute as part of the job
container, is for its own execution dependent on the successful execution
of all procedures in its Procedure Dependencies folder.
buildOnly
This is used when the Job Container is set for Seal, and it is used to
evaluate jobs only. Job Container is not activated in this case.
renewed
This flag is not applicable to Software policies. It is used when the Job
Container is renewed and it has failed.


Evaluation Type Mask
Specifies the properties that govern the evaluation of a software policy as
follows:
once (the default)
Do the evaluation once. Cannot be combined with periodic.
periodic
Do the evaluation periodically. Cannot be combined with once.
enterpriseTime
The evaluation start time is the Enterprise Manager time.
adhocCreate
Do evaluation when new or reinstalled computers register.
adhocUpdate
Do evaluation when computers report inventory.
Evaluation Calendar
Specifies the name of the calendar that controls the time when the
evaluation can take place. Specify evaluationPeriod to activate the
evaluationCalendar.
Evaluation Period
Specifies the evaluation period. The default is 24.
Next Evaluation Date
Specifies the next evaluation date. The default is the current date and time
of the manager computer.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Set Software Group Operator


Operator Outputs
Operator Results
CreateSoftwarePolicyReturn
Defines the UUID of the new policy.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Set Software Group Operator provides the softwareGroupId (package
Group/ ProcedureGroup) to set the properties of the software group.



Set Software Group
Software Group Id
Specifies the UUID of the software group (required). Use the "Find software
package group" or "Find software package procedure group" Operator to get
the ID.
Software Group Name Supplied
Ensures that the software group name is provided.
Software Group Name
Specifies a new name for the software group.
Comment Supplied
Ensures that the comment field is enabled.
Comment
Specifies a new comment string for the software group.
Service URL
Username
level.
level.


Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
Set Software Job Operator


SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Set Software Job Operator updates the properties of a software job.

Set Software Job
Software Job Id
Specifies the UUID of the software job (required).
Software Job Name Supplied
Ensures that the Software Job Name field is enabled.
Software Job Name
Specifies the software name.
Execution Date Supplied
Ensures that the Execution Date field is enabled.
Execution Date
Specifies the software job execution date.
Timeout Hours supplied
Specifies the timeout hours.
Timeout Hours
Defines the time in hours after which the job (if the job is unable to
complete) ceases the attempts to complete.


Start When Supplied
Specifies when to start a software job.
Start When
Specifies a BOOT-LOCAL-TIME
The server do not trigger the agent to start the job. The job will be
started the first-time when the agent starts after the start time (when
the agent-machine is reboots). The start time is based on the domain
manager time.
EXACT-LOCAL-TIME
The server triggers the agent to start the job as soon as the start time
has occurred. The start time is based on the domain manager time.
BOOT-GLOBAL-TIME
The server does not trigger the agent to start the job. The job starts the
first-time when the agent starts after the start time (when the
agent-machine is reboots). The start time is based on the enterprise
manager start time.
EXACT-GLOBAL-TIME
The server triggers the agent to start the job at the start time. The start
time is based on the enterprise manager start time.startup time for a
software job.
Boot Before Mask Supplied
Ensures that the Boot Before Mask field is enabled.
Boot Before Mask
Specifies the reboot options for a software job.
noReboot
reboot
logoff
The user agent logs off the user and the machine agent logs off all users
before the job starts.
rebootAfterLast
logoffAfterLast
Boot After Mask Supplied
Ensures that the Boot After Mask field is enabled.


Boot After Mask
Specifies the reboot options for a software job
noReboot
Do not reboot the computer after the job ends.
reboot
Reboot the computer after the job ends.
logoff
The user agent logs off the user, and the machine agent logs off all users
before the job starts.
rebootAfterLast
Reboot the computer when last job in the container ends.
logoffAfterLast
The user agent logs off the user and the machine agent logs off all users
when the last job in the container ends.
Operation Mask Supplied
Ensures that the Operation Mask field is enabled.
Operation Mask
Specifies the options for the operation of a software job. The options are as
follows:
offline
Executes procedure offline from the Scalability Server.
prompt
Displays a message on the target computer before the job starts.
calendarControl
Controls the execution by the job execution calendar defined for this
target agent.
shield
Prevents user from being logged-on while the job executes.
noPromptCancel
Allows user to cancel a prompt user job.


rerun
Runs the activate or configure job every time the software policy is
evaluated.
execPromptTimeout
Executes if prompt timeout expires (not set - job is postponed).
resolveQueryGroups
Resolves the target groups before the job is set up.
autoDeliverItem
Stores the package in the Scalability Server Library.
defaultItemProc
Specifies default procedure for the software package with the task
defined for this procedure.
renewFailedOnly
Renews only failed jobs.
runAtShutdown
Forces to Run a job while the system is allowed to shut down.
User Parameters Supplied
Ensures that the User Parameters field is enabled.
User Parameters
Specifies user-defined parameters for the job.
Prompt Timeout Hours Supplied
Ensures that the Prompt Timeout Hours field is enabled.
Prompt Timeout Hours
Specifies the number of hours for which a user prompt is displayed before
forced execution of the job. The default value is 1 day. The parameter value
must not exceed the timeout value for the job.
Delivery Calendar Supplied
Ensures that the Delivery Calendar field is enabled.
Delivery Calendar
Specifies the name of a Unicenter delivery calendar to use for scheduling the
job. The calendar controls the days, dates, and times when delivery is
permitted. The time cells (not set on) defines the exclusion intervals.
If you define a calendar name which is unknown to Unicenter, the job is not
created.


Delivery Date Supplied
Ensures that the Delivery Date field is enabled.
Delivery Date
Specifies the date and time at which the job was delivered.
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
Set Software Package Operator


ITCM Session ID
Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Set Software Package Operator updates the properties of a software
package.



Set Software Package
Software Package ID
Specifies the UUID of the software package (required).
Software Package Name Supplied
Ensures that the "Software Package Name" field is enabled.
Software Package Version Supplied
Ensures that the "Software Package Version " field is enabled.
Specifies the software package version.
Supplier Supplied
Ensures that the "Supplier " field is enabled.
Supplier
Comment Supplied
Ensures that the "Comment " field is enabled.
Comment
Specifies comment for a software package.
Archive Comment Supplied
Ensures that the "Archive Comment" field is enabled.
Archive Comment
Specifies the archive comment.
Software Package Mask Supplied
Ensures that the "Package Mask" field is enabled.
Checksum
Specifies whether a checksum is performed to ensure package consistency.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Set Software Package Procedure Operator


Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Set Software Package Procedure Operator updates the properties of a
software package procedure.



Set Software Package Procedure
Specifies the UUID of a software package procedure (required).
Software Package Procedure Name Supplied
Ensures that the Software Package Procedure Name field is enabled.
Specifies the name of the software package procedure.
Software Package Procedure Task Supplied
Ensures that the Software Package Procedure Task field is enabled.
Specifies the software procedure task types. The task types are as follows:
INSTALL
UNINSTALL
CONFIGURE
ACTIVATE


Software Package Procedure Type Supplied
Ensures that the Software Package Procedure Type field is enabled.
Specifies the types of software package procedures.
SIP
CMDFILE
EXEFILE
SWDET
MSI
SXP
PKG
PIF
IPS
PALM
WINCE
Default: EXEFILE
Comment Supplied
Ensures that the Comment field is enabled.
Comment
User Selectable Supplied
Ensures that the User Selectable field is enabled.
User Selectable
Specifies whether the procedure is allowed to be included in the Software
Delivery Catalog.
External Procedure Supplied
Ensures that the External Procedure field is enabled.


External Procedure
Specifies whether the procedure is external to SD or not.
Operating System Type Supplied
Ensures that the Operating System Type field is enabled.
Specifies the operating system types.
Default: SDAPI_OS_ANY
Operating System Type table in Get Deployment Packages (see page 44) .
Sub Path Supplied
Ensures that the Sub Path field is enabled.
Sub Path
Defines the procedure path within the volume.
Proc To Run Supplied
Ensures that Proc To Run field is enabled.
Proc To Run
Specifies the procedure command to run.
Parameters Supplied
Ensures that the Parameters field is enabled.
Parameters
Specifies the input parameters for the procedure.
Software Package Volume Name Supplied
Ensures that the "Software Package Id and software Package Volume
Name fields are enabled.
Software Package Id
Specifies the UUID of the software package. This field is enabled only when
Software Package Volume Name Supplied flag is set to true.
Specifies the software package volume name to which the procedure is
associated with. This field is enabled only when the Software Package
Volume Name Supplied flag is set to true.
Operation Mask Supplied
Ensures that the Operation Mask field is enabled.


Operation Mask
Specifies a series of flags that indicate options for the operation of a software
package procedure.
Contains the following multiple options:
offline
Execute procedure offline from the Scalability Server
prompt
Display a message on the target computer before the job starts
calendarControl
target agent.
shield
lock
noPromptCancel
Allows user to cancel a prompt user job
background


rerun
Evaluated.
permActArea
execPromptTimeout
Job will execute if prompt timeout expires (not set - job is postponed)
resolveQueryGroups
Resolve the target groups before the job is set up
autoDeliverItem
Store the package in the Scalability Server Library
defaultItemProc
this procedure.
renewFailedOnly
Boot Before Mask Supplied
Ensures that the Boot Before Mask field is enabled.
Boot Before Mask
Specifies the reboot options for a software package procedure.
Default: noReboot
The reboot options are as follows:
noReboot
reboot
logoff
If logoff is set to true the user agent logs off the user and the machine
rebootAfterLast
logoffAfterLast
Boot After Mask Supplied
Ensures that the Boot After Mask field is enabled.


Boot After Mask
Specifies the reboot options for a software package procedure.
Default: noReboot
The options are as follows:
noReboot
Do not reboot the computer before starting the job
reboot
Reboot the computer before starting the job
logoff
If logoff is set to true the user agent logs off the user and the machine
agent logs off all users before the job starts
rebootAfterLast
logoffAfterLast
Dependency Query Name Supplied
Ensures that the Dependency Query Name field is enabled.
Dependency Query Name
Specifies the name of the query (If a prerequisite is defined for the
procedure) that checks to see if the condition is completed.
Management Type Mask Supplied
Ensures that the Management Type Mask field is enabled.
Specifies whether the requested software package for the procedure is
Default: SD
The types are as follows:
sd
executes by the ordinary sd agent
sm
executes by the agent that handles packages created by CA Software
Management Packager.
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID
Set Software Package Procedure Group Operator


Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Set Software Package Procedure Group Operator updates the properties of a
software package procedure group.

Set Software Package Procedure Group
Software Package Procedure Group Id
Specifies the UUID of the software package procedure (required).
Name Supplied
Ensures that the "Name" field is enabled.


Name
Specifies the name of the software package procedure.
Comment Supplied
Ensures that the "Comment" field is enabled.
Comment
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.


ITCM Session ID
Operator Outputs
Operator Results
None.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
Scan Package on Target Computers Operator


The Scan Package on Target Computers Operator performs a scan of the target
computers for deployment of a package.
Note: The Scan Package on Target Computers Operator is not supported on CA
IT Client Manager R11.

Scan Package on Target Computers
Job Name
Specifies the job name that is assigned to the scan operation and the
subsequent deploy (required).
Scan Parameters
Target Machines Supplied
Ensures that the Target Machine field is enabled.
Array Of Target Machines
Specifies the names or IP addresses of the target machines to scanned. The
value cannot be combined with IP address range (start IP and end IP),
domain name, query name, and URI options.
Domain Name supplied
Ensures that the Domain Name field is enabled.
Domain Name
Specifies the domain name.
Start IPAddress Supplied
Ensures that the Start IP Address field is enabled.
Start IPAddress
Specifies the starting IP address of the IP address range.
End IPAddress Supplied
Ensures that the End IP Address field is enabled.
End IPAddress
Specifies the End IP address of Range when you provide the Start IPAddress.


Query Name Supplied
Ensures that the Query Name field is enabled.
Query Name
Specifies the query name.
URI Supplied
Ensures that the URI field is enabled.
URI
Specifies the URI to specify the machines on which the scan is to take place.
Deployment Package From SS Supplied
Ensures that the Deployment Package From SS flag is provided.
Deployment Package From SS
Specifies the packages are transferred from a scalability server for eventual
deployment when set to true.
Scan Stage Packages Supplied
Ensures that the Scan Stage Packages is provided.
Scan Stage Packages
Specifies the packages staged on scalability server to be scanned instead of
the deployed ones when set to true.
Scan Package Information
Product Name
Specifies the product name (required).
Package Name
Specifies the package name for a scan (required).
Package Version Supplied
Ensures that the package version is provided.
Package Version
Specifies the package version.
Platform Supplied
Ensures that the platform is supplied.
Platform
Specifies the package platform.


Language Supplied
Ensures that the language is provided.
Language
Specifies the language of the package for a scan.
Service URL
Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
Get Unit Group Operator


ITCM Session ID
Operator Outputs
Operator Results
Job Id
Returns a Job Id assigned for the scan operation.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
The Get Unit Group Operator retrieves a unit group identified by its UUID.



Get Unit Group
System Group
Select System Group to retrieve from System Unit Group. This checkbox is
selected by default.
User Defined Group
Select User Defined Group to retrieve from User Defined Unit Group.
Note: The user can select either the System Group or the User Defined
Group.
Group Name
Specifies the system or user-defined group to retrieve the UUID (required).
Unit Group Properties Required
Specifies which unit group properties to retrieve (required).
Contains the following properties:
Group UUID
Specifies the UUID identifying the unit group.
Domain UUID
Specifies the UUID identifying the CA IT Client Manager domain for the
given group.


Group Label
Specifies the name of the unit group.
Group Inheritance
Indicates the nature of the inheritance of permissions for members of
the group.
Group System
Indicates whether the group is a CA IT Client Manager system group; for
example, a value of 1 indicates that the group is user-defined and not a
system group. A value of 100 or more indicates that the group is a
special predefined system group.
The possible values are:
Unclassified System Group = 0,
User-Defined Group = 1 (Indicates that the group was defined by a
CA IT Client Manager user and is not a system group)
Directory Group = 2 (Indicates that this is not a system group, but is
a group that maps to a group in an external configured directory.)
All Computers($AllComputer) = 100
All User Profiles($AllUsers) = 101
All User Accounts($AllComputerUsers) =102
All Computer User Groups($AllComputerUserGroups) =103
All Domains($AllDomains) =104
All Queries($AllQueries) =105
All Jobs($AllJobs) =106
All Event Logs($AllEventLogs) =107
All Servers($AllServers) =108
All Server Groups($AllServerGroups) =109
All Domain Groups($AllDomainGroups) =110


Group Flag
Indicates whether the group is local or global.
Evaluation UUID
Specifies a UUID that is not supplied if the group is static, but if the group
is dynamically populated, the evaluationUUID is the UUID of the engine
that evaluates the query associated with this group.
Evaluation Frequency
Specifies the time (in seconds) between each re-evaluation of the query
that governs the group's members.
Last Evaluation Date Time
The last time at which the members of the group were evaluated.
Query UUID
The UUID identifying the query on which basis units are defined as
members of this group.
Member Type
A numeric value that indicates the type of members that the group may
contain. This is one of the following:
Asset Group = 1
The group can contain AssetGrps, Computers, Users, and Computer
users.
Domain Group = 4
The group can contain Domains and Domain groups.
Query Group = 6
The group can contain Queries and Query groups.


Server Group= 7
The group can contain Server groups, and Servers.
Job Group = 8
The group can contain Jobs and Job Groups.
Event Group = 9
The group can contain event log objects.
Directory Group = 10
The group can contain directory objects.
Values between 100 and 200 represent URC-specific groups.
Values between 300 and 400 represent USD-specific groups.
Software Group = 300
The group can contain Software definitions.
Procedure Group = 301
The group can contain Software procedures.
Group Description
Describes the unit group.
Security Group
Indicates if the unit group is a security group.
Query Label
Specifies the display name or description of the query associated with
this unit group.
Query Type
Specifies the type of the query that defines the members of this unit
group. The type indicates on which database tables the query is based.
Engine Label
Specifies the display name of the engine responsible for evaluating the
Engine Hostname
Specifies the host name of the engine responsible for evaluating the
Engine Description
Specifies the description of the engine responsible for evaluating the
Creation User Account
Specifies the name of the user account that created the unit group.


Creation Date
Specifies the date and time on which the unit group was created.
Last Updated User Account
Specifies the name of the user account that last updated the group's
properties.
Last Updated Date
Specifies the date and time on which the unit group's properties were
last updated.
Group Version Number
Specifies the version number of the group's record. A version number is
incremented each time a record is updated.
Service URL
Username
level.
level.
Password
level.
module level.


Hostname
level.
module level.
ITCM Session ID
Operator Outputs
Operator Results
GetUnitGroupReturn
Returns the unit group properties.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Get Unit ID Operator


Fault Message
The Get Unit ID Operator retrieves a unit group identified by its UUID.

Get Unit ID
Unit Group ID
Specifies the Unit Group ID (required).
Unit Property
Specifies the unit properties from user accounts, user profiles, and
computers.
If you provide a value in the "Unit Property" field (for example,
"UNIT-COMPUTER-LABEL"), then you must also provide the label name of
the unit you want to retrieve in the "Search String" field; otherwise it
retrieves all units.


This field is mandatory if unitProperty is set to one of the following values:
UNIT_USERACCOUNT_UUID
UNIT_USERACCOUNT_NAME
UNIT_USERACCOUNT_URI
UNIT_USERACCOUNT_LABEL
UNIT_USERACCOUNT_DOMAIN_UUID
UNIT_USERACCOUNT_DOMAIN_LABEL
UNIT_USERACCOUNT_CREATION_USER
UNIT_USERACCOUNT_LAST_UPDATED_USER
UNIT_COMPUTER_UUID
UNIT_COMPUTER_LABEL
UNIT_COMPUTER_DOMAIN_UUID
UNIT_COMPUTER_PRIMARY_NETWORK_ADDRESS
UNIT_COMPUTER_HOST_UUID
UNIT_COMPUTER_ASSET_SOURCE_UUID
UNIT_COMPUTER_HOST_NAME
UNIT_COMPUTER_SERIAL_NUMBER
UNIT_COMPUTER_DISC_SERIAL_NUMBER
UNIT_COMPUTER_PRIMARY_MAC_ADDRESS
UNIT_COMPUTER_ASSET_TAG
UNIT_COMPUTER_URI
UNIT_COMPUTER_SYSTEM_ID
UNIT_COMPUTER_VENDOR_NAME
UNIT_COMPUTER_DOMAIN_LABEL
UNIT_COMPUTER_CREATION_USER
UNIT_COMPUTER_LAST_UPDATED_USER
UNIT_USERPROFILE_UUID
UNIT_USERPROFILE_LABEL
UNIT_USERPROFILE_CREATION_USER
UNIT_USERPROFILE_LAST_UPDATED_USER


Search String
Specifies the search string.
Search Value
If the property to search on is a numeric property, this parameter specifies
the value of the search filter to be applied. This field is mandatory if
unitProperty is set to one of the following values:
UNIT_USERACCOUNT_USAGE_LIST
UNIT_USERACCOUNT_CREATION_DATE
UNIT_USERACCOUNT_LAST_UPDATED_DATE
UNIT_USERACCOUNT_VERSION_NUMBER
UNIT_COMPUTER_CLASSID
UNIT_COMPUTER_USAGE_LIST
UNIT_COMPUTER_CREATION_DATE
UNIT_COMPUTER_LAST_UPDATED_DATE
UNIT_COMPUTER_VERSION_NUMBER
UNIT_USERPROFILE_REFERENCE_COUNT
UNIT_USERPROFILE_USAGE_LIST
UNIT_USERPROFILE_CREATION_DATE
UNIT_USERPROFILE_LAST_UPDATED_DATE
UNIT_USERPROFILE_VERSION_NUMBER
Number Of Units
Specifies the total number of units to retrieve from the list (required). If the
"Number Of Units" supplied exceeds the total number of units, then the
Operator internally replaces the "number of units" with the "total number of
units".
Service URL


Username
level.
level.
Password
level.
module level.
Hostname
level.
module level.
ITCM Session ID


Operator Outputs
Operator Results
Array Of Unit Properties
Returns an array of Unit Properties - one for each unit requested from the
list.
If the number of units supplied exceeds the total number of units, two additional
parameters/variables appears.
Warning
Displays the text message "Number of units provided exceeds the total
number of available units".
TotalNoOfUnits
Displays the total number of available units.
Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message
ITCM Base Interface Operator


The ITCM Base Interface Operator lets you access all CA IT Client Manager web
services.
Note: In the Base Operator the ITCM User ID, Password, and Hostname fields
are not applicable in case of Login and Logout web service calls. These fields
are applicable for other web services. In other web services, you will find a
<sessionId> element. If you provide a value for the session Id, then this
Operator will use the session Id value, otherwise it will create the ITCM session
using the ITCM User ID, Password, and Hostname.

ITCM Base Interface
WZDL Wizard
Allows the user to select the SOAP methods.
ITCM URL
Specifies the URL of the CA IT Client Manager web service.
ITCM Method
Specifies the name of the CA IT Client Manager method to invoke.
ITCM User ID
Specifies the user ID.
Password
Hostname
Specifies the CA IT Client Manager host name.


Input Source
Specifies the source for the web service input request data.
The options are:
Inline Text
Defines the SOAP request.
Preformatted SOAP File
Defines that the specified file is used as an input.
Expression
Defines that the content of an expression is used for an input.
Inline Text
Specifies an Inline Text source.
Preformatted Filename
Specifies path to the preformatted CA IT Client Manager web service request
file on the Touchpoint host.
Expression
Specifies the expression.
Save Request File
Specifies a file to save the outbound web service request (for debugging
purposes).
Dynamic Parameters
Parameter style
Specifies a method to update values in the web service request.
The SOAP Module supports two mechanisms to do this at run time:
Macro Expansions
Specifies that macros are used in the Parameter list to update values in
a SOAP request.
XPath Assignments
Specifies that XPath expressions are used in the Parameter list to update
values in a SOAP request.


Parameters list
Specifies the unique data entries within the SOAP request. Click the Add
button to add a parameter, the Edit button to edit the currently selected
parameter, or the Delete button to delete the currently selected parameter.
It is a best practice to add the parameters in the same order that they are
specified by the WSDL for the SOAP call.
In the Parameters List dialog you can set the following parameter values:
Macro name/XPath query
Specifies the name of the macro or the XPath query. If it is the name of
a macro, then the macro name will be substituted by the value If it is an
XPath query, then the node returned by the query will be updated with
the value.
Value
Returns a run-time value for the parameter.
Type
Specifies one of the following data types for the parameter:
String Value
Integer Value
XML Fragment
Call Results
Response Save File
Specifies the path for the web server response file returned by the remote
web service.
Extract SOAP response body first-level elements to individual Dataset
variables
Ensures that the SOAP first-level elements are extracted to individual
Dataset variables.


Extract SOAP response body to Dataset variable
Ensures that the SOAP response body part is saved in a Dataset Variable.
Additional extracted data
Specifies XPath expressions to extract data from the body of the SOAP
response. For each expression specified here, state a Dataset variable to
which the extracted data and data type would be stored. Click the Add
button to add an expression, the Edit button to edit a selected existing
expression, or the Delete button to delete a selected expression. The
ordering of the expressions has no significance to CA IT PAM.
You can edit the following parameter settings:
XPath Expression
Specifies the XPath expression that selects the desired information.
Dataset variable
Specifies the variable name that stores the result.
Type
Specifies the variable type. Select one of the following currently
supported types:
Integer
String
Integer Array
String Array
XML Fragment
XML Fragment Array
Operator Outputs
Operator Results
SOAPResponseBody
Returns the Response XML.
SOAPResponseData
Returns the SOAP response in a dataset variable.
Note: These results would appear only if the Extract Soap Response check box in
the Call Results section is selected.


Operator Ports
Success
are displayed:
SOAP Response Body
SOAP response Data
Failure
displayed:
SOAP Response Body
Fault Message


Chapter 4: Troubleshooting

A CA IT Client Manager Module Operator Fails during Execution of a Process (see
page 189)
Cannot Connect via CA IT Client Manager Operators (see page 193)
Problem Retrieving Service URL Field (ITCM1000) (see page 194)
Problem Retrieving Username Field (ITCM1001) (see page 194)
Problem Retrieving Password Field (ITCM1002) (see page 194)
Problem Retrieving Hostname Field (ITCM1003) (see page 195)
Failed to create ITCM Session (ITCM1004) (see page 195)
Failed to Retrieve List Handle (ITCM1005) (see page 196)
Failed to Identify Group Type (ITCM1006) (see page 196)
Problem Retrieving the List of Units (ITCM1007) (see page 197)
Parent Software Package Group does not exist (ITCM1008) (see page 197)
Failed to Retrieve the Query ID of the Query Name (ITCM1011) (see page 198)
Failed to Retrieve the UUID of the Group Name (ITCM1011) (see page 198)
ITCM related error messages (see page 199)
A CA IT Client Manager Module Operator Fails during
Execution of a Process
Valid on Windows
Symptom:
The CA IT Client Manager module Operator fails during execution of a process.
Solution: 1
Verify that the CA IT PAM server service is running:
1. Open the Start menu, and click Programs, Administrative Tools, and
Services.
2. Check if the CA IT PAM Server service is running.
If the service has stopped, restart it.
Note: After you reboot your machine, you may need to restart the service.
A CA IT Client Manager Module Operator Fails during Execution of a Process


Solution: 2
Verify that the CA IT Client Manager application is running:
1. Open the Start menu, and click, Programs, Administrative Tools, and
Services.
2. Verify that the CA IT Client Manager application is running.
If the service has stopped, restart it.
After you reboot your machine, you may need to restart the service.
Notes:
You can open the CA IT Client Manager DSM explorer if the CA IT Client
Manager application is running.
You can log in successfully to the CA IT Client Manager DSM Web Console.
On your initial connection to the CA IT Client Manager Web Console, a
login dialog appears.
Enter your valid credentials and click Log In.


Solution: 3
Verify that CA IT PAM is installed properly and you have the proper access rights.
1. Verify that you have privileges to run the CA IT PAM Orchestrator and
Agents.
For more information about installation and configuration, see the Windows
Service Account Prerequisites chapter in the CA IT PAM Installation and
Configuration Guide.
2. Verify that the CA IT PAM database system is running properly:
a. Open a command prompt window, run the following commands:
For a Microsoft SQL Server database system use sqlcmd command
to test the connection to the database:
sqlcmd -S <machine name> -U <itpamuser> -P <itpampwd> -d itpam
where <itpamuser> and <itpampwd> are the CA IT PAM database
user and password.
For an Oracle database, use SQL Plus to test the connection to the
database from a command prompt:
sqlplus <username>[/<password>] @connect_identifier
where @connect_identifier consists of an Oracle Net connect
identifier. The machine information where Oracle is installed is
contained in the @connect_identifier. The exact syntax depends
upon the Oracle Net communications protocol your Oracle
installation uses. For more information about Oracle database, refer
to the Oracle documentation appropriate for your protocol or contact
your database administrator.
For a MySQL Server database, test the database connection from a
command prompt:
mysql -h<hostname> u<username> -p<password>
b. After connecting successfully to the CA IT PAM database, run a SQL
query, for example:
Select * from SOAPClientCall
go


If you are able to connect to the CA IT PAM database, and the previous
statements execute successfully, then the database system is running
properly; otherwise, verify the database login user name and password
and retry. If the database login user name and password are correct,
then there may be a problem with the database system.
Decrease the logging level for Orchestrators and Agents to WARNING or
INFO to get more information about the error. Debug the Orchestrator issues
using c2o.log and boot.log here: <server_install_path>\server\c2o\log.
boot.log contains all messages logged by core components (for example,
JBoss) before CA IT PAM starts execution.
c2o.log contains all messages logged by all components after CA IT PAM
starts execution.
Use the main log file (c2o.log) that contains messages from all the
components to debug Agent issues. The c2o.log is located here:
<agent_install_path>\log. To get more information logs, do the following:
Decrease the default logging level for Agent in log4j.xml.
This file is located here:
<agent_install_path>\.c2orepository\.c2oagentresources\properties.
FILE and CONSOLE are the logging categories and are set by default to level
ERROR. For more information for a category, do the following:
Change the threshold parameter for the required category and
decrease the level from ERROR to WARN, or INFO.
Change the root category to include the required categories and set
the log level to the lowest level specified in any category.
Decrease the default logging level for Orchestrator in log4j.xml. This
XML file is located here: <orchestrator_install_path>\ server\c2o\conf
location.
Similarly, you can change the Agent logging server, C2OFILE, and CONSOLE
logging categories to obtain more log information.
Cannot Connect via CA IT Client Manager Operators


Solution: 4
Verify the CA IT Client Manager Operator connection parameters. The
parameters could be incorrectly set, thus causing the failure of the CA IT Client
Manager Operator.
Solution: 5
Verify the URL specified for the Operator. Specifying the wrong web service URL
can lead to XML parsing errors.
Solution: 6
Check the Execution Settings and specify a valid Touchpoint in the Target
section.
Cannot Connect via CA IT Client Manager Operators
Symptom:
The following error messages occur when I try to connect via a CA IT Client
Manager Operator:
java.security.PrivilegedActionException:
com.sun.xml.messaging.saaj.SOAPExceptionImpl: Message send failed
invalid login name
invalid login password
Solution:
The CA IT Client Manager Operator parameters could be set incorrectly. Verify
the CA IT Client Manager connection parameters.
To validate the CA IT Client Manager web service URL
1. Open a web browser and navigate to the CA IT Client Manager web service
URL. The CA IT Client Manager web service URL has the following format:
http://<servername>/UDSM_R11_WebService/help/.
To check the credentials passed in connection parameters
1. From the Windows desktop, click Start, Programs, CA, IT Client Manager,
DSM Web Console.
A login page appears.
2. Enter the manager name, user name, password, windows domain,
and security provider fields.
If the credentials are incorrect, the login will fail.
Problem Retrieving Service URL Field (ITCM1000)


Problem Retrieving Service URL Field (ITCM1000)
Symptom:
A CA IT Client Manager Operator fails to execute with the fault string Problem in
retrieving Service URL field and fault code ITCM1000.
Solution:
The CA IT Client Manager web service URL is not specified correctly at the
Operator level or the module level. Provide the correct web service URL. Note
that the Operator level parameters override module level parameters.
Problem Retrieving Username Field (ITCM1001)
Symptom:
retrieving Username field and fault code ITCM1001.
Solution:
The user name is not specified correctly at the Operator level or the module
level. Provide the correct user name. Note that Operator level parameters
override module level. The format for the user name is as follows:
Windows format: winnt:\\<hostname>\<username>
Unix format: unixl://<hostname>/<username>
Problem Retrieving Password Field (ITCM1002)
Symptom:
A CA IT Client Manager Operator fails to execute with the fault string "Problem in
retrieving Password field" and fault code "ITCM1002".
Solution
The password is not specified correctly at the Operator level or the module level.
Provide the correct password. Note that Operator level parameters override
module level parameters.
Problem Retrieving Hostname Field (ITCM1003)


Problem Retrieving Hostname Field (ITCM1003)
Symptom:
retrieving Hostname field and fault code ITCM1003.
Solution:
The host name is not specified correctly at the Operator level or the module
level. Provide the correct host name. Note that Operator level parameters
override module level parameters.
Failed to create ITCM Session (ITCM1004)
Symptom:
A CA IT Client Manager Operator fails to execute with the fault string Failed to
create ITCM Session and fault code ITCM1004.
Solution: 1
The CA IT Client Manager server login credentials (web service URL, username,
hostname or password) are not specified correctly at the Operator level or the
module level properties. Provide the correct credentials. Note that the Operator
level parameters override module level parameters.
Solution: 2
The parameter ITCM Session ID on the ITCM Session palette is not valid for
the Operator. Provide the valid session ID.
Failed to Retrieve List Handle (ITCM1005)


Failed to Retrieve List Handle (ITCM1005)
Symptom:
One of the following Operators failed to execute with the fault string failed to
retrieve List Handle and fault code ITCM1005:
Get Software Package Group
Get Software Package Installations
Get Software Package Procedures
Get Software Packages
Solution
One of the parameters is not specified correctly for the Operator and the
Operator failed to retrieve the list handle. Provide the correct parameters.
Failed to Identify Group Type (ITCM1006)
Symptom:
The Get Unit Group Operator failed to execute with the fault string failed to
identify group type and fault code ITCM1006.
Solution
Turn on the System Group or User Defined Group check box; one of these check
boxes must be selected in order for the Get Unit Group Operator to execute
successfully.
Problem Retrieving the List of Units (ITCM1007)


Problem Retrieving the List of Units (ITCM1007)
Symptom:
One of the following CA IT Client Manager Operators failed to execute with the
fault string Problem in retrieving the list of units and fault code ITCM1007:
Get Unit Group
Get Unit ID
Solution:
One or more parameters are not specified correctly and the Operator failed to
retrieve the unit list handle. Provide the correct parameters correctly to fix this
error.
Parent Software Package Group does not exist (ITCM1008)
Symptom:
fault string Parent Software Package Group does not exist and fault fode
ITCM1008:
Find Software Package Group
Find Software Package Procedure Group
Solution: 1
The parameter Parent Software Package Group Name does not exist for the Find
Software Package Group Operator. Provide the valid parameter.
Solution: 2
The parameter Parent Software Package Procedure Group Name does not exist
for the Find Software Package Procedure Group Operator. Provide the valid
parameter.
Failed to Retrieve the Query ID of the Query Name (ITCM1011)


Failed to Retrieve the Query ID of the Query Name
(ITCM1011)
Symptom:
fault string failed to retrieve the query ID of the Query Name and fault code
ITCM1011:
Create Software Package Procedure
Set Software Package Procedure
Solution: 1
The parameter Dependency Query Name is invalid for the Create Software
Package Procedure Operator. Provide the valid name.
Solution: 2
The parameter Dependency Query Name is invalid for the Set Software Package
Procedure Operator. Provide the valid name.
Failed to Retrieve the UUID of the Group Name (ITCM1011)
Symptom:
The CA IT Client Manager Get Unit Group Operator failed to execute with the
fault string failed to retrieve the UUID of the Group Name and fault code
ITCM1011.
Solution
The parameter Group Name is invalid for the Get Unit Group Operator. Provide
the valid name.
ITCM related error messages


ITCM related error messages
ITCM web service error messages:
For information related to CA IT Client Manager web service error messages
(Fault Code and Fault String), go to the following URL:
Windows: http://<server-name>/UDSM_R11_WebService/help/
Linux: http://<server-name>/UDSM_R11_WebService/help
where <server-name> is the name of the machine where the CA IT Client
Manager server is running.
A CA IT Client Manager web services reference guide opens. Click Web Service
Messages to view a list of all CA IT Client Manager web service-related error
messages.
ITCM component error messages:
For a complete list of error messages related to CA IT Client Manager
components, refer to the CA IT Client Manager Message Help.

Index 201

Index

A
address, specifying a primary computer network
20
audiences, intended 11
authentication 17
authorization 17
available software packages, number of 80
C
computer name, specifying a 20
Connector, definition of 12
D
default properties, unit software job 85
deployment packages, retrieving 44
DM Deployment Manager 44
E
error messages, ITCM Web service 189
evaluating software policy 100
execution settings 189
F
failure, Operator execution 18
fault message 18
G
group, find a software package 29, 57, 66
H
host name, default 15, 22
I
installations, get software package 84
installing CA IT Client Manager 13
ITCM Web service error messages 189
J
job properties, unit software 85
L
login parameters 22
logout Operator, description of 18
M
Module, definition of 12
N
name, software package, specifying the 27
network address, specifying a computer primary
20
number of software package procedures
exceeded 80
O
Operator, definition of 12
P
password, specifying a 22
ports, Operator 18
S
server login parameters 23
server logout 19
service URL, defining a 22
session ID 23
session parameters 23
SOAP response 18
software package procedure, properties of 57
software packages, identifying 53
U
user, default ITCM 15
username, defining a 22
V
version, software package, specifying the 27
W
warning message 89

CA Itcm Connector Enu

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

CA Itcm Connector Enu

Загружено:

Авторское право:

Доступные форматы

CA IT Client Manager Connector Guide

Вам также может понравиться