Skip to main content

Listing callbacks

Add Account

Adds an account and it's information to the list file.

Signature: agent.addAccount('stableid', 'longid', 'shortid', attrsDict, groupsDict)

Parameters:

  • stableid - The ID for the account that cannot be changed

  • longid - The ID for the account that will be used to identify it in operations

  • shortid - The ID for the account that is human readable and will be displayed in the UI

  • attrsDict - Dictionary object of the attributes for the account

  • groupsDict - Dictionary object of the memberships for the account

Return Value:

Remarks:

This callback should only be used in the list users operation.

For the expected format on the dictionary objects see the definitions section for full details.

Add Computer

Adds a computer and it's information to the list file.

Signature: agent.addComputer('compid', 'desc', disabledStatus, attrsDict)

Parameters:

  • compid - The id of the computer object that will be used to identify it in operations

  • desc - The description for the computer that is human readable and will be displayed in the UI

  • disabledStatus - Boolean flag for if the computer is enabled or disabled

  • attrsDict - Dictionary object of the attributes for the computer object

Remarks:

This callback should only be used in the list computers operation

For the expected format on the dictionary objects see the definitions section for full details.

Add Group

Adds a group and it's information to the list file.

Signature: agent.addGroup('stableid', 'longid', 'shortid', attrsDict, ownersDict, membersDict)

Parameters:

  • stableid - The ID for the group that cannot be changed

  • longid - The ID for the group that will be used to identify it in operations

  • shortid - The ID for the account that is human readable and will be displayed in the UI

  • attrsDict - Dictionary object of the attributes for the group

  • ownersDict - Dictionary object of the owners for the group

  • membersDict - Dictionary object of the group's members

Remarks:

This callback should only be used in the list groups operation

For the expected format on the dictionary objects see the definitions section for full details.

Add Subscriber

Adds a subscriber and it's information to the list file.

Signature: agent.addSubscriber('subid', 'desc', disabledStatus, 'subacct', 'stableid', 'longid', 'shortid', 'securitydomain', attrsDict)

Parameters:

  • subid - The ID for the subscriber that will be used to identify it in operations

  • desc - The description for the subscriber that is human readable and will be displayed in the UI

  • disabledStatus - Boolean flag for if the subscriber is enabled or disabled

  • subacct - Long ID for the subscription account

  • stableid - Stable ID for the subscription account

  • longid - Long ID for the subscription account

  • shortid - The ID for the subscription account that is human readable and will be displayed in the UI

  • securitydomain - The security domain of the subscription account

  • attrsDict - Dictionary object of the attributes for the subscriber

Remarks:

This callback should only be used in the list subscribers operation

For the expected format on the dictionary objects see the definitions section for full details.

In this section: