FortiGate FortiOS Firewall 2G Shell

Release date: October 2019

Shell version: 1.1.0

Document version: 1.1

In This Guide

• Overview
• Downloading the Shell
• Importing and Configuring the Shell
• Updating Python Dependencies for Shells
• Typical Workflows
• References
• Release Notes

Overview

A shell integrates a device model, application or other technology with CloudShell. A shell consists of a data model that defines how the device and its properties are modeled in CloudShell, along with automation that enables interaction with the device via CloudShell.

Firewall Shells

CloudShell's Firewall shells enable you to manage your Firewall device similar to your networking equipment but without connectivity. In CloudShell, a Firewall shell runs commands, such as Autoload, Load, and Save Configuration.

FortiGate FortiOS Firewall 2G Shell

FortiGate FortiOS Firewall 2G Shell provides you with connectivity and management capabilities such as device structure discovery and power management for the FortiGate FortiOS Firewall.

For more information on the FortiGate FortiOS Firewall, see the official FortiNet product documentation.

Standard version

The FortiGate FortiOS Firewall 2G Shell 1.1.0 is based on the CloudShell Firewall Standard 3.0.1.

For detailed information about the shell’s structure and attributes, see the Firewall Shell Standard in GitHub.

Supported OS

▪ FortiOS

Requirements

Release: FortiGate FortiOS Firewall 2G Shell

• CloudShell version: 8.3 and above

Note: If your CloudShell version does not support this shell, you should consider upgrading to a later version of CloudShell or contact customer support.

Data Model

The shell's data model includes all shell metadata, families, and attributes.

FortiGate FortiOS Firewall 2G Shell Families and Models

The families and models are listed in the following table:

Family	Model	Description
CS_Firewall	FortiGate FortiOS Firewall Shell 2G	Generic FortiGate FortiOS Firewall Shell 2G
CS_Chassis	Generic Chassis	Default Firewall chassis
CS_Port	Generic Port	Interface
CS_Port_Channel	Generic Port Channel	Group of interfaces
CS_Power_Port	Generic Power Port	Power Supply module

FortiGate FortiOS Firewall 2G Shell Attributes

The attribute names and types are listed in the Firewall Shell Standard - Attributes section.

Automation

This section describes the automation (drivers) associated with the data model. The shell’s driver is provided as part of the shell package. There are two types of automation processes, Autoload and Resource. Autoload is executed when creating the resource in the Inventory dashboard, while resource commands are run in the Sandbox, providing that the resource has been discovered and is online.

The FortiGate FortiOS Firewall shell supports commands listed in the Firewall Shell Standard - Commands section.

Downloading the Shell

The FortiGate FortiOS Firewall 2G Shell is available from the Quali Community Integrations page.

Download the files into a temporary location on your local machine.

The shell comprises:

File name	Description
FortiGateFortiOSFirewallShell2G.zip	FortiGate shell package
cloudshell-firewall-fortinet-fortios-shell-2g-dependencies-package-1.1.0.zip	Shell Python dependencies (for offline deployments only)

Importing and Configuring the Shell

This section describes how to import the FortiGate FortiOS Firewall 2G Shell 2G 1.1.0 and configure and modify the shell’s devices.

Importing the shell into CloudShell

To import the shell into CloudShell:

1. Make sure you have the shell’s zip package. If not, download the shell from the Quali Community's Integrations page.

2. In CloudShell Portal, as Global administrator, open the Manage – Shells page.

3. Click Import.

4. In the dialog box, navigate to the shell's zip package, select it and click Open.

The shell is displayed in the Shells page and can be used by domain administrators in all CloudShell domains to create new inventory resources, as explained in Adding Inventory Resources.

Offline installation of a shell

Note: Offline installation instructions are relevant only if CloudShell Execution Server has no access to PyPi. You can skip this section if your execution server has access to PyPi. For additional information, see the online help topic on offline dependencies.

In offline mode, import the shell into CloudShell and place any dependencies in the appropriate dependencies folder.

Adding shell and script packages to the local PyPi Server repository

If your Quali Server and/or execution servers work offline, you will need to copy all required Python packages, including the out-of-the-box ones, to the PyPi Server's repository on the Quali Server computer (by default C:\Program Files (x86)\QualiSystems\CloudShell\Server\Config\Pypi Server Repository).

