Previous Topic: UserProfilePropertyNext Topic: Methods


SoftwareJobLinkageType

NOLINKAGE

No job linkage exists.

TRANSACTION

The job linkage option is set to batch job execution.

SYNCHRONIZED

The job linkage option is set to synchronized job execution.

WeekDay

A list of the possible weekdays that you can specify while scheduling a job:

PERIODTYPE

A list of the possible period type you can specify while scheduling a job:

CO_TRIGGER_UNIT_TYPE

A list of the possible unit types:

UnitObjectType

A list of the possible unit object types:

AMExtraCmdParam

A list of the possible parameters for executing asset management job check:

CFComponentCode

A list of the possible Component codes:

WS_OSIM_DEPLOY

A list of values indicating if the manager must wait for the deployment of the OS images. Use one of the following:

WS_OSIM_DO_NOT_WAIT

Specifies that the domain manager must not wait.

WS_OSIM_WAIT

Specifies that the domain manager must wait.

WS_OSIM_CONF_TYPE

Specifies the type of installation request. Use one of the following:

WS_OSIM_CT_PLANNED

Specifies a planned request.

WS_OSIM_CT_SCHEDULED

Specifies a scheduled request.

WS_OSIM_CT_CURRENT

Specifies a current request.

WS_OSIM_IR_STATUS

Specifies the status of the installation request of the OSIM computer. Possible installation requests:

WS_IR_PLANNED

Specifies a planned installation request of the target computer.

WS_IR_SCHEDULED

Specifies a scheduled installation request of the target computer.

WS_OSIM_CONFIG_STATE

Specifies the configuration state of an OSIM Computer. Possible states:

WS_OSIM_UNMANAGED

Specifies that the OSIM computer is in an unmanaged state.

WS_OSIM_CURRENT

Specifies that the OSIM computer is in a current state.

WS_OSIM_STOPPED

Specifies that the OSIM computer is in a stopped state.

WS_OSIM_CANCEL_PEND

Specifies that the OSIM computer is in a canceled state.

WS_OSIM_ERROR

Specifies that the OSIM computer is in a failed state.

WS_OSIM_PLANNED

Specifies that the OSIM computer is in a planned state.

WS_OSIM_ACTIVATED

Specifies that the OSIM computer is in an activated state.

WS_OSIM_ANALYZING

Specifies that the OSIM computer is in an analyzing state.

WS_OSIM_PENDING

Specifies that the OSIM computer is in a pending state.

WS_OSIM_INSTALLING

Specifies that the OSIM computer is in an installing state.

Property_Type

Specifies the property types:

COMPUTER_MACADDRESS

Specifies as MAC address.

COMPUTER_NETWORKADDRESS

Specifies as network address.

COMPUTER_HOSTNAME

Specifies as host name.

COMPUTER_SERIAL_NUMBER

Specifies as computer serial number.

FILTERCONDITION

Specifies the valid filter conditions for different properties. Use the following filters:

Note: Use the following filters with xsd:string elements.

FILTER_WILDCARD_EQ

Defines the wildcard equal filter.

FILTER_WILDCARD_NE

Defines the wildcard not equal xxx.

FILTER_REGEX

Defines the regular expression filter.

Note: Use the following filters with xsd:long, dsm:DateTime, and enumerations.

FILTER_EQ

Defines the equal filter.

FILTER_NE

Defines the not equal filter.

Note: Use the following filters with xsd:long and dsm:DateTime elements.

FILTER_GT

Defines the greater than filter.

FILTER_GE

Defines the greater than or equal filter.

FILTER_LT

Defines lesser than filter.

FILTER_LE

Defines the lesser than or equal filter.

OSIMAGEPROPERTY

Specifies the OS image properties on which the sort and filter conditions can be applied. OS image properties:

IMAGE_NAME

Specifies the OS image name.

TYPE_INDICATOR

Specifies the OS type.

OPERATING_SYSTEM

Specifies the operating system of the OS image.

REGISTERED_DATETIME

Specifies the registration date and time of the OS image with the domain manager.

SD_PACKAGE_NAME

Specifies the name of the software delivery package corresponding to the OS image.

SD_PACKAGE_VERSION

Specifies the version of software delivery package corresponding to the OS image.

SD_OS_CODE

Specifies the OS code of the software delivery package corresponding to the OS image.

LOCALE

Specifies the locale of the OS image.

IMAGE_FLAGS

