Sequences

Web Services Reference › Sequences

Sequences

The following sections describe all the sequences that the Client Automation Web Services uses. These structures are a mapping of the underlying layer functionality.

This section contains the following topics:

ComputerProperties2

QueryProperties2

QueryFolderProperties

AuthenticationData

CreateDistributionContainerProperties

CreateDomainGroupProperties

CreateInstallSoftwareJobOrderPolicyProperties

CreateInstallSoftwareJobOrderPolicyProperties3

CreateInstallSoftwareJobOrderProperties

CreateInstallSoftwareJobOrderProperties3

CreateQueryProperties

CreateQueryProperties2

CreateSecurityAreaProperties

CreateSecurityProfileProperties

CreateSoftwareGroupProperties

CreateSoftwareJobContainerProperties

CreateSoftwarePackageProcedureDependencyProperties

CreateSoftwarePackageProcedureGroupProperties

CreateSoftwarePackageProcedureProperties

CreateSoftwarePackageProcedureProperties2

CreateSoftwarePackageProcedureProperties3

CommonSoftwarePackageProcedureProperties3

SoftwarePackageProcedureOperationMask3

computerClassID

ComputerProperties

ComputerPropertiesRequired

ComputerPropertyFilter

ComputerStatusInfoRequired

CreateAgentComponents

CreateAgentComponents

CreateCatalogSoftwarePackageGroupProperties

CreateComputerProperties

CreateComputerProperties2

CreateSoftwareJobContainerProperties2

CreateSoftwareJobContainerProperties3

CreateSoftwareJobOrderPolicyProperties

CreateSoftwareJobOrderPolicyProperties3

CreateSoftwareJobOrderProperties

CreateSoftwareJobOrderProperties3

CreateSoftwarePackageGroupProperties

CreateSoftwarePackageProperties

CreateSoftwarePackageVolumeProperties

DistributionContainerProperties

DistributionContainerPropertiesRequired

DistributionPermissionMask

DistributionContainerOrderPropertiesRequired

CreateSoftwarePolicyProperties2

CreateUnitGroupPropertiesByName

CreateUserProfileProperties

DeploymentPackageProperties

DeploymentPackagePropertiesRequired

DeploymentPackageInfo

DiscoveredSoftwareProperties

DiscoveredSoftwarePropertiesRequired

DistributionContainerOrderProperties

DistributionContainerOrderProperties3

DistributionDomainProperties

DistributionDomainPropertiesRequired

DomainGroupProperties

DomainGroupPropertiesRequired

DomainProperties

MachineCredentials

NoOfDistributionDomains

QueryResultProperties

QueryResultPropertiesRequired

ResumeDeliveryDistributionContainerProperties

ExportSoftwarePkgProperties

FetchItemJobOrderProperties

FetchItemOrderProperties

FileSystemElementPath

GetSecurityAreaConfiguration

GetSecurityGroupPermissions

GetSecurityObjectsPermissions

ImportSoftwarePackageProperties

ImportSoftwarePackageProperties2

ImportSoftwarePackagePropertiesByName

QueryProperties

QueryProperties3

QueryPropertiesRequired

QueryPropertiesRequired3

ScanPackageInfo

SDAgentProperties

SecurityAreaProperties

SecurityAreaPropertiesRequired

SecurityClassPermissions

SecurityClassPermissionsForSecurityProfile

SecurityClassPermissionProperties

SecurityClassProperties

SecurityClassPropertiesRequired

SecurityGroupPermissionsForAllSecurityProfiles

SecurityGroupProfilePermission

SecurityObjectLinkageProperties

SecurityObjectProfilePermission

SecurityObjectSecurityAreaLinkages

SecurityObjectOwner

SecurityObjectPermissions

SecurityAreaByName

SecurityAreaConfiguration

SecurityAreaConfigurationByName

SecurityObjectPermissionsForAllSecurityProfiles

SecurityObjectsSecurityAreaProperties

SecurityProfileProperties

SecurityProfilePropertiesRequired

SetSecurityProfileProperties

SetSecurityGroupPermissions

SetSecurityObjectPermissions

SecurityProfileSpecialPermissionFlags

SetCatalogSoftwarePackageGroupProperties

SetComputerProperties

SetDomainGroupProperties

SetSecurityClassProperties

SetSoftwareJobContainerProperties2

