billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

billmax-admin — BillMax server control interface.

Synopsis

/usr/local/billmax/bin/billmax-admin {[start] | [stop] | [restart]} [mysqld] [httpd] [samba] [httpd] [bmuid] [radmond]

/usr/local/billmax/bin/billmax-admin { nightly }

/usr/local/billmax/bin/billmax-admin { delete } {[-a number] | [-u number] | [-s number]} [-S] [-f] [-d] [-h]

DESCRIPTION

billmax-admin is a front end to BillMax. It is designed to help the administrator control the functioning of BillMax. You must be root and have System Admin Permissions to run billmax-admin. There are three modes in which to use billmax-admin. These modes may be used to:

  1. stop, start or restart BillMax controlled Daemons. If no optional arguments are given, all Daemons listed here that are listed in /usr/local/billmax/local/billmax.conf that have a value of YES are acted upon. If one or more optional arguments (mysqld, httpd, etc. ) are specified, the Daemons specified are acted upon regardless of their setting in /usr/local/billmax/local/billmax.conf.

    [Warning] Warning

    If using the start or restart options and a Daemon fails, all Daemons listed here that also are listed in /usr/local/billmax/local/billmax.conf with a value of YES are stopped.

  2. nightly executes a series of once-per-day tasks and sends the results via email to the admin and billing contacts for BillMax. Which tasks execute is controlled by options in /usr/local/billmax/local/billmax.conf. The following is a list of potential tasks:

    1. stop the BillMax controlled Daemons - Same as billmax-admin stop.

    2. Execute /usr/local/billmax/local/stop_hook (if any).

    3. Execute /usr/local/billmax/local/backup_hook (if any).

    4. Rotate BillMax logs.

    5. Back up the BillMax database (valid only if local MySQL database).

    6. Validate the database level integrity of datacall table on Sundays (all other database tables are checked on each start of the MySQL database if specified in /usr/local/billmax/local/billmax.conf.)

    7. start the BillMax controlled Daemons - Same as billmax-admin start.

    8. Execute /usr/local/billmax/local/start_hook (if any).

    9. Execute LOAD_DATACALL_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    10. Execute CLOSEOFDAY_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    11. Execute CCDAILY_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    12. Execute ECHDAILY_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    13. Execute MAKESTATEMENTS_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    14. Execute SENDSTATEMENTS_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    15. Execute BALCHECK_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    16. Execute DBCK_PROG specified in /usr/local/billmax/local/billmax.conf if enabled.

    17. mail nightly.log to config.acemail and config.bcemail where config.number is 1.

    Output from all the processes are written to /usr/local/billmax/logs/nightly.date.log where date is the date that billmax-admin is run.

    Under a typical BillMax setup, BillMax will be unavailable during nightly processing while the database access is halted and the database is being backed up.

    Intended usage is for billmax-admin nightly to be run using Cron.

    Example 1. Typical crontab(8) entry

    0 0 * * * root /usr/local/billmax/bin/billmax-admin nightly

    This will execute billmax-admin nightly at 12:00 a.m. every evening. Although 12:00 a.m. is not a requirement, reasons to choose 12:00 a.m. are:

    • Avoid issues with the Daylight Savings Time.

    • Have overnight processing completed before regular working hours.


  3. Deletes either an Account (-a), User (-u), or Service (-s). If an Account is deleted, all associated data is deleted. If a User or Service is specified, then the User and Service(s) can only be deleted if there are no summarized financial transactions belonging to that User or Service. Default behavior is to list information about records that are to be deleted and ask the user if they want to continue by means of a verification prompt. If the user indicates to continue, the Account, User or Service is changed to the Closed State. This executes the relevant BillMax Hooks. The Account, User or Service is deleted.

OPTIONS - valid only for the delete directive

-a number

The number of the Account to be deleted.

-u number

The number of the User to be deleted.

-s number

The number of the Service to be deleted.

-d

"Dryrun" mode. Under this mode nothing is deleted, but what would be deleted is shown. (-f, -S, and -n may be specified but are not effective when using -d).

-f

"Force" mode. The user does not get a verification prompt. This mode also ignores errors associated with de-Provisioning.

-n

The Account, User or Service are NOT changed to the Closed State. This has the effect of NOT running the relevant BillMax Hooks.

-S

"Silent" mode. Only a verification prompt (if -f not specified) is printed.

RETURN VALUE

0 for success.

NOTES

NONE

SEE ALSO

NONE


Document Revision A for BillMax 2.2.0   -   Copyright © 1997-2006 The iSpark Group, Inc.

All rights reserved. No part of this documentation may be reproduced or transmitted in any fashion without written permission by The iSpark Group, Inc. This documentation is for the sole use of licensees of the BillMax billing software created by The iSpark Group, Inc. Making the documentation available to a non-licensee of BillMax without written permission of The iSpark Group, Inc. is a violation of the use of this documentation.

While precautions have been taken in the preparation of this documentation, The iSpark Group, Inc. assumes neither liability nor responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

All terms mentioned that are known to be trademarks have been appropriately capitalized. Use of the a trademark does not affect the validity of any trademark or service mark.

Links to third-party Web sites are provided for convenience. The iSpark Group, Inc. is not responsible for any content contained in the third-party Web sites.

Comments about this documentation may be sent to doc@billmax.com