Encap.txt/get-encap - Revision history

KI5QKX: mw push

2026-04-30T18:52:29Z

mw push

← Older revision		Revision as of 18:52, 30 April 2026
Line 80:		Line 80:
	allZero "${PIPESTATUS[@]}" \|\| exit $?		allZero "${PIPESTATUS[@]}" \|\| exit $?
	</nowiki>		</nowiki>


	[[Category:Reference]]		[[Category:Reference]]
	[[Category:Infrastructure]]		[[Category:Infrastructure]]

KI5QKX: mw push

2026-03-01T00:14:22Z

mw push

← Older revision		Revision as of 00:14, 1 March 2026
Line 83:		Line 83:

	[[Category:Reference]]		[[Category:Reference]]
			[[Category:Infrastructure]]

KI5QKX: mw push

2026-02-28T23:20:08Z

mw push

← Older revision		Revision as of 23:20, 28 February 2026
Line 1:		Line 1:
	Here's a bash script to get a complete [[encap.txt]] file from the ~~portal~~.		Here's a bash script to get a complete [[encap.txt]] file from the Portal.
	For example:		For example:

KI5QKX at 20:27, 12 December 2024

2024-12-12T20:27:06Z

← Older revision		Revision as of 20:27, 12 December 2024
Line 80:		Line 80:
	allZero "${PIPESTATUS[@]}" \|\| exit $?		allZero "${PIPESTATUS[@]}" \|\| exit $?
	</nowiki>		</nowiki>


			[[Category:Reference]]

W6JMK at 14:59, 19 October 2024

2024-10-19T14:59:00Z

← Older revision		Revision as of 14:59, 19 October 2024
Line 2:		Line 2:
	For example:		For example:

	.\get-encap < api-token.txt > encap.txt \|\| echo error $?		./get-encap < api-token.txt > encap.txt \|\| echo error $?

	The script maintains a cache, so it downloads the information only when it has changed.		The script maintains a cache, so it downloads the information only when it has changed.
Line 35:		Line 35:
	# ]		# ]
	# }		# }
	# ... but without ~~any~~ insignificant white space.		# ... but without insignificant white space.
	# We trust that any change will also change the serial value.		# We trust that any change will also change the serial value.

W6JMK: handle errors from jq

2024-10-15T19:42:57Z

handle errors from jq

← Older revision		Revision as of 19:42, 15 October 2024
Line 6:		Line 6:
	The script maintains a cache, so it downloads the information only when it has changed.		The script maintains a cache, so it downloads the information only when it has changed.

	<nowiki>		<nowiki>#!/bin/bash
	#!/bin/bash
	# Output the current AMPRNet routing information, like this:		# Output the current AMPRNet routing information, like this:
	# # Fetched <when> version <number> from <source>		# # Fetched <when> version <number> from <source>
Line 56:		Line 55:
	exit 1		exit 1
	elif [ -r "$cache" ]; then		elif [ -r "$cache" ]; then
	oldVersion=`jq ".serial" "$cache"` \|\| oldVersion="cache error $?"		oldVersion=`jq -e ".serial" "$cache"` \|\| oldVersion="cache error $?"
	[ "$oldVersion" == "null" ] && oldVersion="N/A" # != $newVersion		[ "$oldVersion" == "null" ] && oldVersion="N/A" # != $newVersion
	newVersion=$(		newVersion=$(
	echo "$curlOptions" \| curl --config - "$API"/encap/serial \| jq ".serial"		echo "$curlOptions" \| curl --config - "$API"/encap/serial \| jq -e ".serial"
	allZero "${PIPESTATUS[@]}" \|\| exit $?		allZero "${PIPESTATUS[@]}" \|\| exit $?
	) \|\| newVersion="API error $?"		) \|\| newVersion="API error $?"
Line 70:		Line 69:
	# Fetch new data from the API and store it in $cache:		# Fetch new data from the API and store it in $cache:
	newVersion=$(		newVersion=$(
	echo "$curlOptions" \| curl --config - "$API"/encap/routes \| tee "$cache" \| jq ".serial"		echo "$curlOptions" \| curl --config - "$API"/encap/routes \| tee "$cache" \| jq -e ".serial"
	allZero "${PIPESTATUS[@]}" \|\| exit $?		allZero "${PIPESTATUS[@]}" \|\| exit $?
	) \|\| exit $?		) \|\| exit $?
Line 76:		Line 75:
	# Convert $cache to the output format:		# Convert $cache to the output format:
	echo "# Fetched" `date -r "$cache"` version "$newVersion" from "$API" \|\| exit $?		echo "# Fetched" `date -r "$cache"` version "$newVersion" from "$API" \|\| exit $?
	jq -r '.encap[] \| select(.encapType == "IPIP") \| "route addprivate \(.network)/\(.cidr) encap \(.gatewayIP)"'\		jq -e -r '.encap[] \| select(.encapType == "IPIP") \| "route addprivate \(.network)/\(.cidr) encap \(.gatewayIP)"'\
	"$cache" \| sort		"$cache" \| sort
	# Sorting the output makes it easier to compare different versions.		# Sorting the output makes it easier to compare different versions.
	allZero "${PIPESTATUS[@]}" \|\| exit $?		allZero "${PIPESTATUS[@]}" \|\| exit $?
	</nowiki>		</nowiki>

W6JMK: Handle errors returned from the portal API

2024-10-15T19:14:09Z

Handle errors returned from the portal API

← Older revision		Revision as of 19:14, 15 October 2024
Line 46:		Line 46:
	}		}

	curlOptions="-H \"Authorization: Bearer $token\"		curlOptions="-s
			-S
			-f
			-H \"Authorization: Bearer $token\"
	-H \"Accept: application/json\"		-H \"Accept: application/json\"
	"		"
Line 56:		Line 59:
	[ "$oldVersion" == "null" ] && oldVersion="N/A" # != $newVersion		[ "$oldVersion" == "null" ] && oldVersion="N/A" # != $newVersion
	newVersion=$(		newVersion=$(
	echo "$curlOptions" \| curl -s --config - "$API"/encap/serial \| jq ".serial"		echo "$curlOptions" \| curl --config - "$API"/encap/serial \| jq ".serial"
	allZero "${PIPESTATUS[@]}" \|\| exit $?		allZero "${PIPESTATUS[@]}" \|\| exit $?
	) \|\| newVersion="API error $?"		) \|\| newVersion="API error $?"
Line 67:		Line 70:
	# Fetch new data from the API and store it in $cache:		# Fetch new data from the API and store it in $cache:
	newVersion=$(		newVersion=$(
	echo "$curlOptions" \| curl -s --config - "$API"/encap/routes \| tee "$cache" \| jq ".serial"		echo "$curlOptions" \| curl --config - "$API"/encap/routes \| tee "$cache" \| jq ".serial"
	allZero "${PIPESTATUS[@]}" \|\| exit $?		allZero "${PIPESTATUS[@]}" \|\| exit $?
	) \|\| exit $?		) \|\| exit $?

W6JMK: Created page with "Here's a bash script to get a complete encap.txt file from the portal. For example: .\get-encap < api-token.txt > encap.txt || echo error $? The script maintains a cache, so it downloads the information only when it has changed. #!/bin/bash # Output the current AMPRNet routing information, like this: # # Fetched version from # route addprivate 44.0.1.0/32 encap 169.228.84.34 # route addprivate 44.102.240.16/28 encap 45.145.74.24..."

2024-10-15T02:53:36Z

Created page with "Here's a bash script to get a complete encap.txt file from the portal. For example: .\get-encap < api-token.txt > encap.txt || echo error $? The script maintains a cache, so it downloads the information only when it has changed. <nowiki> #!/bin/bash # Output the current AMPRNet routing information, like this: # # Fetched <when> version <number> from <source> # route addprivate 44.0.1.0/32 encap 169.228.84.34 # route addprivate 44.102.240.16/28 encap 45.145.74.24..."

New page

Here's a bash script to get a complete [[encap.txt]] file from the portal.
For example:

.\get-encap < api-token.txt > encap.txt || echo error $?

The script maintains a cache, so it downloads the information only when it has changed.

<nowiki>
#!/bin/bash
# Output the current AMPRNet routing information, like this:
# # Fetched <when> version <number> from <source>
# route addprivate 44.0.1.0/32 encap 169.228.84.34
# route addprivate 44.102.240.16/28 encap 45.145.74.247
# ...

cache="${1:-routes.json}" # a file that stores previous information
token=`cat -` # an API token
# To obtain a token, register with http://portal.ampr.org/ , log in,
# browse your profile and copy the value of "API Token".
# Be sure to keep the token private. This script won't reveal it.

API="https://portal.ampr.org/api/v2"
# The API returns JSON, something like:
# {
# "count": 836,
# "serial": "136.269",
# "encap": [
# {
# "gatewayIP": "118.82.153.200",
# "encapType": "IPIP",
# "network": "44.147.0.210",
# "cidr": 25,
# ...
# },
# ...
# ]
# }
# ... but without any insignificant white space.
# We trust that any change will also change the serial value.

allZero () {
for status in "$@"; do
[ "$status" != 0 ] && return "$status"
done
return 0
}

curlOptions="-H \"Authorization: Bearer $token\"
-H \"Accept: application/json\"
"
if [[ -e "$cache" && ! -f "$cache" ]]; then
echo >&2 `basename "$0"`": $cache isn't a regular file."
exit 1
elif [ -r "$cache" ]; then
oldVersion=`jq ".serial" "$cache"` || oldVersion="cache error $?"
[ "$oldVersion" == "null" ] && oldVersion="N/A" # != $newVersion
newVersion=$(
echo "$curlOptions" | curl -s --config - "$API"/encap/serial | jq ".serial"
allZero "${PIPESTATUS[@]}" || exit $?
) || newVersion="API error $?"
else
oldVersion="N/A" # != $newVersion
newVersion="TBD"
fi
# echo "# oldVersion=$oldVersion newVersion=$newVersion"
if [ "$newVersion" != "$oldVersion" ]; then
# Fetch new data from the API and store it in $cache:
newVersion=$(
echo "$curlOptions" | curl -s --config - "$API"/encap/routes | tee "$cache" | jq ".serial"
allZero "${PIPESTATUS[@]}" || exit $?
) || exit $?
fi
# Convert $cache to the output format:
echo "# Fetched" `date -r "$cache"` version "$newVersion" from "$API" || exit $?
jq -r '.encap[] | select(.encapType == "IPIP") | "route addprivate \(.network)/\(.cidr) encap \(.gatewayIP)"'\
"$cache" | sort
# Sorting the output makes it easier to compare different versions.
allZero "${PIPESTATUS[@]}" || exit $?
</nowiki>