VolumeElementAttributes

Web Services Reference › Sequences › VolumeElementAttributes

VolumeElementAttributes

This sequence of elements specifies properties of a volume element.

xsd:boolean readOnly
xsd:boolean hidden
xsd:boolean system
xsd:boolean directory
xsd:boolean archive
xsd:boolean normal
xsd:boolean temporary
xsd:boolean atomicWrite
xsd:boolean xactionWrite
xsd:boolean compressed

Remarks

None

CreateSoftwarePackageProperties3

The CreateSoftwarePackageProperties3 sequence specifies the software package properties that are initialized when a software package is created.

xsd:string softwarePackageName (m)

Specifies the name of the software package.

xsd:string softwarePackageVersion (m)

Specifies the version of the software package.

xsd:string supplier

Specifies the supplier of the package.

xsd:boolean supplierSupplied

Specifies whether the supplier value is specified.

xsd:string comment

Specifies a comment for the software package.

xsd:boolean commentSupplied

Specifies whether the comment is specified.

xsd:string basedOnSoftwarePackageId

Specifies that the new software package is based on the UUID of the given package ID.

xsd:boolean basedOnSoftwarePackageIdSupplied

Specifies whether to create a software package that is based on the UUID of the package.

xsd:boolean enableCheckSum

Specifies whether to enable the checksum integrity check.

xsd:boolean enableCheckSumSupplied

Specifies whether the enableCheckSum value is specified.

xsd:int packageType

Specifies whether a software package is a generic SD package (0) or a Debian wrapper package (9).

xsd:string metadataXML

Specifies the metadata for the debian wrapper package.

Note: If you selected the package type as 9, specify the xsd:string metadataXML, otherwise package creation fails.

SetSoftwarePackageProperties3

The SetSoftwarePackageProperties3 sequence of elements specifies the software package properties that you want to set while editing the package.

xsd:string softwarePackageId (m)

Specifies the UUID of the package whose properties need to be edited.

xsd:string softwarePackageName

Specifies the new name of the package.

xsd:boolean softwarePackageNameSupplied

Specifies whether to update a package name.

xsd:string softwarePackageVersion

Specifies the new version of the package.

xsd:boolean softwarePackageVersionSupplied

Specifies whether to update a package version.

xsd:string supplier

Specifies the new supplier of the package.

xsd:boolean supplierSupplied

Specifies whether to update the supplier.

xsd:string comment

Specifies a new comment for the package.

xsd:boolean commentSupplied

Specifies whether to update a comment.

xsd:string archiveComment

Specifies the archive comment for the software package.

xsd:boolean archiveCommentSupplied

Specifies whether to update an archive comment.

xsd:boolean enableCheckSum

Specifies whether to enable the package integrity check.

xsd:boolean enableCheckSumSupplied

Specifies whether to enable the enableCheckSum parameter.

xsd:int packageType

Specifies whether a software package is a generic SD package (0) or a Debian wrapper package (9).
Note: This parameter is not supported in this release.

xsd:boolean packageTypeSupplied

Specifies whether to enable the packageType parameter.

Note: This parameter is not supported in this release.

xsd:string packagemetadataXML

Specifies new metadata for the Debian wrapper package.

xsd:Boolean metadataSupplied

Specifies if metadata must be updated.

Note: If the package is in a sealed state, you can edit comments, enableCheckSum fields but cannot change the package type.

SoftwarePackageProperties3

The SoftwarePackageProperties3 sequence of elements specifies software package properties.

xsd:string softwarePackageId

Specifies the UUID that identifies a software package.

xsd:string softwarePackageName

Specifies the name of the software package.

xsd:string softwarePackageVersion

Specifies the version of the software package.

xsd:string basedOnSoftwarePackageId

Specifies the ID of the software package based on which you want to create the new package.

xsd:string basedOnSoftwarePackageName

Specifies the name of the software package based on which you want to create the new package.

xsd:string basedOnSoftwarePackageVersion

Specifies the version of the software package based on which you want to create the new package.

xsd:string supplier

Specifies the supplier of the software package.

xsd:string comment

Specifies a comment for the software package.

xsd:string sourcePath

