Skip to main content

List operations

List Computers

Lists computer objects from the target system.

Signature: listcomputers(cinfo, resourceType)

Parameters:

  • resourceType - The type of computer objects that should be listed

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

Remarks:

The agent.addComputer callback should be used to return the computer objects. Refer to agent.addComputer callback for full details

List Groups

Lists groups from the target system.

Signature: listgroups(cinfo, wantMembers)

Parameters:

  • wantMembers - Boolean flag to indicate if members should be listed

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

Remarks:

The agent.addGroup callback callback should be used to return the groups listed during this operation. Refer to agent.addGroup callback for full details.

List Member Method

Indicates if members will be listed while listing users or while listing groups

Signature: listmembersmethod()

Return Value:

  • 1 - If members will be listed during group listing

  • 2 - If members will be listed during user listing

Remarks:

Generally when creating custom Python integrations member information will be listed with the listgroups operation. For certain targets the membership information is provided alongside the user information instead of the group information, this function indicates during which operation memberships should be listed.

If this function is not implemented it will be assumed members will be listed during group listing.

List Subscribers

Lists objects that rely on user credentials, which should be updated when the user's password is changed

Signature: listsubscribers(cinfo, resourceType)

Parameters:

  • resourceType - The type of subscriber objects that should be listed

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

Remarks:

The agent.addSubscriber callback should be used to return the subscriber objects. Refer to agent.addSubscriber callback for full details.

List Users

Lists users from the target system

Signature: listusers(cinfo, wantGroups, wantAttributes)

Parameters:

  • cinfo['listattributes'] - Collection of attributes to be listed

  • wantGroups - Boolean flag to indicate if memberships should be listed

  • wantAttributes - Boolean flag to indicate if attributes should be listed for users

Return Value:

  • ACSuccess 0

  • ACUnknownError 1

Remarks:

The agent.addAccount callback should be used to return the accounts listed during this operation. Refer to agent.addAccount callback for full details.

For listing attributes if wantAttributes is false, no attributes should be listed. If wantAttributes is true the attributes specified in cinfo['listattributes'] should be listed. If cinfo['listattributes'] is empty and wantAttributes is true all attributes should be listed.