Functions in Bash

# CHAPTER 7

Functions in Bash #

1. Introduction #

2. Learning Objectives #

• Define and execute a basic function within a Bash script.

• Pass external parameters (arguments) into a function using $1, $2.

• Secure variable data by defining local variables inside functions.

• Utilize the return command to send exit status codes back to the main script.

• Understand how to build modular, reusable utility scripts.

3. Defining and Calling a Function #

Syntax:

#!/bin/bash

# 1. Define the function
print_greeting() {
    echo "================================"
    echo "   WELCOME TO THE SERVER TOOL   "
    echo "================================"
}

# 2. Call the function by its name
print_greeting

When Bash reaches the bottom line and sees print_greeting, it pauses, jumps up to the function, runs the three echo commands, and then jumps back down to continue the script.

4. Passing Arguments to Functions #

#!/bin/bash

# Define the function
create_user() {
    echo "Creating user account for: $1"
    echo "Assigning to department: $2"
}

# Call the function and pass two arguments
create_user "Alex" "Engineering"
create_user "Sarah" "Finance"

*Notice how we wrote the echo logic once, but processed two completely different users!*

5. Local Variables (Protecting Data) #

To fix this, you MUST declare variables inside functions as local.

#!/bin/bash
CITY="New York"

change_city() {
    # This variable only exists inside this function
    local CITY="London"
    echo "Inside function, city is: $CITY"
}

change_city
echo "Outside function, city is: $CITY"

# Output:
# Inside function, city is: London
# Outside function, city is: New York

6. Return Values (Exit Codes) #

• return 0 means SUCCESS.

• return 1 (or higher) means FAILURE.

#!/bin/bash

check_root() {
    if [ "$USER" == "root" ]; then
        return 0  # Success
    else
        return 1  # Failure
    fi
}

# Call the function, then check the secret $? variable
check_root
if [ $? -eq 0 ]; then
    echo "You are an admin."
else
    echo "Error: Must be run as root."
fi

7. Diagrams/Visual Suggestions #

8. Best Practices #

• Function Naming Conventions: Always name your functions with descriptive verbs (e.g., verifynetwork, installpackages, backupdatabase). A well-written script should read like an English book when you look at the bottom where the functions are called.

• Calling a function before defining it: Bash reads files sequentially from top to bottom. If you write printgreeting on line 5, but you don't define the print_greeting() {} block until line 20, the script will crash immediately with a "Command Not Found" error on line 5. Always place your definitions at the top!

10. Mini Project: The Logger Utility #

1. 1. nano logger.sh

1. 2. Write the code:

#!/bin/bash

LOG_FILE="/tmp/script_output.log"

# Define the utility function
log_message() {
    local MESSAGE=$1
    local TIMESTAMP=$(date +"%Y-%m-%d %H:%M:%S")
    
    # Print to screen AND append to the file
    echo "[$TIMESTAMP] $MESSAGE"
    echo "[$TIMESTAMP] $MESSAGE" >> $LOG_FILE
}

# Main Script Logic
log_message "Script execution started."
log_message "Connecting to database..."
# ... pretend database work happens here ...
log_message "Script execution completed successfully."

1. 3. Run it, then type cat /tmp/scriptoutput.log. You just built a professional-grade logging engine in 5 lines of reusable code!

• Q: Walk me through the exact syntax required to define a function named checkping, pass an IP address to it as an argument, and return a 0 if the ping succeeds or a 1 if the ping fails.

14. FAQs #

15. Summary #

16. Next Chapter Recommendation #