Overview

This guide goes over the specifics of creating a network/network resource backup in YAML or JSON file format via the Netfoundry console. Network resources for which a backup file can be created are the Edge Router, APPWAN, Service, Posture Checks, and Endpoints. Using the YAML/JSON backup files you can recreate an entire network or specific network resources.

1. Backup and recreate your Network

1.1 Your network as Code

Go to Network Settings → Manage Networks to get the process started. Select the specific network that you want to backup by clicking on the radio button and the corresponding ellipsis menu. Then click the 'Download' option to take the backup of the network in YAML or JSON file format.

Select the "DOWNLOAD RE-CREATE FORMAT" and then select the file format of your choice to complete the backup process. 

Your downloaded JSON file will look something like the below,

1.2 Re-creating a Network from Code

The steps for re-creating a Network are straightforward. Go to Network Settings → Manage Networks to get the process started. Click the blue plus-sign in the upper right corner to re-create a network. 

On the 'Create a New Network' screen, you'll find a field for uploading the backup file of YAML or JSON file to recreate the network. Upload your network as code. Then click 'Create my Network' to finish the process.

After uploading the backup file in YAML or JSON file format, the name of the Network will reflect in the window as below. Then "EDIT" option allows you to view and edit your network config before creation. 

 

Make the required changes that you wish and then select the "DONE" button to proceed with the network creation. 

Then click on 'Create my Network' to finish the process. 

Your network will show a grey spinning globe and a status of 'Provisioning' while it is being created. 

In a few minutes, the globe will turn green and the status will change to 'Provisioned'. 

2. Backup and recreate a NetFoundry Hosted Edge Router

2.1 Your NetFoundry Hosted Edge Router as code: 

Go to Network Settings → Edge Routers to get the process started. Select the specific Edge Router that you want to backup by clicking on the radio button and the corresponding ellipsis menu. Then click the 'Download Selected' option to take the backup of the Edge Router in YAML or JSON file format.

A new screen will appear with options to download a backup file in JSON or YAML file format. Select the "DOWNLOAD RE-CREATE FORMAT" and then select the file format of your choice to complete the backup process. 

Your downloaded YAML or JSON file will look something like the below,

2.2 Re-creating your NetFoundry Hosted Edge Router from code:

Go to Network Settings → Edge Routers. On the top left corner of the screen, you will find the option "UPLOAD EDGE ROUTERS" and click the same to upload the backup file of YAML or JSON file to recreate the NetFoundry Hosted Edge Router. 

You'll find a field for uploading the backup file of YAML or JSON file to recreate the NetFoundry Hosted Edge Router. When you are ready to import your backup file, search your computer library or drag and drop the file into the upload box. Then click the "UPLOAD" option to finish the process.

Then the Netfoundry edge router is created and provisioned. 

3. Backup and recreate your Customer Edge Router

3.1 Your Customer Edge Router as code:

Go to Network Settings → Edge Routers to get the process started. Select the specific Edge Router that you want to backup by clicking on the radio button and the corresponding ellipsis menu. Then click the 'Download Selected' option to take the backup of the Edge Router in YAML or JSON file format.

A new screen will appear with options to download a backup file in JSON or YAML file format. Select the "DOWNLOAD RE-CREATE FORMAT" and then select the file format of your choice to complete the backup process. 

Your downloaded YAML or JSON file will look something like the below,

3.2 Re-creating your Customer Edge Router from code:

Go to Network Settings → Edge Routers. On the top left corner of the screen, you will find the option "UPLOAD EDGE ROUTERS" and click the same to upload the backup file of YAML or JSON file to recreate the Customer Hosted Edge Router. 

You'll find a field for uploading the backup file of YAML or JSON file to recreate the Customer Hosted Edge Router. When you are ready to import your backup file, search your computer library or drag and drop the file into the upload box. Then click the "UPLOAD" option to finish the process.

 

 

Edge Router - Created and registered:

The corresponding endpoint is auto-created and provisioned on the same edge router

4. Backup and recreate your service

4.1 Your service as code: 

To access your service as code, Go to Network Settings → Manage Services to get the process started. From this menu, you are able to select one, or all, of your services to download as a JSON, or YAML file format. Highlight each service you'd like to download or click the circle next to 'Service Name' to highlight all services. Then click either the 'Download Selected' or "Download All" option to take the backup of the service in YAML or JSON file format.

A new screen will appear with options to download a backup file in JSON or YAML file format. Select the "DOWNLOAD RE-CREATE FORMAT" and then select the file format of your choice to complete the backup process.

Your downloaded YAML or JSON file will look something like the below,

4.2 Re-creating your Service from Code

To access your service as code, Go to Network Settings → Manage Services to get the process started. On the top left corner of the screen, you will find the option "UPLOAD SERVICES" and click the same to upload the backup file of YAML or JSON file to recreate a Service from Code. 

You'll find a field for uploading the backup file of YAML or JSON file to recreate the Service. When you are ready to import your backup file, search your computer library or drag and drop the file into the upload box. Then click the "UPLOAD" option to finish the process.

