Web Services Reference › Methods › Units and Groups › Units › OpenUnitUnitSoftwareJobList

OpenUnitUnitSoftwareJobList

The OpenUnitUnitSoftwareJobList opens a list of software jobs associated with a given unit.

Parameters

xsd:string sessionId (^m)

The session identifier.

xsd:string unitId (^m)

The UUID identifying the unit whose software jobs are to be listed.

UnitSoftwareJobPropertiesRequired unitSoftwareJobPropertiesRequired (^m)

The properties that will be required when getting an individual software job from the list.

Return Values

xsd:long OpenListHandle

A numeric handle to a list of software package installations that can be passed to GetUnitUnitSoftwareJobs

xsd:long totalNoOfUnitSoftwareJobs

The total number of software jobs in the list whose handle has been returned.

Remarks

This method returns the size of the list, and a handle to the list that can be used with the GetUnitUnitSoftwareJobs method.

More information:

UnitSoftwareJobPropertiesRequired

GetUnitSoftwareJobList

The GetUnitSoftwareJobList method retrieves the list of software jobs deployed on a unit. This method is supported only on the domain manager.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string unitId

Specifies the UUID of the unit for which you want to the installations list.

dsm:UnitSoftwareJobPropertiesRequired unitSoftwareJobPropertiesRequired

Specifies the properties that want to get from each installation in the list.

Xsd:long index

Specifies the starting index for the list.

xsd:long numJobsRequired

Specifies the number of jobs to get from the list.

Return Values

Xsd:int totalNumJobs

Returns the total number of jobs in the list.

dsm:ArrayOfUnitSoftwareJobProperties3 arrOfUnitSoftwareJobProperties

Returns an array of UnitSoftwareJobProperties - one for each software package installation that are requested from the list.

Remarks

None

More information:

UnitSoftwareJobProperties3

ArrayOfUnitSoftwareJobProperties3

GetComputerOSName

The GetComputerOSName method returns the operating system name based on specified OS class ID.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osClassID

Specifies the class ID for which you want to retrieve the operating system name.

Return Values

xsd:string osName

Contains the operating system name for the specified class ID.

GetComputerByName

The GetComputerByName method retrieves the properties of the computer, identified by the host name specified.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string computerHostName

Specifies the host name of the computer to search for. You can include wildcard characters such as * and ?.

Xsd:long noOfComputers

Specifies the number of computers that must be returned from the search, if more than one match is found.

ComputerPropertiesRequired computerPropertiesRequired

Specifies the computer properties to be retrieved. This parameter is mandatory, if noOfComputers is greater than 0.

Return Values

ArrayOfComputerProperties computerArray

Includes an array of computer properties structures, one for each computer matched by the search. The size of this array is either the number of computers matched by the search or the number of computers specified in the noOfComputers parameter, whichever is the lowest.

xsd:long totalNoOfComputersFound

Includes the total number of computers that were matched by the search. This value indicates that there were more matches found than the requested number of computers.

Remarks

The method supports wildcard pattern matching for the computer hostname. The name is case insensitive. Use FindComputer API to search for computers using compute label. Use GetComputerByName API to search for computers using compute hostname.

GetHardWareModelList

The GetHardWareModelList method returns the distinct hardware models in the Client Automation environment.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ArrayOfHWModelFilter filterArray

Specifies the filter properties that are supported.

xsd:boolean sortAscending

Specifies whether you want to sort the list in ascending order.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

Xsd:long numRequired

Specifies the number of objects you want to retrieve from the startIndex position.

Return Values

dsm:ArrayOfstring hwModelList

Contains the distinct hardware models list.

GetComputerHWModel

The GetComputeHWModel method returns the hardware model for a list of computers identified by their UUID.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ArrayOfstring computeUUIDs (m)

Specifies the array of computer UUIDs, the hardware models of which you want to retrieve.

Return Values

dsm:ArrayOfstring hwModels

Contains the hardware models of the specified computers.

GetComputerHWModelByName

The GetComputeHWModelByName method returns the hardware model for a list of computers identified by host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ArrayOfstring computerHostNames (m)

Specifies the array of host names, the hardware models of which you want to retrieve.

Return Values

dsm:ArrayOfstring hwModels

Contains the hardware models of the specified computers.

GetComputerSDProperties

The GetComputerSDProperties method returns the software delivery related properties for a particular computer identified by UUID.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string computerUUID

Specifies the UUID of the computer.

Return Values

dsm: SDProperties props

Contains the software delivery properties of the computer.

GetComputerSDPropertiesByName

The GetComputerSDPropertiesByName method returns the software delivery related properties for a particular computer identified by hostname.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string computerName

Specifies the name of the computer.

Return Values

dsm: SDProperties props

Contains the software delivery properties of the computer.