API_Add-to-GNS3.sh_of_v14

• Explanations
• Load the API
• Generic Functions
  • VM
    • Modify-ConfigVM
    • Add-ConfigVM-to-GNS3
  • Network
    • Create-NetworkConfig
    • Modify-NetworkConfig
    • Add-NetworkConfig-to-VM
• QEmu
  • Global Variables
    • To change parameter of commands
    • To test the success of the commands
  • Functions
    • Create-VMQEmu
  • Examples
    • Windows Server 2019
    • Windows 10
    • Kali Linux
    • ASA
• Docker
  • Global Variables
    • To change parameter of commands
    • To test the success of the commands
  • Functions
    • Add-PersistentFolder-to-VMDocker
    • Create-VMDocker
  • Examples
    • Alpine
• Dynamips
  • Examples
    • Cisco C7200

---

Explanations

• Add-to-GNS3.sh : API who uses a disk files from QEmu/Docker/Dynamips/VirtualBox to create VM and to add them to GNS3

---

Load the API

source /opt/raizo/api/Add-to-GNS3.sh

---

Generic Functions

VM

Modify-ConfigVM

To modify the created config of VM

• Modify-ConfigVM 1 2 3
  • 1 : Name of file returned by Create-VMQEmu or Create-VMDocker
  • 2 : Name of the parameter to change
  • 3 : New value of the parameter to change

Add-ConfigVM-to-GNS3

To add config of VM to GNS3

• Add-ConfigVM-to-GNS3 1
  • 1 : Name of file returned by Create-VMQEmu

You must create the md5sum file of the hard disk before to call Add-ConfigVM-to-GNS3

Network

Create-NetworkConfig

To create a specific network configuration

• Create-NetworkConfig 1 2 3
  • 1 : Number of network card
  • 2 : Template (example : enp0s)
  • 3 : Type (example : e1000)
• Type : the value must be in $TYPES_NETWORK_CARD[@] : "e1000", "i82550", "i82551", "i82557a", "i82557b", "i82557c", "i82558a", "i82558b", "i82559a", "i82559b", "i82559c", "i82559er", "i82562", "i82801", "ne2k_pci", "pcnet", "rtl8139", "virtio-net-pci"

Modify-NetworkConfig

To modify a specific network configuration created with Create-NetworkConfig

• Modify-NetworkConfig 1 2 3 4
  • 1 : File with config of Network Interfaces (returned by Create-NetworkConfig)
  • 2 : The network card number : 0 1 ...
  • 3 : Field to modify : examples : port_name / adapter_type
  • 4 : New value of the field

Add-NetworkConfig-to-VM

To add a specific network configuration created with Create-NetworkConfig to a VM config created with Create-VMQEmu or Create-VMDocker

• Add-NetworkConfig-to-VM 1 2
  • 1 : File with config of New VM
  • 2 : File with config of Network Interfaces (returned by Create-NetworkConfig)

---

QEmu

Global Variables

To change parameter of commands

• TYPE_HARD_DISK : To change the type of the hard disk of VM
  • Possibles values in $TYPES_HARD_DISK[@] : "ide", "sata", "scsi", "sd", "mtd", "floppy", "pflash", "virtio", "none"
  • Default value in variable : DEFAULT_TYPE_HARD_DISK
  • ( Default value : sata )
• TYPE_NETWORK_CARD : To change the type of the network interfaces of VM
  • Possibles values in $TYPES_NETWORK_CARD[@] : "e1000", "i82550", "i82551", "i82557a", "i82557b", "i82557c", "i82558a", "i82558b", "i82559a", "i82559b", "i82559c", "i82559er", "i82562", "i82801", "ne2k_pci", "pcnet", "rtl8139", "virtio-net-pci"
  • Default value in variable : DEFAULT_TYPE_NETWORK_CARD
  • ( Default value : e1000 )
• SYMBOL_QEMU : To change the default symbol of the QEmu device in GNS3
  • Default value in variable : DEFAULT_SYMBOL_QEMU
  • ( Default value : /symbols/qemu_guest.svg )

• OPTION_QEMU : Option to use with Create-VMQEmu : To add options to the QEmu VM

  • Default value in variable : DEFAULT_OPTION_QEMU
  • ( default value : "" )
  • Use also the read-only variables :
    • OPTION_QEMU_9P_HOSTHOME : configure the share of /home/user with the 9P protocol.
    • OPTION_QEMU_VWIFI : configure the VHOST protocol used by vwifi-client of vwifi