SetSoftwarePolicyProperties2

SetSoftwareGroupProperties

SetQueryProperties

SetQueryProperties3

SetSoftwarePackageProcedureGroupProperties

SetSoftwarePackageProcedureProperties3

SoftwarePackageProcedureProperties3

SetSoftwareJobContainerProperties

SetSoftwareJobContainerProperties2

SetSoftwareJobContainerProperties3

SoftwareJobContainerPropertiesRequired2

SetSoftwareJobProperties

SetSoftwareJobProperties2

SetSoftwareJobProperties3

CreateUnitGroupProperties2

CreateSoftwareJobLinkage

DomainPropertyFilter

DomainPropertiesRequired

ElementTypeMask

EvaluationTypeMask

SetDistributionContainerProperties

SetSecurityAreaProperties

SetSoftwarePackageGroupProperties

SetSoftwarePackageProcedureProperties

SetSoftwarePackageProcedureProperties2

SetSoftwarePackageProperties

SetSoftwarePackageVolumeProperties

SetSoftwarePolicyProperties

SetSoftwarePolicyProperties3

SetSoftwarePolicyPropertiesByName

SetSoftwarePolicyPropertiesByName3

SetTimeoutProperties

SetUnitGroupProperties

SetUserProfileProperties

SoftwareJobPermissionMask

SoftwareJobProperties

SoftwareJobProperties2

SoftwareJobProperties3

SoftwareJobPropertiesRequired

SoftwareJobStatusCounters

SoftwarePackageGroupPropertiesRequired

SoftwarePackageMask

SoftwarePackageMaskType

CreateSoftwarePolicyProperties

CreateSoftwarePolicyProperties3

CreateUnitGroupProperties

SoftwareJobBootMask (bootAfterMask)

SoftwareJobBootMask3 (bootAfterMask)

SoftwareJobBootMask (bootBeforeMask)

SoftwareJobBootMask3 (bootBeforeMask)

SoftwareJobContainerProperties

CreateAssetScriptJobResponse

AssetScriptJobProperties

SchedulingOptions

DateTimeRestrictions

PeriodicDependency

JobExecProperties

PostJobProperties

AssetScriptJobPropertiesRequired

Dsm:OpenAssetScriptJobListResponse

GetAssetScriptJobResponse

DayOfTheWeekDependency

GetAssetScriptJobsProperties

OSIMPropertiesWithDesc

OSIMparameterDesc

ScalabilityServerProperties

ScalabilityServerPropertiesRequired

OSImageProperties

OSIMTargetFilter

OSIMTargetProperties

ComputerPropertyFilter2

ComputerPropertiesRequired2

ComputerProperties2

CreateOSIMComputerProperties

OSImageProperties

SoftwareJobContainerProperties3

SoftwareJobContainerPropertiesRequired

SoftwareJobContainerPropertiesRequired3

SoftwareJobContainerPropertyMask

SoftwareJobOperationMask

SoftwareJobOperationMask2

SoftwareJobOrderProperties

SoftwareJobOrderProperties3

SoftwarePackageGroupProperties

SoftwarePackageProcedureBootMask (bootAfterMask)

SoftwarePackageProcedureBootMask2 (bootAfterMask)

SoftwarePackageProcedureBootMask

SoftwarePackageProcedureBootMask2 (bootBeforeMask)

FindSoftwarePackageProcedure

SoftwarePackageProcedurePropertiesRequired

SoftwarePackageProcedureTypeMask

SoftwarePackagePropertiesRequired

SoftwarePackageVolumeElementPropertiesRequired

SoftwarePackageVolumeProperties

SoftwarePackageVolumePropertiesRequired

SoftwarePackageProcedureDependencyProperties

SoftwarePackageProcedureDependencyPropertiesRequired

SoftwarePackageProcedureGroupProperties

SoftwarePackageProcedureGroupPropertiesRequired

SoftwarePackageProcedureManagementTypeMask

SoftwarePackageProcedureOperationMask

SoftwarePackageProcedureOperationMask2

SoftwarePackageProcedureProperties

SoftwarePackageProcedureProperties2

SoftwarePackageProperties

SoftwarePackageProperties2

SoftwarePackageVolumeElementProperties

SoftwarePolicyExceptionProperties

SoftwarePolicyProperties

SoftwarePolicyProperties3

