269. Squid

269.1. Authors

    269.2. Summary of Module Globals

    List of Global Functions

    • ACLIsUsedBy - Returns list of options which use this ACL (identified by id_item). It's necessary to run this function before deleting ACL to know if any options are not affected.

    • Abort - Abort function

    • Export - Dump the squid settings to a single map (For use by autoinstallation.)

    • GetHttpPortsOnly - Returns only list of configured ports (no hosts and so on)

    • Import - Get all squid settings from the first parameter (For use by autoinstallation.)

    • IsServiceRunning - Returns true if Squid service is running.

    • NumACLs - Returns number of occurences of ACL (definition lines) in config file.

    • NumACLsByName - Same as NumACLs but ACL is identified by name.

    • Read - Read all squid settings

    • StartService - Start Squid service if not running otherwise reload. Returns true if squid was successfuly started

    • StopService - Stop Squid service. Returns true if squid was successfuly stopped

    • Summary - Create a textual summary and a list of unconfigured cards

    • Write - Write all squid settings

    List of Global Variables

    • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

    269.3. Global Functions

    269.3.1. ACLIsUsedBy

    Returns list of options which use this ACL (identified by id_item). It's necessary to run this function before deleting ACL to know if any options are not affected.

    Function parameters

    • integer id_item

    Return value

    • list<string>

    269.3.2. Abort

    Abort function

    Return value

    • boolean - return true if abort

    269.3.3. Export

    Dump the squid settings to a single map (For use by autoinstallation.)

    Return value

    • map - Dumped settings (later acceptable by Import ())

    269.3.4. GetHttpPortsOnly

    Returns only list of configured ports (no hosts and so on)

    Return value

    • list<string>

    269.3.5. Import

    Get all squid settings from the first parameter (For use by autoinstallation.)

    Function parameters

    • map sett

    Return value

    • boolean - True on success

    269.3.6. IsServiceRunning

    Returns true if Squid service is running.

    Return value

    • boolean

    269.3.7. NumACLs

    Returns number of occurences of ACL (definition lines) in config file.

    Function parameters

    • integer id_item

    Return value

    • integer

    269.3.8. NumACLsByName

    Same as NumACLs but ACL is identified by name.

    Function parameters

    • string name

    Return value

    • integer

    269.3.9. Read

    Read all squid settings

    Return value

    • boolean - true on success

    269.3.10. StartService

    Start Squid service if not running otherwise reload. Returns true if squid was successfuly started

    Return value

    • boolean

    269.3.11. StopService

    Stop Squid service. Returns true if squid was successfuly stopped

    Return value

    • boolean

    269.3.12. Summary

    Create a textual summary and a list of unconfigured cards

    Return value

    • list - summary of the current configuration

    269.3.13. Write

    Write all squid settings

    Return value

    • boolean - true on success

    269.4. Global Variables

    269.4.1. write_only

    Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

    269.5. Module Requirements

    269.5.1. Module Imports

    • FileUtils
    • Message
    • Progress
    • Report
    • Service
    • SuSEFirewall
    • Summary
    • Summary

    269.5.2. Module Includes