After uploading the backup file in YAML or JSON file format, the "EDIT" option allows you to view and edit your service config (such as service name, attributes, IP, ports, etc.) before creation. Make the required changes that you wish and then select the "UPLOAD" button to proceed with the service creation. 

This process may take a few minutes to complete, depending on how many services you are creating.  Navigate to your network dashboard or Manage Services to see if any errors occurred. 

5. Backup and recreate your AppWANs

5.1 Your AppWANs as code: 

To access your AppWANs as code, Go to Network Settings → Manage AppWANs to get the process started. From this menu, you are able to select one, or all, of your AppWANs to download as a CSV or JSON, or YAML file format. Highlight each AppWANs you'd like to download or click the circle next to 'AppWANs Name' to highlight all AppWANs. Then click either the 'Download Selected' or "Download All" option to take the backup of the AppWAN in YAML or JSON file format.

A new screen will appear with options to download a backup file in JSON or YAML file format. Select the "DOWNLOAD RE-CREATE FORMAT" and then select the file format of your choice to complete the backup process. 

Your downloaded YAML or JSON file will look something like the below,

5.2 Re-creating your AppWAN from Code

To access your AppWANs as code, Go to Network Settings → Manage AppWANs to get the process started. On the top left corner of the screen, you will find the option "UPLOAD APPWANS" and click the same to upload the backup file of YAML or JSON file to recreate a New AppWAN from Code. 

Then you'll find a field for uploading the backup file of YAML or JSON file to recreate an AppWANs from Code. When you are ready to import your backup file, search your computer library or drag and drop the file into the upload box. Then click the "UPLOAD" option to finish the process.

After uploading the backup file in YAML or JSON file format, the "EDIT" option allows you to view and edit your AppWANs config(such as AppWAN name,attributes,etc.)Make the required changes that you wish and then select the "UPLOAD" button to proceed with the AppWANs creation.  

This process may take a few minutes to complete. Navigate to your network dashboard or Manage AppWANs to see if any errors occurred. 

6. Backup and recreate your Posture Checks

6.1 Create your Posture Checks as code: 

To access your Posture Checks as code, Go to Network Settings → Posture checks to get the process started. From this menu, you are able to select one, or all, of your Posture Checks to download as JSON, or YAML file format. Highlight each Posture Checks you'd like to download or click the circle next to 'Posture Checks Name' to highlight all Posture Checks. Then click either the 'Download Selected' or "Download All" option to take the backup of the Posture Check in YAML or JSON file format.

A new screen will appear with options to download a backup file in JSON or YAML file format. Select the "DOWNLOAD RE-CREATE FORMAT" and then select the file format of your choice to complete the backup process. 

Your downloaded YAML or JSON file will look something like the below,

6.2 Re-Creating a Posture Checks from Code: 

To access your Posture Checks as code, Go to Network Settings → Posture checks to get the process started. On the top left corner of the screen, you will find the option "UPLOAD POSTURE CHECKS" and click the same to upload the backup file of YAML or JSON file to recreate a Posture Checks from Code. 

Then you'll find a field for uploading the backup file of YAML or JSON file to recreate a Posture Checks from Code. When you are ready to import your backup file, search your computer library or drag and drop the file into the upload box. Then click the "UPLOAD" option to finish the process.

After uploading the backup file in YAML or JSON file format, the "EDIT" option allows you to view and edit your Posture checks config (such as Posture checks name , attributes and type) before creation. Make the required changes that you wish and then select the "UPLOAD" button to proceed with the Posture checks creation.  

This process may take a few minutes to complete. Navigate to your network dashboard or Manage Posture Checks to see if any errors occurred. 

7. Backup and recreate your Endpoints

7.1 Create your Endpoints as code: 

Go to Network Settings → Endpoints to get the process started. From this menu, you are able to select one, or all, of your Endpoints to download as JSON, or YAML file format. Highlight each Endpoint you'd like to download or click the circle next to 'Endpoint Name' to highlight all Endpoints. Then click either the 'Download Selected' or "Download All" option to take the backup of the Endpoints in YAML or JSON file format.

A new screen will appear with options to download a backup file in JSON or YAML file format. Select the "DOWNLOAD RE-CREATE FORMAT" and then select the file format of your choice to complete the backup process. 

Your downloaded YAML or JSON file will look something like the below,

7.2 Re-Creating Endpoints from Code: 

Go to Network Settings → Endpoints to get the process started. On the top left corner of the screen, you will find the option "UPLOAD ENDPOINTS " and click the same to upload the backup file of YAML or JSON file to recreate an Endpoints from Code. 

Then you'll find a field for uploading the backup file of YAML or JSON file to recreate an Endpoints from Code. When you are ready to import your backup file, search your computer library or drag and drop the file into the upload box. Then click the "UPLOAD" option to finish the process.

After uploading the backup file in YAML or JSON file format, the "EDIT" option allows you to view and edit your endpoints config(such as endpoint name & attributes) before creation. Make the required changes that you wish and then select the "UPLOAD" button to proceed with the Endpoint creation.  

This process may take a few minutes to complete. Navigate to your network dashboard or Manage Endpoints to see if any errors occurred.