Specifies the FIPS image flags of the OS image.

OSIMTARGETPROPERTY

Specifies the OSIM computer properties on which the sort and filter conditions can be applied. OSIM computer properties:

TARGET_NAME

Specifies the name of the OSIM computer.

TARGET_MACADDRESS

Specifies the MAC Address of the OSIM computer.

OSIM_CONFIG_STATE

Specifies the configuration state of the OSIM computer.

STATE_CHANGED_DATETIME

Specifies the changed or activation date and time of the OSIM computer.

OS_IMAGENAME

Specifies the name of the OS image associated with the OSIM computer.

ComputerProperty2

A list of computer properties that you can use for specifying search filters is as follows:

COMPUTER_UUID

Filters based on computer UUID value.

COMPUTER_LABEL

Filters based on Computer name/label value.

COMPUTER_DOMAIN_UUID

Filters based on Computer Domain UUID value.

COMPUTER_PRIMARY_NETWORK_ADDRESS

Filters based on the Computer Primary network address value.

COMPUTER_HOST_UUID

Filters based on Computer Host UUID value.

COMPUTER_ASSET_SOURCE_UUID

Filters based on Computer Asset Source UUID value.

COMPUTER_HOST_NAME

Filters based on Computer Hostname value.

COMPUTER_SERIAL_NUMBER

Filters based on Computer Serial Number value.

COMPUTER_DISC_SERIAL_NUMBER

Filters based on Computer Disk serial number value.

COMPUTER_PRIMARY_MAC_ADDRESS

Filters based on Computer MAC Address value.

COMPUTER_ASSET_TAG

Filters based on Computer Asset tag value.

COMPUTER_URI

Filters based on Computer URI value.

COMPUTER_SYSTEM_ID

Filters based on Computer System ID value.

COMPUTER_VENDOR_NAME

Filters based on Computer Vendor Name value.

COMPUTER_DOMAIN_LABEL

Filters based on Computer Domain Label value.

COMPUTER_CREATION_USER

Filters based on Computer Creation user value.

COMPUTER_LAST_UPDATED_USER

Filters based on Computer last updated user value.

COMPUTER-AGENT-NAME

Filters based on Computer Agent Name value.

COMPUTER-AGENT-DESCRIPTIONS

Filters based on Computer Agent Descriptions value.

COMPUTER-USER-DATA1

Filters based on Computer User defined data1.

COMPUTER-USER-DATA2

Filters based on Computer User defined data2.

COMPUTER-USER-DATA3

Filters based on Computer User defined data3.

COMPUTER-USER-DATA4

Filters based on Computer User defined data4.

COMPUTER-AGENT-SS

Filters based on Agent Scalability server name

COMPUTER-AGENT-IPADDRESS

Filters based on Agent IP Address

COMPUTER_CLASSID

Filters based on Computer Operation System value.

COMPUTER_USAGE_LIST

Filters based on Computer usage list value.

COMPUTER_CREATION_DATE

Filters based on Computer Creation date time.

COMPUTER_LAST_UPDATED_DATE

Filters based on Computer last updated date time.

COMPUTER_VERSION_NUMBER

Filters based on Computer version number.

COMPUTER-AGENT-TRUSTLEVEL

Filters based on Computer Agent trust level.

COMPUTER-AGENT-CREATION-DATETIME

Filters based on Agent Creation date time.

COMPUTER-AGENT-LASTRUN-DATETIME

Filters based on Agent last run date time.

COMPUTER_AGENT_AM_STATUS

Filters based on AM Agent Status.

COMPUTER_AGENT_SD_STATUS

Filters based on SD Agent Status.

COMPUTER_AGENT_RC_STATUS

Filters based on RC Agent Status.

COMPUTER_AGENT_PT_STATUS

Filters based on Protection Agent Status.

COMPUTER_AGENT_ASP_STATUS

Filters based on Anti Spyware Agent Status.

COMPUTER_AGENT_AV_STATUS

Filters based on Antivirus Agent Status.

COMPUTER_AGENT_HIPS_STATUS

Filters based on HIPS Agent Status.

COMPUTER_AGENT_RESTRICTIONS

Filters based on Agent Restrictions.

ComputerFilterCondition

Specifies the valid filter conditions for different computer properties. The Available filters:

Note: Use the following filters with xsd:string elements.

COMPUTER_FILTER_WILDCARD_EQ

Defines the wildcard equal filter.

COMPUTER_FILTER_WILDCARD_NE