Specifies the path where the installation files are registered.

Xsd:int packageState

Specifies the type of the software package. The following table describes the states of software packages:

Possible values	Possible states of software packages
0	Sealed state
1	Unsealed and open state
2	Detected state
3	Archived

xsd:boolean userSelectable

Indicates whether the package is displayed in the Software Delivery Catalog.

Default: False

Xsd:int sourceMedium

Specifies the source for the software package data source. The following table describes the sources of software packages:

Possible values	Possible sources of software packages
0	DISKETTE
1	HARDDISK
2	UNDEFINED
3	TAPE
4	CD

xsd:int packageFiledBy

Specifies the user who has created the software package. The item is filed by a local administrator. The following table describes the users of software packages:

Possible values	Possible users of software packages
0	CENTRAL Specifies an item that is distributed and filed by an enterprise administrator.
1	TD-LOCAL Specifies a software delivery item that is filed by a local administrator.
2	TDSWD Specifies a software item that is detected and filed by the local Software Detector.
3	TDSWD-CENTRAL Specifies a software item that is filed at the enterprise manager which in turn, is based on a report from the domain manager about a locally detected software item.
4	TD Specifies a software delivery item that is automatically filed during installation.

DateTime registrationDateTime

Specifies the date and time at which a software package is registered.

DateTime changeDateTime

Specifies the date and time at which the software package was last modified.

Xsd:int packageType

Specifies the type of software package. The following table describes the types of software packages:

Possible values	Types of software packages
0	Generic
1	SXP.
2	PIF
3	PKG
4	MSI
5	PALM
6	WINCE
7	RPM
8	Nokia
9	DebWrap

xsd:long packetSize

Specifies the standard package size of the package in KB.

xsd:long buildOnSize

Specifies the extended package size in KB with added procedures.

xsd:string archivePath

Specifies the archive path of the software package.

xsd:string archiveComment

Specifies the archive comment for the software package.

xsd:string archivedBy

Specifies the user who archived the package.

xsd:int archiveAt

Indicates whether the specified path is archived or not and also specifies the location at the server or enterprise manager. The following table describes whether the specified path is archived or not:

Possible values	Specified path is Archived or not
0	Not archived
1	Archived on the admin client
2	Domain manager
3	Enterprise manager

dsm:DateTime archDateTime: Specifies the archived date and time for the software package.
Xsd:int checksum
Xsd:int packageFormat: Specifies whether a package is regular (0) or Virtual (1).
Xsd:string packagemetadataXML: Specifies the metadata of the Debian wrapper package.

SoftwarePackagePropertiesRequired3

The dsm:SoftwarePackagePropertiesRequired3 sequence of elements specifies the software package properties that are required when retrieving a software package property.

xsd:boolean softwarePackageIdRequired
xsd:boolean softwarePackageNameRequired
xsd:boolean softwarePackageVersionRequired
xsd:boolean basedOnSoftwarePackageIdRequired
xsd:boolean basedOnSoftwarePackageNameRequired
xsd:boolean basedOnSoftwarePackageVersionRequired
xsd:boolean supplierRequired
xsd:boolean commentRequired
xsd:boolean sourcePathRequired
xsd:boolean packageStateRequired
xsd:boolean userSelectableRequired
xsd:boolean softwarePackageDataSourceRequired
xsd:boolean softwarePackageFiledByRequired
xsd:boolean registrationDateTimeRequired
xsd:boolean changeDateTimeRequired
xsd:boolean packageTypeRequired
xsd:boolean packetSizeRequired
xsd:boolean buildOnSizeRequired
xsd:boolean archivePathRequired
xsd:boolean archiveCommentRequired
xsd:boolean archivedByRequired
xsd:boolean archiveAtRequired
xsd:boolean archDateTimeRequired
xsd:boolean flagsRequired
xsd:boolean metadataRequired

dsm:SoftwarePackageProcedureProperties4

The dsm: SoftwarePackageProcedureProperties4 sequence specifies the software package procedure properties.

xsd:string softwarePackageProcedureId

Specifies the UUID of the software package procedure.

xsd:string softwarePackageProcedureName