SoftwarePolicyPropertiesRequired

SoftwarePolicyPropertiesRequired2

SoftwarePolicyPropertiesRequired3

SoftwareJobContainerProperties2

SoftwareJobContainerPropertiesRequired2

SoftwarePolicyState

SoftwareJobContainerOrder

SoftwarePolicyOrder

SoftwarePackageProcedureOrder

SoftwareJobLinkage

SoftwareJobLinkage

SoftwarePackage

SoftwarePackageOrder

SoftwarePackageProcedure

SoftwarePolicyProperties2

SSPackageInfoRequired

StagingCredentials

UnitInventoryComponentProperties

UnitInventoryComponentPropertiesRequired

UnitInventoryGroupProperties

UnitInventoryGroupPropertiesRequired

UnitInventoryItemProperties

UnitInventoryItemPropertiesRequired

UnitGroupProperties

SetUnitGroupProperties2

UnitGroupPropertiesForSoftwarePolicy

UnitGroupPropertiesRequired

UnitPropertiesRequired

UnitPropertyFilter

UnitQueryPropertiesRequired

UnitQueryProperties

UnitSoftwareJobProperties

UnitSoftwareJobProperties2

UnitSoftwareJobPropertiesRequired

UnitSoftwareJobTaskMask

UnlinkSoftwarePackageProceduresFromSoftwarePackageProcedureGroupByName

UserAccountProperties

UserAccountPropertiesRequired

UserAccountPropertyFilter

UserProfileProperties

UserProfilePropertiesRequired

UserProfilePropertyFilter

VolumeElementAttributes

CreateSoftwarePackageProperties3

SetSoftwarePackageProperties3

SoftwarePackageProperties3

SoftwarePackagePropertiesRequired3

dsm:SoftwarePackageProcedureProperties4

SoftwarePackageProcedurePropertiesRequired2

UnitSoftwareJobProperties3

WSChallengeResponse

WSAuthenticateResponse

UnitGroupProperties2

CreateUnitGroupProperties3

createAssessmentTemplate

updateAssessmentTemplate

deleteAssessmentTemplates

getAssessmentTemplate

getAssessmentTemplateList

getAssessmentTemplateListDetailed

createAssessmentTask

executeAssessmentTask

getAssessmentStatus

getAssessmentResult

getAssessmentTask

getAssessmenTaskList

deleteAssessmentTasks

createOSIMTemplate

updateOSIMTemplate

deleteOSIMTemplates

getOSIMTemplate

getOSIMTemplateList

getOsimTemplateListDetailed

createSoftwareDeploymentTemplate

updateSoftwareDeploymentTemplate

deleteSoftwareDeploymentTemplates

getSoftwareDeploymentTemplate

getSoftwareDeploymentTemplateList

getSoftwareDeploymentTemplateListDetailed

createAutomationProcess

deleteAutomationProcesses

executeAutomationProcess

getAutomationProcessList

getAutomationProcessListDetailed

getAutomationResult

getAutomationResult2

getAutomationProcessTargetStatus

getAutomationProcessStatus

runAutomationSoftwareJobContainer

runAutomationOSInstallJob

runAutomationGenericJobContainer

getActivityLog2

setActivationStatus

getSupportedOSForAssessment

SDTemplateProperties

SoftwarePackageFilter

SoftwarePackageProperties2

ManagerProperties

CreateSoftwareJobContainerProperties4

BootImageFilter

BootImageProperties

BootServerProperties

OSIMTargetProperties2

OSIMTargetProperties

BootServerFilter

ComputerProperties2

QueryProperties2

QueryFolderProperties

Health Monitoring Sequences

Sequences for Automation Web Services

ComputerProperties2

The following sequences of elements specify the properties required when you are retrieving the properties of a computer.

xsd:string computerUUID

Specifies the UUID of the computer.

xsd:string computerLabel

Specifies the display name of the computer.

xsd:string computerDomainUUID

Specifies the UUID identifying the Client Automation domain of the computer.

xsd:string computerPrimaryNetworkAddress

Specifies the IP address of the computer in 0.0.0.0 format.

xsd:string computerHostUUID

Specifies the agent-generated UUID that identifies the computer.

xsd:string computerAssetSourceUUID

Specifies the UUID identifying the common CA asset to which this computer is linked.

xsd:string computerHostName

