Previous Topic: DeleteItemsNext Topic: Unit Inventory


MoveItemsToUnitGroup

This method moves an item from one unit group to another.

Parameters
xsd:string sessionId

Session Id. got from the login to the web service.

xsd:string oldGroupUuid

The uuid of the group to which the items are initially linked

xsd:string newGroupUuid

The uuid of the group to which the items need to be moved.

dsm:ArrayOfItems moveItems

Array of item UUIDs to be moved.

Return Values

None.

GetUnitGroupComputerMembers2

The GetUnitGroupComputerMembers2 method fetches the computers from a unit groups member list.

Parameters

xsd:string sessionId

Specifies the session identifier.

xsd:long listHandle

Specifies the numeric handle to a list returned by a previous call to OpenUnitGroupComputerMembersList2.

xsd:long noOfComputers

Specifies the total number of computers to fetch from the list. This is less than or equal to the total number in the list returned by a previous call to OpenUnitGroupComputerMembersList2.

Return Values

dsm:ArrayOfComputerProperties2 GetUnitGroupComputerMembersReturn

Specifies an Array of ComputerProperties. One for each computer requested from the list.

Remarks

You can make multiple calls to GetUnitGroupComputerMembers2 to iterate down the list.

OpenUnitGroupComputerMembersList2

The OpenUnitGroupComputerMembersList2 method fetches a list of the computers that are members of the given unit group.

This method returns the total number of computers in the list and a handle to the list that can be used for further calls to GetUnitGroupComputerMembers2.

Parameters

xsd:string sessionId

Specifies the session identifier.

xsd:string unitGroupId

Specifies the UUID of the unit group member computers to be listed.

dsm:ArrayOfComputerPropertyFilter2 computerPropertyFilters

Specifies an Array of computer property filter definitions to limit the computers returned by the search.

xsd:boolean matchAll

Specifies the condition on the filter properties.

dsm: ComputerProperty2 sortProperty

Specifies the Computer property on which sorting takes place.

xsd:bool ascending

Specifies sorting in an ascending order.

dsm:ComputerPropertiesRequired2 computerPropertiesRequired (m)

Specifies the properties required to get a computer from the list.

Return Values

xsd:long OpenListHandle

Specifies the numeric handle to a list of unit groups that can be passed to GetUnitGroupComputerMembers2.

xsd:long totalNoOfComputers

Specifies the total number of computers in the list whose handle has been returned.

Remarks

None

GetUnitGroupComputerMembers3

The GetUnitGroupComputerMembers3 method fetches the computers in a unit groups member list from a specified index number.

Parameters

xsd:string sessionId

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

xsd:long listHandle

Specifies the numeric handle to a list returned by a previous call to OpenUnitGroupComputerMembersList2.

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 noOfComputers

Specifies the number of objects you want to retrieve from the startIndex position. This number must be less than or equal to the total number in the list returned by a previous call to OpenUnitGroupComputerMembersList2.

Return Values

dsm:ArrayOfComputerProperties2 GetUnitGroupComputerMembersReturn

Specifies an Array of ComputerProperties. One for each computer requested from the list.

Remarks

You can make multiple calls to GetUnitGroupComputerMembers3 to iterate down the list. You must call the CloseUnitGroupComputerMembersList method to close the list.

GetUnitGroupByName

The GetUnitGroupByName method retrieves the properties of a specified unit group, identified by its name.

Parameters

xsd:string sessionId

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

Xsd:string unitGroupName

Specifies the name of the unit group, the properties of which you want to retrieve.

dsm:ObjectPreference objectPreference

Specifies whether the group must be a local or replicated group, or either of the two.

dsm: UnitGroupPropertiesRequired unitGroupPropertiesRequired

Specifies the group properties you want to retrieve.

Return Values

dsm: UnitGroupProperties GetUnitGroupReturn

Contains the unit group properties retrieved.

Remarks

None

GetUnitGroupsXML

The GetUnitGroupsXML method returns the Client Automation computer groups in an XML tree.

Parameters

xsd:string sessionId

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

Xsd:string parentGroup

Specifies the root group for which you need the xml tree. Specify NULL to return all the computer groups.

xsd:string excludeGroupName

Specifies the group name to be excluded from the XML, if any. The subgroups under the specified group are also excluded.

xsd:boolean excludeSystemGroups

Specifies whether you want to exclude system groups such as All Computers, All User Accounts, and All User Profiles.

Return Values

xsd: string groupsXML

Returns the computer groups XML as a string.