Specifies the name of the software package procedure.

SoftwarePackageProcedureTask softwarePackageProcedureTask

Specifies the task type of the software package procedure.

Default: INSTALL

Xsd:int procedureType

Specifies the states of the software package procedure. The following table describes the states of software package procedures:

Possible values	Types of the software package procedures
0	SIP
1	CMDFILE
2	EXEFILE
3	SWDET
4	MSI
5	SXP
6	PKG
7	PIF
8	IPS
9	PALM
10	WINCE
11	RPM
12	NOKIA
13	DebWrap

xsd:string comment

Specifies a comment for the software package procedure.

xsd:boolean userSelectable

Specifies whether to allow the procedure to be included in the SD Catalog.

Default: False

xsd:boolean externalProcedure

Specifies that the procedure is external to SD.

Default: False

SoftwarePackageProcedureFiledBy filedBy

Specifies the entity by which the software package procedure is filed.

xsd:long operatingSystemType

Specifies the type of the operating system.

Default: SDAPI_OS_ANY

xsd:string subPath

Specifies the path of the procedure within the volume.

xsd:string procToRun

Specifies the procedure command.

xsd:string parameters

Specifies the input parameters for the procedure.

SoftwarePackageProcedureRelation procedureRelation

Specifies the path of the procedure relative to the path of the software package to which the procedure belongs.

SoftwarePackageProcedureFiledBy activatedBy

Specifies the entity by which the software package procedure was activated.

DateTime activatedDateTime

Specifies the date and time when the procedure is activated.

xsd:string softwarePackageId

Specifies the UUID of the software package to which the procedure is associated.

xsd:string softwarePackageName

Specifies the name of the software package to which the procedure is associated.

xsd:string softwarePackageVersion

Specifies the version of the software package to which the procedure is associated.

Xsd:int softwarePackageState

Specifies the states of the software package to which the procedure is associated. The following table describes the software package to which the procedure is associated:

Possible values	States
0	Sealed
1	Unsealed
2	Detected
3	Archived

xsd:string softwarePackageVolumeId

Specifies the UUID of the volume of the software package to which the procedure is associated.

xsd:string softwarePackageVolumeName

Specifies the name of the volume of the software package to which the procedure is associated.

SoftwarePackageProcedureOperationMask3 operationMask

Specifies the operation property for the procedure operation.

SoftwarePackageProcedureBootMask2 bootBeforeMask

Specifies the restart option that is requested for the software package procedure before executing the procedure.

SoftwarePackageProcedureBootMask2 bootAfterMask

Specifies the restart options that are requested for the software package procedure after executing the procedure.

xsd:string dependancyQueryId

Specifies UUID of the query that checks whether the condition is fulfilled, provided a prerequisite is defined for the procedure.

SoftwarePackageProcedureManagementTypeMask managementTypeMask

Specifies whether to allow the requested software package for the procedure to run on the managed targets.

Default: SD

SoftwarePackageProcedurePropertiesRequired2

The SoftwarePackageProcedurePropertiesRequired2 sequence of elements specifies the procedure properties that are required when retrieving the software package procedure properties.

xsd:boolean softwarePackageProcedureIdRequired
xsd:boolean softwarePackageProcedureNameRequired
xsd:boolean softwarePackageProcedureTaskRequired
xsd:boolean softwarePackageProcedureTypeRequired
xsd:boolean commentRequired
xsd:boolean userSelectableRequired
xsd:boolean externalProcedureRequired
xsd:boolean filedByRequired
xsd:boolean operatingSystemTypeRequired
xsd:boolean subPathRequired
xsd:boolean procToRunRequired
xsd:boolean parametersRequired
xsd:boolean procedureRelationRequired
xsd:boolean activatedByRequired
xsd:boolean activatedDateTimeRequired
xsd:boolean softwarePackageIdRequired
xsd:boolean softwarePackageNameRequired
xsd:boolean softwarePackageVersionRequired
xsd:boolean softwarePackageStateRequired
xsd:boolean softwarePackageVolumeIdRequired
xsd:boolean softwarePackageVolumeNameRequired
xsd:boolean internalMaskRequired
xsd:boolean operationMaskRequired
xsd:boolean bootBeforeMaskRequired
xsd:boolean bootAfterMaskRequired
xsd:boolean dependancyQueryIdRequired
xsd:boolean managementTypeMaskRequired

