Using the agt_service utility

The Replication Agent agt_service utility is only applicable to Windows environments and can be used to:

• Create a Windows Service to run a specified Replication Agent instance

• Remove a Windows Service instance running a Replication Agent instance

• Start a Windows service, thereby starting the corresponding Replication Agent instance

• Stop a Windows service, thereby stopping the corresponding Replication Agent instance

To run the agt_service utility, invoke it as a command at the operating system prompt.

agt_service[.cmd] 
[-install inst_name [-startup state] [-charset charset] [-maxmem mem] ] | 
[-remove inst_name ] | 
[-start inst_name ] |
[-stop inst_name ] |
[-h]

-install inst_name

• The option that specifies a Replication Agent instance for which to create a Windows service. Here, inst_name is the name of an existing Replication Agent instance.

-startup state

• The (optional) keyword that specifies a start-up state for the Replication Agent instance.

  Valid -startup state values are:

  • -admin – starts the Replication Agent instance in Admin state. (This is the default start-up state.)

  • -replicate – starts the Replication Agent instance in Replicating state.

-charset charset

• The (optional) Java character that the JVM will use. This option corresponds to the RA_JAVA_DFLT_CHARSET environment variable.

-maxmem mem

• The (optional) maximum amount of memory that this Replication Agent instance will use. This option corresponds to the RA_JAVA_MAX_MEM environment variable.

-remove inst_name

• The option that specifies a Replication Agent instance for which to remove a Windows service. Here, inst_name is the name of an existing Replication Agent instance.

-start inst_name

• The option that specifies a Replication Agent instance for which to start a Windows service. Here, inst_name is the name of an existing Replication Agent instance.

-stop inst_name

• The option that specifies a Replication Agent instance for which to stop a Windows service. Here, inst_name is the name of an existing Replication Agent instance.

-h

• The option that returns command usage information.

To create a Windows service for a Replication Agent instance named “my_ra” in Replicating state, enter the following command at the operating system prompt:

agt_service -install my_ra -startup replicate

To remove a Windows service for a Replication Agent instance named “my_ra”, enter the following command at the operating system prompt:

agt_service -remove my_ra

To start a Windows service for a Replication Agent instance named “my_ra”, enter the following command at the operating system prompt:

agt_service -start my_ra

To stop a Windows service for a Replication Agent instance named “my_ra”, enter the following command at the operating system prompt:

agt_service -stop my_ra