Introduction

ATTENTION: These instruction are intended only for NetFoundry Virtual Machine Image.  This will not work on custom installations.

This document will describe how to download and run the NetFoundry "vm-support-bundle" script. 

The script will gather support information from the local Virtual Machine & push the information into ZenDesk help desk system.

Requirements

The Virtual Machine running this command will download from the following endpoint(https/443):

https://github.com/netfoundry/edge-router-support-bundle

If you would like the script to upload the bundle automatically, the Virtual Machine will also need access to the following S3 Bucket (https/443):

https://nf-vm-support-bundle.s3.amazonaws.com

Setup:

Before running the command, check to see if you have the command available in your Virtual Machine.

Run the following command:

which vm-support-bundle

If the command returns:

/opt/netfoundry/vm-support-bundle

Great, You can proceed with the Creating a VM Support Bundle section

If the command returns something like the following:

no vm-support-bundle in (....

Then the script is not yet available & you need to run the following command to install it:

sudo curl -L -o /opt/netfoundry/support_bundle_bootstrap.tar.gz https://github.com/netfoundry/edge-router-support-bundle/releases/latest/download/support_bundle_bootstrap.tar.gz; sudo tar -xf /opt/netfoundry/support_bundle_bootstrap.tar.gz -C /opt/netfoundry/; sudo rm /opt/netfoundry/support_bundle_bootstrap.tar.gz

You should now be able to continue to the next section.

Creating a VM Support Bundle

Run the following command:

sudo /opt/netfoundry/vm-support-bundle

You will be prompted to provide the following information:

1. ZenDesk Ticket Number -- If you don't have one, please open one here:  https://netfoundry.zendesk.com/
2. Your email address -- This email will be included in the CC for the ZenDesk Ticket

The script will prompt you to upload the file to S3.  If you choose not to upload the file will remain in the running users home directory.

Optional Usage:

usage: vm-sup [-h] [-t TICKET_NUMBER] [-e EMAIL_ADDRESS] [-n DUMP_COUNT] [-u]
[-d] [-v]

optional arguments:
-h, --help show this help message and exit
-t TICKET_NUMBER, --ticket_number TICKET_NUMBER
support ticket number
-e EMAIL_ADDRESS, --email_address EMAIL_ADDRESS
email address
-n DUMP_COUNT, --dump_count DUMP_COUNT
number of times to perform dumps
-u, --upload auto upload
-d, --debug enable debug log in log file output
-v, --version show program's version number and exit

Examples:

Specify ticket number and email address and automatic upload

sudo /opt/netfoundry/vm-support-bundle -t 1234 -e my@email.address.com -u

Specify number of dumps to create

sudo /opt/netfoundry/vm-support-bundle -n 3

Specify ticket, email, dump count and auto upload

sudo /opt/netfoundry/vm-support-bundle -t 1234 -e my@email.address.com -u -n 3

Setting ER Logging Level

Use the below command to set the logging level to debug

sudo /opt/netfoundry/ziti/ziti ps set-log-level $(pidof ziti-router) debug

Use the below command to set the logging level to verbose

sudo /opt/netfoundry/ziti/ziti ps set-log-level $(pidof ziti-router) verbose

Use the below command to set the logging level to info

sudo /opt/netfoundry/ziti/ziti ps set-log-level $(pidof ziti-router) info

In newer versions of the software, ps has been replaced by agent in this command

sudo /opt/netfoundry/ziti/ziti agent set-log-level $(pidof ziti-router) [debug/verbose/info]