Defines the wildcard not equal filter.

Note: Use the following filters with xsd:long, dsm:DateTime, and enumerations.

COMPUTER_FILTER_EQ

Defines the equal filter.

COMPUTER_FILTER_NE

Defines the not equal filter.

Note: Use the following filters with xsd:long and dsm:DateTime elements.

COMPUTER_FILTER_GT

Defines the greater than filter.

COMPUTER_FILTER_GE

Defines the greater than or equal filter.

COMPUTER_FILTER_LT

Defines the lesser than filter.

COMPUTER_FILTER_LE

Defines the lesser than or equal filter.

AMAgentStatus

Indicates the AMAgent status on the target computer. Possible values:

WS_AM_AGENTLESS

Indicates that the computer is collected through the external asset functionality.

WS_AM_ALERT

Indicates that the computer has violated a policy with severity as Alert.

WS_AM_INFORMATION

Indicates that the computer has violated a policy with severity as Information.

WS_AM_WARNING

Indicates that the computer has violated a policy with severity as Warning.

WS_AM_LEGACY

Indicates that the computer has a legacy asset management agent.

WS_AM_NOTINSTALLED

Indicates that the computer does not have the AM Agent plug-in installed.

WS_AM_OPERATIONAL

Indicates that the computer is operational.

WS_AM_PREREGISTERED

Indicates that the computer is preregistered.

SDAgentStatus

Indicates the SDAgent status. Possible values:

WS_SD_LOCKED_BY_MIGRATION

Indicates that the computer is locked for migration.

WS_SD_LOCKED_BY_MOVE

Indicates that the computer is locked for move operation.

WS_SD_LOCKED_BY_RAC

Indicates that the computer is locked by RAC.

WS_SD_LOCKED_BY_RAC_AND_MOVE

Indicates that the computer is locked by RAC and Move.

WS_SD_LOCKED_BY_RAC_AND_ROAM

Indicates that the computer is locked by RAC and ROAM.

WS_SD_LOCKED_BY_ROAM

Indicates that the computer is locked by ROAM.

WS_SD_NOTINSTALLED

Indicates that the computer does not have the SD Agent plug-in installed.

WS_SD_PREREGISTERED

Indicates that the computer is preregistered.

WS_SD_OPERATIONAL

Indicates that the computer is operational.

RCAgentStatus

Indicates the RCAgent status. Possible values:

WS_RC_ACTIVE_SESSION

Indicates that the computer has an active session with a viewer.

WS_RC_ACTIVE_LOCAL_SESSION

Indicates that the computer can manage its own security settings and has an active session with a viewer.

WS_RC_LISTENING

Indicates that the computer can accept a request for a remote control session.

WS_RC_LISTENING_LOCAL_SESSION

Indicates that the computer can manage its own security settings and accept a request for a remote control session.

WS_RC_LOCKED

Indicates that the Remote Control application on the computer has been locked. Active sessions have been terminated and no new sessions can be started with the computer.

WS_RC_LOCKED_LOCAL_SESSION

Indicates that the computer can manage its own security settings but the Remote Control application on the computer has been locked. Active sessions have been terminated and no new sessions can be started with the computer.

WS_RC_MIGRATED

Indicates that the computer has migrated Remote Control agents.

WS_RC_NOT_INSTALLED

Indicates that the Remote Control agent has not been installed on the computer.

WS_RC_NOT_LISTENING

Indicates that the computer cannot accept a request for a remote control session, but the agent can be configured.

WS_RC_NOT_LISTENING_LOCAL_SESSION

Indicates that that the computer manages its own security settings and cannot accept a request for a remote control session, but the agent can be configured.

WS_RC_PREREGISTERED

Indicates that the computer is preregistered.

WS_RC_STOPPED

Indicates that that the computer has Remote Control agent installed but is not running.

WS_RC_STOPPED_LOCAL_SESSION

Indicates that that the computer has Remote Control agent installed and manages its own security settings, but remote control is not running.

WS_RC_UNKNOWN

Indicates that the computer has the RC Status as Unknown.

ProtectionAgentStatus

Indicates the ProtectionAgent status. Possible values:

WS_PT_NOTINSTALLED

Indicates that the state of all three protection applications (CA Anti-Virus, CA Anti-Spyware, and CA HIPS) is "Not Installed" or "Unknown".

WS_PT_PREREGISTERED

Indicates that the computer is preregistered.

WS_PT_NOTPROTECTED

Indicates that protection data has been retrieved and the state of at least one of the protection applications is different from "Operational" or "Not Installed."

WS_PROTECTED

Indicates that at least one protection application is installed and the individual states of all the installed applications are "Operational."

ASPAgentStatus

Indicates the Anti-Spyware agent status. Possible values:

WS_ASP_UNKNOWN

Indicates that no protection data about ASPAgent is retrieved yet or agent object is preregistered.

WS_ASP_OPERATIONAL

Indicates that ASPAgent is operational.

WS_ASP_NOTOPERATIONAL

Indicates that ASPAgent is installed but not operational.

WS_ASP_NOTINSTALLED

Indicates that ASPAgent is not installed.

AVAgentStatus

Indicates the Anti-Virus agent status. Possible values:

WS_AV_UNKNOWN

Indicates that no protection data about AVAgent is retrieved yet or agent object is preregistered.

WS_AV_OPERATIONAL

Indicates that AVAgent is operational.

WS_AV_NOTOPERATIONAL

Indicates that AVAgent is installed but not operational.

WS_AV_NOTINSTALLED

Indicates that AVAgent is not installed.

HIPSStatus

Indicates the HIPS status. Possible values:

WS_HIPS_UNKNOWN

Indicates that no protection data about HIPS agent is retrieved yet or agent object is preregistered.

WS_HIPS_OPERATIONAL

Indicates that HIPS agent is operational.

WS_HIPS_NOTOPERATIONAL

Indicates that HIPS agent is installed but not operational.

WS_HIPS_NOTINSTALLED

Indicates that HIPS agent is not installed.

AgentRestrictions

Specifies the agent restrictions. Possible values:

JOB-RESTRICTION-NONE

Specifies that there are no agent restrictions.

JOB-RESTRICTION-LOCAL

Identifies the jobs blocked locally.

JOB-RESTRICTION-CENTRAL

Identifies the jobs blocked centrally.

JOB-RESTRICTION-ALL

Identifies the jobs blocked locally and centrally.

ObjectPreference

Specifies the object type of the group you want to retrieve. Possible values:

LOCALLY

Indicates that the group is a local group.

REPLICATE

Indicates that the group is a replicated group.

NO-PREFERENCE

Indicates that there is no preference and both the groups must be retrieved.

QueryTargetType

Indicates the target type of the query. Possible values:

QUERY-TARGET-TYPE-CUSTOM

Specifies that the target type of the query is custom.

QUERY-TARGET-TYPE-COMPUTERS

Specifies that the target of the query is computers.

QUERY-TARGET-TYPE-USERACCOUNTS

Specifies that the target of the query is user accounts.

QUERY-TARGET-TYPE-USERPROFILES

Specifies that the target of the query is user profiles.

QUERY-TARGET-TYPE-OSIMCOMPUTERS

Specifies that the target of the query is OSIM computers.

QueryFilterCondition

Specifies the filter conditions for query properties. Available filters:

QUERY-FILTER-WILDCARD-EQ

Applies wildcard characters in the filter condition for string values and filters the queries that match the wildcard pattern.

QUERY-FILTER-WILDCARD-NE

Applies wildcard characters in the filter condition for string values and filters the queries that do not match the wildcard pattern.

QUERY-FILTER-EQ

Specifies a filter condition for enumerations and filters the queries that match the specified enumeration value.

QUERY-FILTER-NE

Specifies a filter condition for enumeration and filters the queries that do not match the specified enumeration value.

HWMODEL-FILTER-CONDITION

Specifies the filter conditions for hardware models. Available filters:

HWMODEL-WILDCARD-EQ

Applies wildcard characters in the filter condition for string values and filters the queries that match the wildcard pattern.

HWMODEL-WILDCARD-NE

Applies wildcard characters in the filter condition for string values and filters the queries that do not match the wildcard pattern.

COMPONENTS

Specifies the components that are supported.

COMPONENT-STATUS

Specifies the list of status

ConfigurationParams

Specifies the configuration parameters that are supported:

SD-MAXJOBTIMEOUT

Corresponds to the config param “/itrm/usd/manager/MaxActivationTime”.

SD-MINJOBTIMEOUT

Corresponds to the config param “/itrm/usd/manager/MinActivationTime”.

SD-JOBCLEANUPTIME

Corresponds to the config param “/itrm/usd/manager/JobCleanupTime”.

SD-JOBHISTORYCLEANUPTIME