UnitSoftwareJobProperties3

The UnitSoftwareJobProperties3 sequence defines the properties for a unit software job.

xsd:string unitSoftwareJobId

Specifies the UUID of the software job for a specific unit.

xsd:string unitId

Specifies the UUID of the unit to which the software job is applied.

xsd:string unitName

Specifies the name of the unit to which the software job is applied.

UnitType unitType

Specifies the type of the unit to which the software job is applied.

xsd:string unitNetAddress

Specifies the network address of the unit to which the software job is applied, appropriate for the unitType.

xsd:string softwareJobId

Specifies the UUID of the software job that is applied to the given unit.

xsd:string softwareJobName

Specifies the name of the software job that is applied to the given unit.

SoftwareJobState softwareJobState

Specifies the current state of the specified software job on the given unit.

xsd:long softwareJobOrderNumber

Specifies the order number for the given software job.

xsd:string softwarePackageId

Specifies the UUID that identifies the software package that is associated with the given software job unit.

xsd:string softwarePackageName

Specifies the name of the software package that is associated with the given unit software job.

xsd:string softwarePackageVersion

Specifies the version of the software package that is associated with the given software job unit.

SoftwarePackageClass softwarePackageState

Specifies an enumerated list of classes to which a software package belongs.

xsd:string softwarePackageProcedureId

Specifies the UUID that identifies the software package procedure that is associated with the given software job unit.

xsd:string softwarePackageProcedureName

Specifies the name of the software package procedure that is associated with the given software job unit.

DateTime activationDateTime

Specifies the date and time when the software job is activated.

DateTime creationDateTime

Specifies the date and time when the software job is created.

DateTime completionDateTime

Specifies the date and time when the software job is completed.

SoftwareJobType softwareJobType

Specifies the type of the software job.

xsd:string orderedBy

Specifies the user account that started or ordered the software job unit.

UnitSoftwareJobState unitSoftwareJobState

Specifies the current state of the unit software job.

UnitSoftwareJobState unitSoftwareJobRenewState

Specifies that the job is renewed and also indicates the current state of that renewal.

SoftwareJobPermissionMask unitSoftwareJobPermissionMask

Specifies the permissions applicable to the unit software job.

xsd:string errorMessage

Specifies the text of an error message that the software job has generated.

xsd:long errorCode

Specifies the software job generates code of the error.

xsd:string userDefinedName

Specifies a user-defined identifier for the software job unit.

xsd:string comment

Specifies a comment for the unit software job.

xsd:string unitInstallationSoftwareJobId

Specifies the UUID of the installation job that are associated with the given software job unit.

xsd:string unitInstallationSoftwarePackageProcedureId

Specifies the UUID of the installation procedure that is associated with the given software job unit.

xsd:string unitInstallationSoftwarePackageProcedureName

Specifies the name of the installation procedure that is associated with the given software job unit.

UnitSoftwareJobTaskMask softwareJobTaskMask

Specifies the type of the task to which the unit software job is concerned.

Example: Install or Configure

xsd:long percentSent

Specifies the percentage of the software job that is sent to target.

Xsd:Int packageType

Specifies the type of the software package. The following table describes the types of software packages:

Possible values	Types of software packages
0	Generic
1	SXP
2	PIF
3	PKG
4	MSI
5	PALM
6	WINCE
7	RPM
8	Nokia
9	DebWrap

xsd:string userParams: Specifies a string value that contains the user-defined parameters for the given software job unit.
xsd:string unitHostUUID: Specifies an agent-generated UUID which identifies the given unit.
Xsd:int packageformat: Specifies the whether package is regular (0) or Virtual (1).

WSChallengeResponse

This sequence of elements specifies the string and size of the authentication data along with the session ID returned by the Client Automation manager.

char *authenticationData: Specifies the authentication data
long size: Specifies the size of the authentication data
Char* SessionID: Specifies a unique session ID to use as an input parameter for all further calls to the web service.