For more information, see Configuring CloudShell to Execute Python Commands in Offline Mode.

To add Python packages to the local PyPi Server repository:

1. If you haven't created and configured the local PyPi Server repository to work with the execution server, perform the steps in Add Python packages to the local PyPi Server repository (offlinemode).

2. For each shell or script you add into CloudShell, do one of the following (from an online computer):

   • Connect to the Internet and download each dependency specified in the requirements.txt file with the following command: pip download -r requirements.txt. The shell or script's requirements are downloaded as zip files.

   • In the Quali Community's Integrations page, locate the shell and click the shell's Download link. In the page that is displayed, from the Downloads area, extract the dependencies package zip file.

3. Place these zip files in the local PyPi Server repository.

Configuring a new resource

This section explains how to create a new resource from the shell.

In CloudShell, the component that models the device is called a resource. It is based on the shell that models the device and allows the CloudShell user and API to remotely control the device from CloudShell.

You can also modify existing resources, see Managing Resources in the Inventory.

To create a resource for the device:

1. In the CloudShell Portal, in the Inventory dashboard, click Add New.

2. From the list, select FortiGateFortiOSFirewallShell2G.

3. Enter the Name and IP address of the FortiGate FortiOS Firewall.

4. Click Create.

5. In the Resource dialog box, enter the device's settings, see FortiGate FortiOS Firewall 2G Shell Attributes.

6. Click Continue.

CloudShell validates the device’s settings and updates the new resource with the device’s structure (if the device has a structure).

Updating Python Dependencies for Shells

This section explains how to update your Python dependencies folder. This is required when you upgrade a shell that uses new/updated dependencies. It applies to both online and offline dependencies.

Updating offline Python dependencies

To update offline Python dependencies:

1. Download the latest Python dependencies package zip file locally.

2. Extract the zip file to the suitable offline package folder(s).

3. Restart any execution server that has a live instance of the relevant driver or script. This requires running the Execution Server's configuration wizard, as explained in the Configure the Execution Server topic of the CloudShell Suite Installation guide.

Updating online Python dependencies

In online mode, the execution server automatically downloads and extracts the appropriate dependencies file to the online Python dependencies repository every time a new instance of the driver or script is created.

To update online Python dependencies:

• If there is a live instance of the shell's driver or script, restart the execution server, as explained above. If an instance does not exist, the execution server will download the Python dependencies the next time a command of the driver or script runs.

Typical Workflows

Workflow 1 - Save configuration

1. In CloudShell Portal, add the FortiGate FortiOS Firewall resource to your blueprint and reserve the blueprint.

2. Run the Save command on the device with the following inputs:

   • Folder Path: For example, tftp://ipaddress/shared folder
   • Configuration Type: Running or Startup

The configuration is saved to a file named <startup/running-config>-, which will reside in the folder path you entered.

Workflow 2 - Restore Configuration

1. In CloudShell Portal, add the FortiGate FortiOS Firewall resource to your blueprint and reserve the blueprint.

2. Run the Restore resource command.

3. Enter the following parameters:

   • Path (mandatory): Enter the full path of the configuration file.
   • Restore Method (optional): Append or Override. If you do not enter any value in this field, the Append method will be used.
   • Configuration Type (mandatory): Startup or Running.

Workflow 3 - Load firmware

1. In CloudShell Portal, add the FortiGate FortiOS Firewall resource to your blueprint and reserve the blueprint.

2. Run the Load Firmware resource command.

3. Enter the following parameters:

   • Path (mandatory): Enter the full path of the firmware file on the remote host. For example, tftp://10.1.1.1/PanOS_200-5.0.5.

Workflow 4 - Send custom command

1. In CloudShell Portal, add the FortiGate FortiOS Firewall resource to your blueprint and reserve the blueprint.

2. Run the Send Custom Command resource command.

3. Enter the following parameters:

   • Command (mandatory): Enter the command you want to run.

References

To download and share integrations, see Quali Community's Integrations.

For instructional training and documentation, see Quali University.

To suggest an idea for the product, see Quali's Idea box.

To connect with Quali users and experts from around the world, ask questions and discuss issues, see Quali's Community forums.

Release Notes

Known Issues

• Firewall standard doesn't support SNMP v3 authentication and privacy protocols.