• if a variable is unset, the functions initialise it to this default value.

To test the success of the commands

• When the commands failed because the parameters used are incorrects
  • FAST_ERROR_RAIZO is set to a value different of zero
  • FAST_ERROR_RAIZO_LOG contains the message error

Functions

Create-VMQEmu

To create the configuration of a Qemu VM

• Create-VMQEmu 1 2 3 4 5 [6] [7] [8] [9]
  • 1 : Name Of VM in GNS3
  • 2 : Number of network card
  • 3 : Size of Memory in MB
  • 4 : Type of Access : telnet / spice / spice+agent / vnc / none
  • 5 : Shutdown by ACPI : true / false
  • 6 : If exist, path of the disk file 1
  • 7 : If exist, path of the disk file 2
  • 8 : If exist, path of the disk file 3
  • 9 : If exist, path of the disk file 4

This function returns the name of the temporary file to use with Add-ConfigVM-to-GNS3

Examples

Windows Server 2019

#!/usr/bin/bash

source /opt/raizo/api/Add-to-GNS3.sh
if (( $? ))
then
    return
fi

DIR_VDI="/media/usb0/vdi"

# Windows Server 2019

SYMBOL_QEMU="/symbols/raizo/microsoft_server.svg"

# On Processor AMD Ryzen, you should perhaps add :
# OPTION_QEMU="-cpu pentium2"

ConfigVM=$(Create-VMQEmu Win2019 1 2048 spice false "${DIR_VDI}/windows-2019-server.vhd")
if [ -n "${ConfigVM}" ]
then
                Add-ConfigVM-to-GNS3 "${ConfigVM}"
fi

Windows 10

#!/usr/bin/bash

source /opt/raizo/api/Add-to-GNS3.sh
if (( $? ))
then
    return
fi

DIR_VDI="/media/usb0/vdi"

SYMBOL_QEMU="/symbols/raizo/microsoft_guest.svg"

# On Processor AMD Ryzen, you should perhaps add :
# OPTION_QEMU="-cpu pentium2"

ConfigVM=$(Create-VMQEmu Win10 1 1024 spice false "${DIR_VDI}/windows-10.vdi")
if [ -n "${ConfigVM}" ]
then
                NetworkConfig=$(Create-NetworkConfig 1 "loc-area-con-" e1000)
                Modify-NetworkConfig "${NetworkConfig}" 0 port_name "loc-area-con-2"
                Add-NetworkConfig-to-VM "${ConfigVM}" "${NetworkConfig}"

                Add-ConfigVM-to-GNS3 "${ConfigVM}"
fi

Kali Linux

#!/usr/bin/bash

source /opt/raizo/api/Add-to-GNS3.sh
if (( $? ))
then
    return
fi

DIR_VDI="/media/usb0/vdi"

SYMBOL_QEMU="/symbols/raizo/hacker.svg"

TYPE_HARD_DISK="IDE"

# OPTION_QEMU_9P_HOSTHOME : Use 9P to share /home/user via hosthome : mount -t 9p hosthome /mnt
# OPTION_QEMU_VWIFI : To use the virtual wifi after installing and running vwifi-client from https://github.com/Raizo62/vwifi
OPTION_QEMU="${OPTION_QEMU_9P_HOSTHOME} ${OPTION_QEMU_VWIFI}"

ConfigVM=$(Create-VMQEmu KaliLinux 2 1024 spice false "${DIR_VDI}/linux-kali-2022.3-amd64.vmdk")
if [ -n "${ConfigVM}" ]
then
     Add-ConfigVM-to-GNS3 "${ConfigVM}"
fi

unset TYPE_HARD_DISK OPTION_QEMU SYMBOL_QEMU

ASA

#!/usr/bin/bash

source /opt/raizo/api/Add-to-GNS3.sh
if (( $? ))
then
     return
fi

DIR_VDI="/media/usb0/vdi"

TYPE_HARD_DISK='ide'
SYMBOL_QEMU='/symbols/asa.svg'
OPTION_QEMU='-no-kvm -icount auto'