Specifies the host name of the computer.

xsd:string computerSerialNumber

Specifies the serial number of the computer.

xsd:string computerDiscSerialNumber

Specifies the serial number of the computer disc.

xsd:string computerPrimaryMACAddress

Specifies the MAC address of the computer. The string must have a maximum length of 64 characters.

xsd:string computerAssetTag

Specifies the string value that identifies a computer asset.

xsd:long computerClassID

Specifies the numeric value indicating the class of the computer object. For example, Operating System.

dsm:UsageListMask computerUsageList

Specifies the computer usage list mask.

xsd:string computerURI

Specifies the fully qualified Uniform Resource Identifier of the computer.

xsd:string computerSystemID

Specifies the user-defined identifier for computer.

xsd:string computerVendorName

Specifies the name of the computer vendor.

xsd:string computerDomainLabel

Specifies the display name of the DSM domain to which the computer belongs.

xsd:string computerCreationUser

Specifies the name of the user account that created the computer record.

dsm:DateTime computerCreationDate

Specifies the computer creation date and time.

xsd:string computerLastUpdatedUser

Specifies the name of the user account that last updated the computer properties.

dsm:DateTime computerLastUpdatedDate

Specifies the date and time when the computer properties were last updated.

xsd:long computerVersionNumber

Specifies the version number of the computer record.

Note: The version number is incremented each time a record is updated.

xsd:string agentName

Specifies the agent name of the computer.

xsd:long agentRestrictions

Specifies the agent restrictions.

xsd:string agentDescription

Specifies the agent description.

xsd:string userdata1

Specifies the user defined data1.

xsd:string userdata2

Specifies the user defined data2.

xsd:string userdata3

Specifies the user defined data3.

xsd:string userdata4

Specifies the user defined data4.

xsd:string scalabilityserverName

Specifies the name of the scalability server that the agent is pointing to.

dsm:DateTime2 agentCreationDateTime

Specifies the agent creation data and time.

dsm:DateTime2 lastRunDateTime

Specifies the agent last run date and time.

xsd:string agentIPAddress

Specifies the IP address of the agent.

xsd:long agentTrustlevel

Specifies the trust level of the agent.

xsd:string agentOrigin

Specifies the origin of the agent.

dsm:AMAgentStatus amStatus

Specifies the AM Agent status.

dsm:SDAgentStatus sdStatus

Specifies the SD Agent status.

dsm:RCAgentStatus rcStatus

Specifies the RC Agent status.

dsm:ProtectionStatus protectionStatus

Specifies the Protection Agent status.

dsm:ASPStatus aspStatus

Specifies the ASP status.

dsm:AVStatus avStatus

Specifies the AV status.

dsm:HIPSStatus hipsStatus

Specifies the HIPS status.

QueryFilter

The QueryFilter sequence specifies a search filter that you can use for searching or listing queries.

dsm: QueryFilterCondition filterCondition: Specifies the filter condition you want to apply.
dsm: QueryProperty queryProperty: Specifies the property you want to filter.
xsd:string searchString: Specifies the string you want to search in the name property.
dsm: QueryTargetType targetType: Specifies the query target type.

QueryProperties2

The QueryProperties2 sequence contains the properties of a query.

xsd:string queryUUID: Specifies the UUID of the query.
Xsd:string queryName: Specifies the name of the query.
dsm: QueryTargetType queryType: Specifies the type of the query.
Xsd:boolean replicated: Specifies whether is query is replicated from enterprise manager. If true, it indicates that the query is replicated from enterprise manager.

QueryProperty

The QueryProperty sequence specifies the query properties on which you can apply the sort and filter conditions.

QUERY-LABEL: Specifies the name of the query.
QUERY-TARGET-TYPE: Specifies the target type of the query.

QueryFolderProperties

The QueryFolderProperties sequence contains the properties of a query folder.

Xsd:string folderName: Specifies the name of the query folder.
Xsd: long folderId: Specifies the ID of the query folder.

HWModelFilter

The HWModelFilter sequence specifies a search filter that you can use for searching or listing unique hardware models.

dsm: HWMODEL-FILTER-CONDITION filterCondition: Specifies the filter condition you want to apply.
xsd:string searchString: Specifies the string you want to search in the hardware model name.

Copyright © 2014 CA Technologies. All rights reserved.