flushPool (Flush a SAM pool)

Flushes the SAM pool. This ensures that user IDs returned from this point on are fresh and not already logged in.

You may want to periodically request your IDs to start new sessions due to memory overconsumption. You may also want to request IDs to update their view of the database if a table or set of tables have been updated. In these cases, you can use flushPool.

flushPool terminates all sessions once they have been released back into the pool. It will not terminate any allocated or busy sessions.

The SAM pool group owner and the admin of the owner's company can call flushPool. This command does not actually log in the requesting ID.

The flushPool function takes the following parameters:
  • The URL of the 1010 gateway (url)
  • Group owner name (owner)
  • Group owner password (password)
  • Group ID (group)
  • Path to a log file (logfile) - The default value is None.
  • Mode (not sure)
py1010.flushPool(gateway, owner, password, group, logfile, mode)