topic Re: How to get virtual system/router dynamic routes using the Run-Script API command in API / CLI Discussion

How to get virtual system/router dynamic routes using the Run-Script API command

Robert_Decker1 — Mon, 19 Apr 2021 12:13:02 GMT

Hey,

Is there a way to get the dynamic/static routes from VSX virtual systems (VS/VR) using the Run-Script API command?

Meaning, build a script body composed of several CLI commands, such as:

vsenv <vsid>

show route

Thanks in advance.

Re: How to get virtual system/router dynamic routes using the Run-Script API command

Bob_Zimmerman — Mon, 19 Apr 2021 13:46:42 GMT

Try building a one-liner like this:

sh -c 'command 1;command 2;third "command with quotes";fourth \'command with ticks\';command 5'

I haven't used this construct with Run-Script before, but I use it with xargs all the time.

Re: How to get virtual system/router dynamic routes using the Run-Script API command

Robert_Decker1 — Sun, 25 Apr 2021 08:22:09 GMT

Thanks Bob.

My problem is that I've to run that commands in CLISH mode.

Is there a way to change the CLI mode using run-script API command?

For example: >>clish;set virtual-system 4;show route;

I've also tried: clish -c 'set virtual-system 4;show route;' with no success - run-script failed

Re: How to get virtual system/router dynamic routes using the Run-Script API command

Bob_Zimmerman — Sun, 25 Apr 2021 15:11:25 GMT

Yeah, that's a limitation of clish. It's pretty solidly useless for troubleshooting or most automation. The best workaround I've found so far would be something like this:

sh -c 'printf "set virtual-system 4\nshow route\nexit\n" | clish'

That way, you can wrap the pipeline, do other commands to process the data locally on the firewall, then you get the eventual result back at the management.

There is also now the GAiA API which might be able to do what you want without involving clish.

Re: How to get virtual system/router dynamic routes using the Run-Script API command

Petr_Hantak — Mon, 26 Apr 2021 11:58:54 GMT

Probably this won't be perfect for you because you mention of use clish only. But in case you have an expert level access, then you can use following:

for i in /proc/vrf/*; do i=${i#*vrf/}; vsenv $i; echo "set virtual-system" $i > /tmp/clishcmd; echo "show route" >> /tmp/clishcmd; clish -i -f /tmp/clishcmd; done

Just change show route for any other command which you need.

Re: How to get virtual system/router dynamic routes using the Run-Script API command

Robert_Decker1 — Mon, 26 Apr 2021 12:08:33 GMT

Thank you Petr,

I've tried that in expert mode but it didn't work correctly.

It requires CLISH mode to respond with the correct results (for the combination of "set virtual-system ID" and "show route").

Re: How to get virtual system/router dynamic routes using the Run-Script API command

Kaspars_Zibarts — Mon, 26 Apr 2021 12:20:06 GMT

can't you create shell script and then add custom clish command?

Usage: add command <command name> path <command path> description <command description>

we use those for "special" users that can execute only one command in clish that's script based

essentially you map clish command to a shell script

Re: How to get virtual system/router dynamic routes using the Run-Script API command

Robert_Decker1 — Mon, 26 Apr 2021 12:21:41 GMT

Hey, I cannot, it's customer's device and we are not allowed to upload bash scripts there.

Re: How to get virtual system/router dynamic routes using the Run-Script API command

genisis__ — Mon, 08 Sep 2025 08:36:37 GMT

Hi Kaspars,

I could not find a specific thread for this query, but this is the closest I think.
I've created a bunch of VS's using vsx_provisioning_tool on R82, however things I could not do are adding comments, changing the colour of the object and setting the main ip (need to change it).
So I looked at mgmt_cli api commands and I still can't see anything, so was wondering if this can be done using API?
Failing that I would need to go into every object and update (not a biggy but wanted to get it done using a script).

Re: How to get virtual system/router dynamic routes using the Run-Script API command

PhoneBoy — Mon, 08 Sep 2025 18:19:47 GMT

Legacy VSX objects do not have API support.
VSnext (from R82), on the other hand, does.

Re: How to get virtual system/router dynamic routes using the Run-Script API command

genisis__ — Mon, 08 Sep 2025 19:25:20 GMT

Thanks. So In my case will just need to update additional parameter manually.