GetStatus

Shows status information for all repositories, or a specified repository.

Example

http://12.3.4.56:3057/action=GetStatus

This action uses port 3057 to request details about the group server which is located on a machine with the IP address 12.3.4.56.

Parameters

Parameter Description Required
EncryptResponse Encrypt the output.  
FileName The file to write output to.  
ForceTemplateRefresh Forces the server to load the template from disk.  
Output Writes output to a file.  
Redirected Allows the query to be performed against the repository.  
Repository Restricts the repository details to one repository.  
Stats Displays statistics about the datastore.  
Template The template to use for the action output.  
TemplateParamCSVs A list of variables to use for the specified template.  

Response

An example GetStatus response:

<autnresponse>
   <action>GETSTATUS</action>
   <response>SUCCESS</response>
   <responsedata>
      <ProductName>Omni Group Server</ProductName>
      <Version>3.0.0.0</Version>
      <Build>88764</Build>
      <Repository>
         <ProductName>LDAP Group Server</ProductName>
         <ProductVersion>10.8.0</ProductVersion>
         <ProductBuild>1</ProductBuild>
         <Name>LDAP</Name>
         <Library>ogs_ldap</Library>
         <DataStore>DBs\LDAP.db</DataStore>
         <UserCount>16</UserCount>
         <GroupCount>86</GroupCount>
         <MembershipCount>82</MembershipCount>
         <QueueSize>0</QueueSize>  
      </Repository>
      <Repository>
         <ProductName>Text Group Server</ProductName>
         <ProductVersion>10.8.0</ProductVersion>
         <ProductBuild>1</ProductBuild>
         <Name>TEXT</Name>
         <Library>ogs_text</Library>
         <DataStore>DBs\TEXT.db</DataStore>
         <UserCount>24</UserCount>
         <GroupCount>58</GroupCount>
         <MembershipCount>66</MembershipCount>
         <QueueSize>0</QueueSize>
      </Repository>
      <Repository>
         <Name>COMBINE</Name>
         <Sections>LDAP,LEXT</Sections>
         <DataStore>DBs\COMBINE.db</DataStore>
         <UserCount>32</UserCount>
         <GroupCount>144</GroupCount>
         <MembershipCount>192</MembershipCount>
         <QueueSize>0</QueueSize>
      </Repository>
   </responsedata>
</autnresponse>

The response can show the following information for each repository:

Response Field Description
Name The name of the repository, as configured in the OmniGroupServer configuration file.
Sections A list of configuration file sections that configure the task (as specified by GroupServerSections).
Library The name of the library being used.
DataStore The path to the datastore file that contains the user and group information.
UserCount The number of users stored in the repository.
GroupCount The number of groups stored in the repository.
MembershipCount

The total number of membership relationships between users and groups or between pairs of groups.

TIP: Nested group memberships are counted. For example, if Group1 is a member of Group2 which is a member of Group3, then there are three relationships including Group1 being a member of Group3.

However, if User1 is a member of Group2 which is a member of Group3, the count does not include User1 being a member of Group3.

QueueSize The number of updates that have not yet been committed to the datastore. The number of updates might not match the number of users, groups, or memberships, because multiple operations may be required for a single user or group update.

Unless you set the action parameter Stats to FALSE, the response also includes the status of each repository:

<responsedata>
  ...
  <Repository>
    ...
    <Statuses>
      <Status timestamp="2018-Jan-23 16:52:17.638000">Finished</Status>
      <Status timestamp="2018-Jan-23 16:51:08.146000">Started</Status>
    </Statuses>
  </Repository>
</responsedata>

The Status elements are sorted newest to oldest. The number of entries is limited by the configuration parameter GroupServerStatusLimit. The statuses are:

Status Description
Started A job has started.
ConnectorStarted OmniGroupServer has sent the SynchronizeGroups action to a connector.
ImportStarted OmniGroupServer has received and started processing an Import request for this repository.
Failed A job failed.
ImportFailed A failure occurred while processing an Import request.
ConnectorFailed A SynchronizeGroups job failed to be scheduled.
ImportFinished An Import request finished successfully. This would also be the result of a completed SynchronizeGroups action from a connector.
Finished A job completed successfully.