Getting Started with iApps: Modifying an Existing iApp

section intro {
    message hello
    message check_for_updates
}

section options {
    choice display_help display "xxlarge" default "hide"


    optional ( options.display_help == "max" ) {
        message display_help_max
    }

    choice advanced display "xxlarge" default "no"


    optional ( options.display_help == "max" ) {
        message conf_mode_max
    }
}

section basic {
    choice forward_all display "xxlarge" default "No"

    optional ( options.display_help == "max" ) {
        message forward_all_max
    }
    optional ( forward_all == "No" ) {
        string addr default "0.0.0.0" required validator "IpAddress"
        optional ( options.display_help == "max" ) {
            message addr_max
        }
        string mask default "0.0.0.0" required validator "IpAddress"
        optional ( options.display_help == "max" ) {
            message mask_max
        }
        string port default "0" required validator "PortNumber"
        optional ( options.display_help == "max" ) {
            message port_max
        }
    }

    choice vlan_listening default "default" display "xxlarge"

    optional ( options.display_help == "max" ) {
        message vlan_listening_max
    }

    optional ( vlan_listening != "default" ) {
        multichoice vlan_selections display "xlarge" tcl {
            package require iapp 1.0.0
            set ::choices [iapp::get_items net vlan]
            return [iapp::safe_display ::choices]
        }

        optional ( vlan_listening == "enabled" ) {
            optional ( options.display_help == "max" ) {
                message vlan_selections_enabled_max
            }
        }

        optional ( vlan_listening == "disabled" ) {

            optional ( options.display_help == "max" ) {
                message vlan_selections_disabled_max
            }
        }
    }

    optional ( options.advanced == "yes" ) {
        choice l4_profile_to_use default "/#default#" display "xxlarge" tcl {
            package require iapp 1.0.0
            set ::choices "/#default#\n[iapp::get_items ltm profile fastl4]"
            return [iapp::safe_display ::choices]
        }

        optional ( options.display_help == "max" ) {
            message l4_profile_to_use_max
        }
    }
}

optional ( options.advanced == "yes" ) {
    section irules {
    message irule_1_max
        optional ( options.display_help == "max" ) {
            message irule_2_max
            message irule_3_max
        }

        multichoice irules display "xlarge" tcl {
            package require iapp 1.0.0
            set ::choices [iapp::get_items -filter NAME !~ "^_sys_" ltm rule]
            return [iapp::safe_display ::choices]
        }
    }
}

text {
    intro "Welcome to the IP Forwarding template"
    intro.hello "Introduction" "This template supports configuring the BIG-IP to perform IP traffic forwarding."
    intro.check_for_updates "Check for Updates" "Check for new versions of this template on the AskF5 Knowledge Base website (http://support.f5.com/kb/en-us/solutions/public/13000/400/sol13422.html)."

    options "Template Options"
    options.display_help "Do you want to see inline help?" {
         "Yes, show inline help" => "max",
         "No, do not show inline help" => "hide"
    }
    options.display_help_max "" "Inline help is available to provide contextual descriptions to aid in the completion of this configuration.  Select to show or hide the inline help in this template. Important notes and warnings are always visible, no matter which selection you make here."
    options.advanced "Which configuration mode do you want to use?" {
        "Basic - Use F5's recommended settings" => "no",
        "Advanced - Expose advanced options"    => "yes"
    }
    options.conf_mode_max "" "This template supports twp configurations modes. Basic mode exposes the most commonly used settings, and automatically configures the rest of the options.  Advanced mode allows you to review and change all settings."

    basic "Virtual Server Questions"
    basic.forward_all "Should this forward all traffic not destined for virtual servers?" {
        "Forward all IPv4 traffic" => "IPv4",
        "Forward all IPv6 traffic" => "IPv6",
        "Forward all IPv4 and IPv6 traffic" => "Yes",
        "Forward specific traffic" => "No"
    }
    basic.forward_all_max "" "Choose whether to have the BIG-IP system forward all traffic that is not destined for a virtual server, or only forward traffic on a specific network, port and/or VLAN that you define. If you select Yes, the system forwards all traffic.  If you select No, you must enter the address, mask, and port that define the traffic you want to forward."
    basic.addr "What network address do you want to use for this virtual server?"
    basic.addr_max "" "Specifies the address of the destination network, for example, 10.0.0.0.  The default 0.0.0.0 is a wildcard for all addresses, however you can still limit what is forwarded by netmask, port, or VLAN."

    basic.mask "What is the netmask for that address?"
    basic.mask_max "" "Specifies the netmask, for example 255.255.255.0. The default 0.0.0.0 is a wildcard for any netmask."

    basic.port "What port do you want this virtual server to use?"
    basic.port_max "" "Specifies a specific port for forwarding traffic, for example 22. The default 0 is a wildcard for any port."
    basic.vlan_listening "What VLANs should this IP Forwarding virtual server listen on?" {
        "All VLANs" => "default",
        "Enabled on ..." => "enabled",
        "Disabled on ..." => "disabled"
    }
      basic.vlan_listening_max "" "You can choose to forward traffic from all VLANs or just from some of them. If you don't want to enable all VLANs, you can choose to include or exclude named VLANs and forward traffic from all of the rest."
    basic.vlan_selections "On which VLAN(s) should this IP Forwarding virtual server listen?"
    basic.vlan_selections_enabled_max "" "Select the VLANs from which traffic will be forwarded."

    basic.vlan_selections_disabled_max "" "Select the VLANs from which traffic NOT will be forwarded."
    basic.l4_profile_to_use "What Fast L4 profile do you want to use?" {"Use F5's recommended Fast L4 profile" => "/#default#"}

    basic.l4_profile_to_use_max "" "If you created a custom Fast L4 profile, you can select it from the list. This is not required for most purposes, and only necessary if you need to replace the default Fast L4 profile functionality."

    irules "iRules"
    irules.irules "Do you want to add any custom iRules to this configuration?"

    irules.irule_1_max "WARNING" "Improper use or misconfigurations of an iRule can result in unwanted application behavior and poor performance of your BIG-IP system. For this reason we recommended you verify the impact of an iRule prior to deployment in a production environment."

    irules.irule_2_max "" "The BIG-IP system supports a scripting language to allow an administrator to instruct the system to intercept, inspect, transform, direct and track inbound or outbound application traffic. An iRule contains the set of instructions the system uses to process data flowing through it, either in the header or payload of a packet."

    irules.irule_3_max "" "Correct event priority is critical when assigning multiple iRules. For more information about iRule event priority, see https://devcentral.f5.com/s/wiki/iRules.priority.ashx"
}

package require iapp 1.0.0
iapp::template start

set app         $tmsh::app_name

# VLANS
# array keys: $::basic__vlan_listening
array set vlans {
    enabled  { vlans-enabled vlans replace-all-with \{ $::basic__vlan_selections \} }
    disabled { vlans-disabled vlans replace-all-with \{ $::basic__vlan_selections \} }
    default  { vlans-disabled vlans none }
}
iapp::conf create ltm virtual ${app}_IPv4_Forwarding \
    ip-forward \
    destination $::basic__addr:any mask $::basic__mask \
    [iapp::substa vlans($::basic__vlan_listening)]

iapp::template stop