ConfigVM=$(Create-VMQEmu ASA 6 1024 telnet false "${DIR_VDI}/ASA/FLASH")
if [ -n "${ConfigVM}" ]
then
     Modify-ConfigVM "${ConfigVM}" initrd "${DIR_VDI}/ASA/asa842-initrd.gz"
     Modify-ConfigVM "${ConfigVM}" kernel_command_line 'ide_generic.probe_mask=0x01 ide_core.chs=0.0:980,16,32 auto nousb console=ttyS0,9600 bigphysarea=65536 ide1=noprobe no-hlt -net nic'
     Modify-ConfigVM "${ConfigVM}" kernel_image "${DIR_VDI}/ASA/asa842-vmlinuz"
     Modify-ConfigVM "${ConfigVM}" port_name_format 'GigaEthernet{0}'

     Modify-ConfigVM "${ConfigVM}" category 'firewall'

     Add-ConfigVM-to-GNS3 "${ConfigVM}"
fi

unset TYPE_HARD_DISK OPTION_QEMU SYMBOL_QEMU

---

Docker

Global Variables

To change parameter of commands

• SYMBOL_DOCKER : To change the default symbol of the Docker device in GNS3

  • Default value in variable : DEFAULT_SYMBOL_DOCKER
  • ( Default value : /symbols/docker_guest.svg )

• if you unset a variable, the functions initialise it to this default value.

To test the success of the commands

• When the commands failed because the parameters used are incorrects
  • FAST_ERROR_RAIZO is set to a value different of zero
  • FAST_ERROR_RAIZO_LOG contains the message error

Functions

Add-PersistentFolder-to-VMDocker

To add a folder to the list of persistent folders of the Docker VM

• Add-PersistentFolder-to-VMDocker 1 2
  • 1 : File with config of New VM
  • 2 : Name of folder to set persistent

Create-VMDocker

To create the configuration of a Docker VM

• Create-VMDocker 1 2 3 4
  • 1 : Name Of VM in GNS3
  • 2 : Name of the Docker Image
  • 3 : Number of network card
  • 4 : Type of Access : telnet / http / https / vnc / none

This function returns the name of the temporary file to use with Add-ConfigVM-to-GNS3

Examples

Alpine

#!/usr/bin/bash

source /opt/raizo/api/Add-to-GNS3.sh
if (( $? ))
then
        return
fi

# alpine :

docker pull alpine

SYMBOL_DOCKER="/symbols/computer.svg"

ConfigVM=$(Create-VMDocker alpine "alpine:latest" 1 telnet)
if [ -n "${ConfigVM}" ]
then
        Add-PersistentFolder-to-VMDocker "${ConfigVM}"  "/etc/ssl"
        Add-ConfigVM-to-GNS3 "${ConfigVM}"
fi

---

Dynamips

Examples

Cisco C7200

#!/usr/bin/bash

source /opt/raizo/api/Add-to-GNS3.sh
if (( $? ))
then
        return
fi

cat > "c7200.gns3" <<EOF
        {
            "name": "c7200",
            "default_name_format": "R{0}",
            "usage": "ConsoleType=Cisco",
            "image": "c7200-advipservicesk9-mz.152-4.S5.bin",
            "symbol": ":/symbols/router.svg",
            "category": "router",
            "startup_config": "/opt/raizo/user/Config/GNS3/configs/Raizo_ios_base_startup-config.txt",
            "private_config": "",
            "console_type": "telnet",
            "console_auto_start": false,
            "platform": "c7200",
            "idlepc": "0x62cf0330",
            "idlemax": 500,
            "idlesleep": 30,
            "exec_area": 64,
            "mmap": true,
            "sparsemem": true,
            "ram": 512,
            "nvram": 512,
            "mac_addr": "",
            "disk0": 0,
            "disk1": 0,
            "auto_delete_disks": true,
            "system_id": "FTX0945W0MY",
            "compute_id": "local",
            "slot0": "C7200-IO-FE",
            "slot1": "PA-2FE-TX",
            "slot2": "",
            "slot3": "",
            "slot4": "",
            "slot5": "",
            "slot6": "",
            "midplane": "vxr",
            "npe": "npe-400",
            "template_id": "8b3b55a3-3644-4fc9-a494-b525165a2603",
            "template_type": "dynamips",
            "builtin": false
        }
EOF
cp "c7200.gns3" /tmp/c7200.gns3

Add-ConfigVM-to-GNS3 /tmp/c7200.gns3