Documentum Index Agent status via API

Run the following API to start, shut down and check the status:

API> apply,c,NULL,FTINDEX_AGENT_ADMIN,NAME,S,<index_name of your dm_fulltext_index>,AGENT_INSTANCE_NAME,S,<object_name of your dm_ftindex_agent_config>,ACTION,S,start

Where:

<index_name of your dm_fulltext_index> can be found using:

API> retrieve,c,dm_fulltext_index

API> get,c,l,index_name

and

<object_name of your dm_ftindex_agent_config> can be found using:

API> retrieve,c,dm_ftindex_agent_config

API> get,c,l,object_name

Sample:
apply,c,NULL,FTINDEX_AGENT_ADMIN,NAME,S,QDMSDEV_ftindex_01,AGENT_INSTANCE_NAME,S,PLETSG0087_IndexAgent1,ACTION,S,shutdown
...
q0
API> apply,c,NULL,FTINDEX_AGENT_ADMIN,NAME,S,QDMSDEV_ftindex_01,AGENT_INSTANCE_NAME,S,PLETSG0087_IndexAgent1,ACTION,S,status
...
q1
API> next,c,q1
...
OK
API> get,c,q1,status
...
100

 

API> apply,c,NULL,FTINDEX_AGENT_ADMIN,NAME,S,QDMSDEV_ftindex_01,AGENT_INSTANCE_NAME,S,PLETSG0087_IndexAgent1,ACTION,S,start
...
q2
API> apply,c,NULL,FTINDEX_AGENT_ADMIN,NAME,S,QDMSDEV_ftindex_01,AGENT_INSTANCE_NAME,S,PLETSG0087_IndexAgent1,ACTION,S,status
...
q3
API> next,c,q3
...
OK
API> get,c,q2,status
...
0

Results:

100 - Means that the Index Agent has been shut down.

0 - Means that the Index Agent is up and running.

200 - Means that there is a problem with the Index Agent.