Corresponds to the config param “/itrm/usd/manager/JobHistoryCleanupTime”.

SD-ALREADYINST-OK

Corresponds to the config param “/itrm/usd/manager/AlreadyInstalledStatus”.

SD-FAIL-IMPLICIT-SS-DELIVERIES

Corresponds to the config param “/itrm/usd/manager/ FailImplicitDeliveries”.

SD-CHECK-TEMPLATE-POLICIES

Corresponds to the config param “/itrm/usd/manager/ CheckTemplatePolicies”.

SD-RAC-AUTOMATION

Corresponds to the config param “/itrm/usd/manager/ RACAutomation”.

SD-JOBCLEANUPINTERVAL

Corresponds to the config param “/itrm/usd/manager/ JobCleanupInterval”.

SD-FORCED-RESTRICTIONS

Corresponds to the config param “/itrm/usd/manager/ ForcedRestrictions”.

WS_OSIM_CONFIG_STATE

Specifies the configuration state of an OSIM Computer. Possible states:

WS_OSIM_UNMANAGED

Specifies that the OSIM computer is in an unmanaged state.

WS_OSIM_CURRENT

Specifies that the OSIM computer is in a current state.

WS_OSIM_STOPPED

Specifies that the OSIM computer is in a stopped state.

WS_OSIM_CANCEL_PEND

Specifies that the OSIM computer is in a canceled state.

WS_OSIM_ERROR

Specifies that the OSIM computer is in a failed state.

WS_OSIM_PLANNED

Specifies that the OSIM computer is in a planned state.

WS_OSIM_ACTIVATED

Specifies that the OSIM computer is in an activated state.

WS_OSIM_ANALYZING

Specifies that the OSIM computer is in an analyzing state.

WS_OSIM_PENDING

Specifies that the OSIM computer is in a pending state.

WS_OSIM_INSTALLING

Specifies that the OSIM computer is in an installing state.

Enumerations for Automation Services

The following sections describe all the enumerated types (enums) that the Automation Services uses for automated OS migration functionality. These structures are a mapping of the underlying layer functionality.

AssessmentTemplateType

Specifies whether the assessment template is based on parameters or on a query.

Possible values:

AssessmentTemplateParameterName

Specifies the name of the parameter used for creating the assessment template. For example, if you want to create an assessment template based on CPU speed, specify the parameter name as CPUSPEED.

Possible values:

AssessmentTemplateParameterDataType

Specifies the data type of the parameter used for creating the assessment template.

Possible values:

ASSESSMENTTEMPLATEPROPERTY

Specifies the properties of the assessment templates that you can use to filter and sort the list of assessment templates.

Possible values:

ASSESSMENTTASKPROPERTY

Specifies the properties of assessment tasks:

AssessmentStatus

Specifies the status of assessment job.

Possible values:

ResultGroup

Specifies the result group type.

Possible values:

OsimTemplateType

Specifies the type of the OSIM template.

Possible values:

FilterCondition

Specifies the valid filter conditions for different properties.

You can use the following filters:

Note: Use the following filters with xsd:string elements.

FILTER_WILDCARD_EQ

Defines the wildcard equal filter.

FILTER_WILDCARD_NE

Defines the wildcard not equal xxx.

Note: Use the following filters with xsd:long, dsm:DateTime, and enumerations.

FILTER_EQ

Defines the equal filter.

FILTER_NE

Defines the not equal filter.

Note: Use the following filters with xsd:long and dsm:DateTime elements.

FILTER_GT

Defines the greater than filter

FILTER_GE

Defines the greater than or equal filter.

FILTER_LT

Defines lesser than filter.

FILTER_LE

Defines the lesser than or equal filter.

OSIMTEMPLATEPROPERTY

Specifies the properties of the OSIM templates that you can use to filter and sort the list of OSIM templates.

SOFTWAREDEPLOYMENTTEMPLATEPROPERTY

Specifies the properties of the software deployment templates that you can use to filter and sort the list of software deployment templates.

AUTOMATIONPROCESSPROPERTY

Specifies the properties of the automation process:

AutomationProcessMode

Specifies the automation process modes:

AutomationProcessStatus

Specifies the status of the automation process:

AutomationTargetStatus

Specifies the status of the computers in the automation process:

AutomationResultProperty

Specifies the properties available in the automation result:

LogLevel

Specifies the log level:

ActionType

Specifies the action to be taken on the automation process: