ft_remove_tenant - Fluid Topics - 3.3 - Technical Notes

Fluid Topics Scripts

Fluid Topics
Fluid Topics Version
Technical Notes
Target Audience

The ft_remove_tenant script is used to completely remove a specific Fluid Topics tenant from the server.

This command will remove all PaFs for the specified tenant.

Once the ft_remove_tenant script has completed, restart the Update Manager using the following command:

/etc/init.d/afs_updatemanager restart

Command template:

ft_remove_tenant -s $SERVICE_ID -S $SERVICE_STATUS [-H $BACK_OFFICE_HOSTNAME] [-https] [--port $WEBSERVER_PORT] [--ws-login WS_LOGIN] [--ws-password [WS_PASSWORD]] [--api-key API_KEY] [-sh $SSH_HOSTNAME] [-su $SSH_USERNAME] [--mongo-host $MONGO_HOSTNAME] [--mongo-port $MONGO_PORT] [-v] [-h]

Command example:

ft_remove_tenant -s 8 -S stable -H Fluid_BackOffice --ws-login mylogin --ws-password mypassword

Command arguments:

  • -s: Expects the service ID used to identify the tenant. Can also be written --service.
  • -S: Expects the service status used to identify the tenant among the following list:
    • stable
    • rc
    • beta
    • alpha
    • sandbox
    • archive
  • -H: Expects the hostname of the Back Office server ("localhost" by default if the command is run on the server hosting the Back Office environment). Can also be written --host.
  • -https: Enables the use of HTTPS protocol. Can also be written --secure.
  • --port: Expects the port number used to access the Back Office server.
  • --ws-login: Expects the login of the user authorized to launch the web service (by default, "antidot").
  • --ws-password: Expects the password of the user authorized to launch the web service (by default, it is the default password of the "antidot" Back Office user).
  • --api-key: Expects the API key of the Back Office user.
  • -sh: Expects the SSH server host name. This argument must be specified to run remotely. Can also be written --ssh-host.
  • -su: Expects the SSH user name. Can also be written --ssh-user.
  • --mongo-host: Expects the MongoDb server host name. Defaults to localhost.
  • --mongo-port: Expects tje MongoDb port number. Defaults to 27017.
  • -v: Activates the verbose mode. Can also be written --verbose.

  • -h: Displays the help and lists all available optional arguments for the command. Can also be written --help.

The script is available in the antidot-fluidtopics-reply package.