You can manage the Fanout agent by using the scripts from the Fanout agent installation directory. Table 3-1 lists the commands to manage the Fanout agent. To view the help, invoke the command with -–help option.
Table 3-1 Commands to Manage the Fanout Agent
Command |
Description |
Usage |
---|---|---|
startAgent |
Starts the Fanout agent instance |
startAgent –config startAgent –config <FanoutAgent Installation Location>/config/fanoutagent-config.properties |
stopAgent |
Stops the Fanout Agent instance |
stopAgent -config stopAgent –config <FanoutAgent Installation Location>/config/fanoutagent-config.properties netiq |
getservices |
Fetches the status of the JDBC driver instances loaded by the Fanout agent and writes the status to a file. |
getServices –config <FanoutAgent Installation Location>/config/fanoutagent-config.properties 0 ./services.txt netiq |
startService |
Starts the specified JDBC driver instance. You can get the JDBC driver instance name from the output file generated by the getServices command. |
startService –config <FanoutAgent Installation Location>/config/fanoutagent-config.properties serviceName netiq |
stopService |
Stops the specified JDBC driver instance. You can get the JDBC driver instance name from the output file generated by the getServices command. |
stopService –config <FanoutAgent Installation Location>/config/fanoutagent-config.properties serviceName netiq |
setPassword |
Sets the agent and shim passwords for the Fanout agent instance. |
setPassword -config <FanoutAgent Installation Location>/config/fanoutagent-config.properties netiq microfocus netiq microfocus |
setAMQKSPassword |
Sets the Keystore password used for mutual authentication with ActiveMQ when SSL is enabled |
setAMQKSPassword -config <FanoutAgent Installation Location>/config/fanoutagent-config.properties netiq microfocus |
setAMQTSPassword |
Sets the Truststore password used for mutual authentication with ActiveMQ when SSL is enabled. |
setAMQTSPassword -config <FanoutAgent Installation Location>/config/fanoutagent-config.properties netiq microfocus |
setKSPassword |
Sets the keystore password for the Fanout command server. |
setKSPassword -config <fanoutagent-config.properties in the FanoutAgent Installation Location> <type 1 or type 2> <keystore or key in the keystore password> <agent password> where type 1 specifies the keystore password and type 2 specifies the key password in the keystore. Examples:
|
setConfig |
Changes the configuration options as specified in the input file. NOTE:Stop the agent before changing netiq.fanoutagent.trace.level, netiq.fanoutagent.cmd.srv.ip, netiq.fanoutagent.cmd.srv.port,and netiq.fanoutagent.cmd.allow.http parameters and then restart the agent for the changes to take effect. |
setConfig -config <FanoutAgent Installation Location>/config/fanoutagent-config.properties ./sample_cfg.json netiq |
setEncryptionKey |
Sets the encryption key. You can use this key to encrypt or decrypt ActiveMQ messages. |
setEncryptionKey -config config/fanoutagent-config.properties netiq netiq |
fanoutMigration |
Migrates the Fanout agent files from the existing location to the new installation location of the agent. Use this command to migrate the agent version 1.0 to 1.1 shipped with Identity Manager 4.6. |
fanoutMigration <existing location of the Fanout agent> For information about how this command is used, see Migrating the Fanout Agent Configuration. |