Bash-script-framework - Revision history

Chubbard at 23:04, 15 October 2021

2021-10-15T23:04:36Z

← Older revision		Revision as of 16:04, 15 October 2021
Line 137:		Line 137:
	done		done
	</pre>		</pre>
			[[Category:bash]]

Chubbard at 23:02, 15 October 2021

2021-10-15T23:02:36Z

← Older revision		Revision as of 16:02, 15 October 2021
Line 1:		Line 1:
			====Bash File header====
	<pre>		<pre>
	#!/bin/bash		#!/bin/bash

Chubbard at 23:02, 15 October 2021

2021-10-15T23:02:03Z

← Older revision		Revision as of 16:02, 15 October 2021
Line 49:		Line 49:
	}		}
	</pre>		</pre>
	====Logging framework====		====Basic JSON Logging framework====
	<pre>		<pre>
	logger() {		logger() {
Line 120:		Line 120:
	echo "\"$(date -u +%FT%H:%M:%S.%3N)\": [[\"${LOGGING}\", \"$(hostname)\", \"${APP_NAME}\", \"$$\", \"${CONTEXT1}\"], {\"Event\":\"${MESSAGE}\"}]" >> ${LOGFILE}		echo "\"$(date -u +%FT%H:%M:%S.%3N)\": [[\"${LOGGING}\", \"$(hostname)\", \"${APP_NAME}\", \"$$\", \"${CONTEXT1}\"], {\"Event\":\"${MESSAGE}\"}]" >> ${LOGFILE}
	echo '}' >> ${LOGFILE}		echo '}' >> ${LOGFILE}
			}
			# Fatal errors follow the endlog function
			fatal() {
			endlog $[@]
	}		}
	</pre>		</pre>

Chubbard at 22:58, 15 October 2021

2021-10-15T22:58:51Z

← Older revision		Revision as of 15:58, 15 October 2021
Line 50:		Line 50:
	</pre>		</pre>
	====Logging framework====		====Logging framework====
			<pre>
	logger() {		logger() {
	if [ ! -e ${canonicaldirname}/logs ];then		if [ ! -e ${canonicaldirname}/logs ];then

Chubbard at 22:58, 15 October 2021

2021-10-15T22:58:14Z

@@ Line 22: / Line 22: @@
 ====Use function====
 <pre>
 usage (){
 cat << EOF
@@ Line 39: / Line 33: @@
 EOF
+}
 </pre>

Chubbard: Created page with "

 #!/bin/bash #=============================================================================== # #          FILE:  FILENAME.sh #  #         USAGE:  ./FILENAME.sh < options..."

2021-10-15T22:47:23Z

Created page with "<pre> #!/bin/bash #=============================================================================== # # FILE: FILENAME.sh # # USAGE: ./FILENAME.sh < options..."

New page

<pre>
#!/bin/bash
#===============================================================================
#
# FILE: FILENAME.sh
#
# USAGE: ./FILENAME.sh < options >
#
# REQUIREMENTS: ifconfig snmptrap tr sed awk
# AUTHOR: Christopher S. Hubbard (), chubbard@iwillfearnoevil.com
# COMPANY: I Will Fear No Evil DOT com
# VERSION: 2.0.1
# CREATED: 02/18/2011 06:49:51 PM PST
# REVISION: Mary
#===============================================================================
</pre>
; Details
: Revision starts at the letter A and goes through M
: Version starts at 0.0.1 and increments when major changes happen
: Requirements are what should be validated before running the script

====Use function====
<pre>
#=== FUNCTION ================================================================
# NAME: usage
# DESCRIPTION: how to use the !@#$ script correctly
# PARAMETERS: None
# RETURNS: stdout and exit
#===============================================================================
usage (){
cat << EOF
Usage: $0 options

Options:
-h show this help screen
-x enable debug mode

example:

EOF
}
</pre>
====Getopts framework====
<pre>
while getopts "hx" OPTION; do
case ${OPTION} in
h) usage; exit 0 ;;
x) export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'; set -v ;set -x ;;
*) echo "Status FATAL - Unexpected arguments given. Try -h. Used $@"; exit 2 ;;
esac
done
</pre>