Starting with ACI release 6.1.2, AppCenter and its applications can no longer be hosted on Cisco APIC. For any questions or support, feel free to reach out to us at aciappcenter-support@external.cisco.com.
CLICommandCollector
Company: Cisco
Details
CLICommandCollector App enables users to search CLI commands and collect command outputs from multiple ACI nodes (APIC/Spine/Leaf) at the same time as a single point of UI.
- Prerequisite
At the first time of usage, you need to save user credential (username & password) with admin privilege in the Setting menu. This credential will be used for API access to APIC and SSH access to each node.
- Command Selection Menu
You can search commands and choose commands which will be collected for each role (APIC, Leaf, Spine(box), Spine(Chassis)). You also need to choose which node the selected commands will be collected on. Commands for following shell types are supported for each role.
- APIC: moquery, show, acidiag
- Leaf: ish, vsh, vsh_lc
- Spine(Box): ish, vsh, vsh_lc
- Spine(Chassis): ish, vsh, linecard, fabric module
At the final stage of the Command Selection Menu, you can review commands for which the outputs will be collected and nodes where the commands will be collected. Once the Submit button is clicked, backend of the App works to collect the corresponding command outputs from the selected nodes and the Result Menu will be shown automatically after command collection, where you can check collected logs.
If you click the Export button before the Submit button in the Command Selection Menu and save the file which contains commands and nodes info, it can be used in the Import Menu to collect the exact same commands on the same nodes later.
- Import Menu
If you import the file exported in the Command Selection Menu or a file customized to collect selected commands on selected nodes, the App can work on the command collection without selecting commands and nodes manually as you do in the Command Selection Menu.
Supported format is shown in the right side of the Menu page. You can also use the Sample Format by just clicking a panel displayed for each role and can edit in the text area.
- Result Menu
After the App completes to collect selected command outputs, this menu page will be automatically shown. You can choose a node from the dropdown, then the collected outputs will be shown below. Clicking the Plus button at the top right will pop a result view for an additional node. Results for maximum 4 nodes can be displayed at the same time.
Download All button at the top and download icon button at the top right for each node can be used to download the command outputs as file(s) for all the nodes and each node, respectively.
You can also download the result file from "/data2/logs/cisco_CLICommandCollector/" directory. Result file is named like "C3__.txt".
- Template Menu
We prepare for some issue templates which contain command list for each role which should be collected for the corresponding issues. If you select an issue from the dropdown list and click the Select button, the Command Selection Menu page will be shown with selected commands for the issue. What you need to do then is just selecting nodes where the commands will be collected for each role, then clicking the Submit button. The App will collect the outputs.
You can also create a custom template from "Create Template" by entering a template name and clicking the Create button, then selecting commands for each role.
- Setting Menu
You need to save the credential here at the first time of usage for the App, as explained above.
In the Advanced Mode, you can create a new DB which contains command list for each role in addition to embedded default command list DB. This custom DB should be used only when you understand difference of available commands between versions/platforms and need to take care of that.
- Help Menu
This Menu is 'How To' page for the App with screenshots for each feature.
- Scripts Menu
You can run your own script or TAC provided scripts on multiple nodes in parallel which can collect useful logs/tcpdump etc. under specific conditions. Refer to Help Menu on the App for more detailed usage.
- Release note
=== Version 1.2 ===
- Scripts Menu is added.
- Web token is refreshed automatically, so that the App UI can continue to work even though time longer than web token timeout passes after the App is opened.
=== Version 1.1 ===
- In Template menu, you can not only select existing issue template but also search in the same box.
- In Template menu, it is possible to create a new issue template from a file and/or text area, which is also used to update the existing template.
- In Template menu, Export/Import at the bottom enables users to export the existing templates into a zip file as backup, and to import a zip file including new templates.
- In Result menu, you can now use the "Download All" button to download a zip file containing result files for selected nodes.
- In Result menu, by clicking "Manage Old Files", it is possible to view result files in the past and to remove them.
=== Version 1.0 ===
First release.
- Prerequisite
At the first time of usage, you need to save user credential (username & password) with admin privilege in the Setting menu. This credential will be used for API access to APIC and SSH access to each node.
- Command Selection Menu
You can search commands and choose commands which will be collected for each role (APIC, Leaf, Spine(box), Spine(Chassis)). You also need to choose which node the selected commands will be collected on. Commands for following shell types are supported for each role.
- APIC: moquery, show, acidiag
- Leaf: ish, vsh, vsh_lc
- Spine(Box): ish, vsh, vsh_lc
- Spine(Chassis): ish, vsh, linecard, fabric module
At the final stage of the Command Selection Menu, you can review commands for which the outputs will be collected and nodes where the commands will be collected. Once the Submit button is clicked, backend of the App works to collect the corresponding command outputs from the selected nodes and the Result Menu will be shown automatically after command collection, where you can check collected logs.
If you click the Export button before the Submit button in the Command Selection Menu and save the file which contains commands and nodes info, it can be used in the Import Menu to collect the exact same commands on the same nodes later.
- Import Menu
If you import the file exported in the Command Selection Menu or a file customized to collect selected commands on selected nodes, the App can work on the command collection without selecting commands and nodes manually as you do in the Command Selection Menu.
Supported format is shown in the right side of the Menu page. You can also use the Sample Format by just clicking a panel displayed for each role and can edit in the text area.
- Result Menu
After the App completes to collect selected command outputs, this menu page will be automatically shown. You can choose a node from the dropdown, then the collected outputs will be shown below. Clicking the Plus button at the top right will pop a result view for an additional node. Results for maximum 4 nodes can be displayed at the same time.
Download All button at the top and download icon button at the top right for each node can be used to download the command outputs as file(s) for all the nodes and each node, respectively.
You can also download the result file from "/data2/logs/cisco_CLICommandCollector/" directory. Result file is named like "C3__.txt".
- Template Menu
We prepare for some issue templates which contain command list for each role which should be collected for the corresponding issues. If you select an issue from the dropdown list and click the Select button, the Command Selection Menu page will be shown with selected commands for the issue. What you need to do then is just selecting nodes where the commands will be collected for each role, then clicking the Submit button. The App will collect the outputs.
You can also create a custom template from "Create Template" by entering a template name and clicking the Create button, then selecting commands for each role.
- Setting Menu
You need to save the credential here at the first time of usage for the App, as explained above.
In the Advanced Mode, you can create a new DB which contains command list for each role in addition to embedded default command list DB. This custom DB should be used only when you understand difference of available commands between versions/platforms and need to take care of that.
- Help Menu
This Menu is 'How To' page for the App with screenshots for each feature.
- Scripts Menu
You can run your own script or TAC provided scripts on multiple nodes in parallel which can collect useful logs/tcpdump etc. under specific conditions. Refer to Help Menu on the App for more detailed usage.
- Release note
=== Version 1.2 ===
- Scripts Menu is added.
- Web token is refreshed automatically, so that the App UI can continue to work even though time longer than web token timeout passes after the App is opened.
=== Version 1.1 ===
- In Template menu, you can not only select existing issue template but also search in the same box.
- In Template menu, it is possible to create a new issue template from a file and/or text area, which is also used to update the existing template.
- In Template menu, Export/Import at the bottom enables users to export the existing templates into a zip file as backup, and to import a zip file including new templates.
- In Result menu, you can now use the "Download All" button to download a zip file containing result files for selected nodes.
- In Result menu, by clicking "Manage Old Files", it is possible to view result files in the past and to remove them.
=== Version 1.0 ===
First release.