feat(scripts): created convenience shell scripts by mrdrew213 · Pull Request #4 · cambrianworks/gigswitch-examples

mrdrew213 · 2025-09-25T23:38:20Z

Shell scripts to get, set, check config
Shell script to power off a port

MichaelF-CW · 2025-09-26T20:28:11Z

+# Output file name
+fname="request.jsonl"
+
+echo '{ "method": "icfg.status.copy.get", "params": [], "id": 99 }' > "$fname"


I think we can simplify a little with post -d to just inline the request so we don't have to generate (or overwrite) request.jsonl.
If the id isn't important, one will be filled in by gs-rpc if omitted.
Could also simplify to:
gs-rpc call icfg.status.copy.get

MichaelF-CW

Some suggestions inlined. If those are accepted, it leaves some lines that can be removed and files to rename.

MichaelF-CW · 2025-09-30T19:50:24Z

@@ -0,0 +1,14 @@
+#!/bin/bash
+# Usage: ./check_config_status.sh


Suggested change

# Usage: ./check_config_status.sh

# Usage: ./check_copy_status.sh

# The status indicates the status of current copy operation.

# none(0) means no copy operation.

# success(1) means copy operation is successful.

# inProgress(2) means current copy operation is in progress.

# errOtherInProcessing(3) means copy operation is failed due to other in processing.

# errNoSuchFile(4) means copy operation is failed due to file not existing.

# errSameSrcDst(5) means copy operation is failed due to the source and destination are the same.

# errPermissionDenied(6) means copy operation is failed due to the destination is not permitted to modify.

# errLoadSrc(7) means copy operation is failed due to the error to load source file.

# errSaveDst(8) means copy operation is failed due to the error to save or commit destination."

^ This is just inlined from the json-rpc spec comments.

MichaelF-CW · 2025-09-30T19:53:30Z

+
+# strip leading "/" from CONFIG if present
+# CONFIG=${2#/}
+# just the filename (file must be in the tftp dir


Suggested change

# just the filename (file must be in the tftp dir

# just the filename (file must be in the top tftp dir)

MichaelF-CW · 2025-09-30T19:56:49Z

+# Output file name
+fname="request.jsonl"
+
+echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "SourceConfigType": "runningConfig", "SourceConfigFile": "", "DestinationConfigType": "configFile", "DestinationConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"


Suggested change

echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "SourceConfigType": "runningConfig", "SourceConfigFile": "", "DestinationConfigType": "configFile", "DestinationConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"

gr-rpc post -d '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "SourceConfigType": "runningConfig", "SourceConfigFile": "", "DestinationConfigType": "configFile", "DestinationConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }'

MichaelF-CW · 2025-09-30T19:57:35Z

+fname="request.jsonl"
+
+echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "SourceConfigType": "runningConfig", "SourceConfigFile": "", "DestinationConfigType": "configFile", "DestinationConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"
+gs-rpc post -f $fname


Suggested change

gs-rpc post -f $fname

MichaelF-CW · 2025-09-30T19:58:52Z

+# just the filename (file must be in the tftp dir
+CONFIG=$(basename "$2")
+
+# Output file name


Shouldn't need to create a file artifact.

MichaelF-CW · 2025-09-30T20:14:03Z

+
+if [[ "$port_num" == $MANAGEMENT_PORT ]]; then
+  echo "Warning, do not modify the management port power mode"
+  echo "If you really want to turn of the management port, type:"


Suggested change

echo "If you really want to turn of the management port, type:"

echo "If you really want to alter the management port, type:"

MichaelF-CW · 2025-09-30T20:16:59Z

@@ -0,0 +1,19 @@
+#!/bin/bash
+# Usage: ./set_running_config <tftp_server_ip>  <config>


Suggested change

# Usage: ./set_running_config <tftp_server_ip> <config>

# Usage: ./set_running_config <tftp_server_ip> <config>

# Update running-config by copying <config> file from tftp server.

MichaelF-CW · 2025-09-30T20:17:15Z

+# just the filename (file must be in the tftp dir)
+CONFIG=$(basename "$2")
+
+# Output file name


Can remove saving to output file.

MichaelF-CW · 2025-09-30T20:17:42Z

+# Output file name
+fname="request.jsonl"
+
+echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "DestinationConfigType": "runningConfig", "DestinationConfigFile": "", "SourceConfigType": "configFile", "SourceConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"


Suggested change

echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "DestinationConfigType": "runningConfig", "DestinationConfigFile": "", "SourceConfigType": "configFile", "SourceConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"

gs-rpc post -d '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "DestinationConfigType": "runningConfig", "DestinationConfigFile": "", "SourceConfigType": "configFile", "SourceConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }'

MichaelF-CW · 2025-09-30T20:17:52Z

+fname="request.jsonl"
+
+echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "DestinationConfigType": "runningConfig", "DestinationConfigFile": "", "SourceConfigType": "configFile", "SourceConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"
+gs-rpc post -f $fname


		@@ -0,0 +1,14 @@
		#!/bin/bash
		# Usage: ./check_config_status.sh

-# Usage: ./check_config_status.sh
+# Usage: ./check_copy_status.sh
+# The status indicates the status of current copy operation.
+# none(0) means no copy operation.
+# success(1) means copy operation is successful.
+# inProgress(2) means current copy operation is in progress.
+# errOtherInProcessing(3) means copy operation is failed due to other in processing.
+# errNoSuchFile(4) means copy operation is failed due to file not existing.
+# errSameSrcDst(5) means copy operation is failed due to the source and destination are the same.
+# errPermissionDenied(6) means copy operation is failed due to the destination is not permitted to modify.
+# errLoadSrc(7) means copy operation is failed due to the error to load source file.
+# errSaveDst(8) means copy operation is failed due to the error to save or commit destination."

	# just the filename (file must be in the tftp dir
	# just the filename (file must be in the top tftp dir)

	echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "SourceConfigType": "runningConfig", "SourceConfigFile": "", "DestinationConfigType": "configFile", "DestinationConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"
	gr-rpc post -d '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "SourceConfigType": "runningConfig", "SourceConfigFile": "", "DestinationConfigType": "configFile", "DestinationConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }'

	echo "If you really want to turn of the management port, type:"
	echo "If you really want to alter the management port, type:"

		@@ -0,0 +1,19 @@
		#!/bin/bash
		# Usage: ./set_running_config <tftp_server_ip> <config>

	# Usage: ./set_running_config <tftp_server_ip> <config>
	# Usage: ./set_running_config <tftp_server_ip> <config>
	# Update running-config by copying <config> file from tftp server.

	echo '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "DestinationConfigType": "runningConfig", "DestinationConfigFile": "", "SourceConfigType": "configFile", "SourceConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }' > "$fname"
	gs-rpc post -d '{ "method": "icfg.control.copy.set", "params": [{ "Copy": true, "DestinationConfigType": "runningConfig", "DestinationConfigFile": "", "SourceConfigType": "configFile", "SourceConfigFile": "tftp://'"$TFTP_SERVER_IP"'/'"$CONFIG"'", "Merge": false }], "id": 1 }'

Conversation

mrdrew213 commented Sep 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MichaelF-CW left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants