Jump to:navigation, search
Wiki

CLI command: Interface

From Securepoint Wiki
















































































































De.png
En.png
Fr.png






Syntax of the CLI command interface
Last adaption: 12.1
New:
notempty
This article refers to a Resellerpreview

11.8.12 11


  • If multiple values are passed for a parameter, the values must be enclosed in square brackets with a space(!) between [ . Example: interface zone set id 4711 flags [ POLICY_IPSEC PPP_VPN ]
  • If no values are to be passed for a parameter, two square brackets must be used. Example interface set name LAN1 flags [ ]


  • Changes to the IP address are only applied with the system update interface command

    • Command Parameter Description Example

    interface

    interface get

    interface get     		- Listing of all interfaces
    • Name
    • Type
    • Flags
    • QoS specifications
    • Zones
    • Options
    • adi (additional device info):
      • MTU
      • Speed
      • Duplex-Status
      • Autonegotiation
    • Status (up, down, unknown)
    		 interface get

    interface new

    interface new     		Create a new interface. The parameters name and type are required. The other parameters can be combined arbitrarily. interface new name "eth6" type ETHERNET
    name Name of the interface to be configured.
    type Interface type.
    • ETHERNET
    • PPPOE
    • PPTP
    • WLAN
    • TUN
    • VLAN
    • 6IN4
    • MOBILE
    • GRE
    • BRIDGE
    • BOND
    zones Zone assigned to the interface
    flags flags [ flag1 flag2 ]
    Value Description
    AUTOCONF Enables ip6 autoconf on the interface
    DHCP Obtain IPv4 address via DHCP
    DHCP6 Obtain IPv6 address via DHCP
    DHCP6_PREFIX Obtain IPv6 address via DHCP and pass it to IPv6 interface (IPv6 prefix delegation)
    DISABLED Disables the interface
    DISABLED_IF_SPARE Disables the interface if it is running as spare in the cluster
    DYNADDR Currently without function
    DYNDNS Uses DynDNS. Requires additional values in the options parameter
    HA Uses the interface in High Availability mode (only in cluster mode)
    HOTWIRE Uses the interface as a hotwire interface (only in cluster mode)
    IP6ADV Uses Router Advertisment for IPv6
    options options [ option_name=option_value option2_name=option2_value ... ]
    Group Value Description
    6in4 6in4_local_v4 Local IPv4 address
    6in4_local_v6
    6in4_remote_v4
    6in4_remote_v6
    6in4_tunnel_id
    6in4_type
    6in4_user_name
    6in4_user_pass
    autonegotiation autonegotiation=on allowed
    bridge bridge_interfaces
    bridge_stp
    bridge_priority
    debug
    duplex
    DynDNS dyndns_hostname DynDNS host name used
    dyndns_mx IP for mail-excange dns record
    dyndns_password
    dyndns_server Host that provides the DynDNS service.
    dyndns_user
    dyndns_ipv4
    dyndns_ipv6
    dyndns_webresolver
    dyndns_interval
    gre gre_local
    gre_nopmtudisc Forces the fragmentation
    gre_remote
    mtu
    fallback fallback_dev
    ping_check_host
    ping_check_interval
    ping_check_threshold
    PPPoE / PPTP ppp_lcp
    ppp_lcp_echo_failure
    ppp_lcp_echo_interval
    ppp_password
    ppp_redial
    ppp_timeout
    ppp_user
    ppp_enable_ipv6
    pppoe_parent
    pptp_modem_ip
    route_hint
    speed
    vlan vlan_id
    vlan_parent
    QoS qos_max_upstream
    qos_max_downstream
    qos_max_hosts
    qos QoS profile of the interface.
    id / adi Parameter not in use

    interface set

    interface set     		name Editing an interface. The name parameter is required. The other parameters can be added arbitrarily. interface set name "eth6" options mtu=1400
    The other parameters and their syntax are identical to the command interface new

    interface delete

    interface delete     		name Removing an interface. The name parameter is required. interface delete name eth6

    interface rename

    interface rename     		id id of the interface whose name is to be changed
    (Can be determined beforehand with interface get     		interface rename id 156 name A99.7
    Detailed example in the FAQ
    name New name of the interface

    interface address

    interface address get

    interface address get     		- Listing of all IP addresses interface address get

    interface address get_old_list

    interface address get_old_list     		- Output of a list of IP addresses from the configuration that is stored in the version rollback. interface address get_old_list

    interface address new

    interface address new     		device Adding an IP address to an interface. Parameter device: Depending on the version with the prefix eth or LAN. interface address new device "eth2" address 192.168.32.1/24
    system update interface
    address IPv4 or IPv6 address with subnet

    interface address set

    interface address set     		id Changing an IP address.
    The ID of the interface can be determined with the command interface address get.
           		interface address set id "43" address 192.168.33.1/24
    system update interface
    address

    interface address delete

    interface address delete     		id Removing an IP address.
    The ID of the interface can be determined with the command interface address get.
           		interface address delete id 43
    system update interface

    interface zone

    interface zone get

    interface zone get     		- Listing of all zones
    • id
    • name
    • interface (Assigned interface)
    • flags
    • references
    		 interface zone get

    interface zone new

    interface zone new     		name Adding a zone interface zone new name dmz10

    interface zone set

    interface zone set     		id Adding a zone to an interface
    The ID of the zone can be determined with the command interface zone get.
           		interface zone set id "213" interface eth2
    flags
    interface
    name

    interface zone delete

    interface zone delete     		id Removing a zone from an interface
    The ID of the zone can be determined with the command interface zone get.
           		interface zone delete id "213"

    interface neighbor

    interface neighbor get

    interface neighbor get     		- List of hosts that are reachable from the UTM interface neighbor get

    interface mobile

    interface mobile status

    interface mobile status     		- Indicates the status for sim, modem, 3gpp and stats interface mobile status

    interface mobile sim

    interface mobile sim sendpin     		modem Syntax: interface mobile sim sendpin modem <id> pin <pin>
    Send the PIN to unlock the SIM card.
    The modem ID can be inquired with interface mobile modem get.
    		interface mobile sim sendpin modem 1 pin 1234
    pin
    interface mobile sim enable modem Syntax: interface mobile sim enable modem <id> pin <pin>
    Enable PIN checking.
    The modem ID can be inquired with interface mobile modem get.
    		interface mobile sim enable modem 1 pin 1234
    pin
    interface mobile sim disable modem Syntax: interface mobile sim disable modem <id> pin <pin>
    Disable PIN checking.
    The modem ID can be inquired with interface mobile modem get.
    		interface mobile sim disable modem 1 pin 1234
    pin
    interface mobile sim change modem Syntax: interface mobile sim change modem <id> pin <current_pin> newpin <new_pin>
    Changes the PIN code.
    The modem ID can be inquired with interface mobile modem get.
    		interface mobile sim change modem 1 pin 1234 newpin 5678
    pin
    newpin
    interface mobile sim sendpuk modem Syntax: interface mobile sim sim sendpuk modem <id> puk <puk> newpin <new_pin>
    Send the PUK (Personal unlocking key / Super-Pin) and a new PIN to unlock the SIM card.
    The modem ID can be inquired with interface mobile modem get.
    		interface mobile sim sim sendpuk modem 1 puk 12345678 newpin 2345
    puk
    newpin

    interface mobile modem

    interface mobile modem get     		- interface mobile modem get
    interface mobile modem new Syntax:interface mobile modem new bearerid <int> pin <pin> enabled <0|1> equipmentid <string>
    Creates a new modem entry.     		interface mobile modem new bearerid 1 pin 1234 enabled 1 equipmentid 8611070301234560
    bearerid The ID of the provider entry.
    Retrieval with: interface mobile modem get
    pin
    enabled Sets the newly configured modem in activated (1) or deactivated (0) state
    equipmentid The IMEI of the modem used.
    interface mobile modem set id Syntax:interface mobile modem set id <id>bearerid <int> pin <pin> enabled <0|1> equipmentid <string>
    Changes the modem settings.
    The parameter id is required     		interface mobile modem id 1 bearerid 1 pin 1234 enabled 1 equipmentid 8611070301234560
    abc The other parameters and their syntax are identical to the command modem mobile modem new
    interface mobile modem enable modem Syntax:interface mobile modem enable <id>
    Enables the given modem.     		interface mobile modem enable modem 1
    interface mobile modem disable modem Syntax:interface mobile modem disable <id>
    Disables the given modem.     		interface mobile modem disable modem 1
    interface mobile modem delete id Syntax:interface modem mobile delete id <id>
    Deletes a modem entry.     		interface mobile modem delete id 1

    interface mobile bearer

    interface mobile bearer get     		- Syntax: interface mobile bearer get
    Retrieves the provider configuration. Multiple configurations can be saved.     		interface mobile bearer get
    interface mobile bearer new carrier Syntax: interface mobile bearer new carrier <carrier> apn <apn> password <password> username <username> proxy <ipaddr> port <port> operatorid <id> roaming <0/1> limit <limit> billingstart <1-31>
    Creates a new provider configuration
    apn Access Point Name. DNS name of the access server of the provider.
    password
    username
    proxy
    port
    operatorid Operator ID of the mobile network operator
    roaming Parameter not in use
    limit Parameter not in use
    billingstart Parameter not in use
    interface mobile bearer set id Syntax: interface mobile bearer set id <id> carrier <carrier> apn <apn> password <password> username <username> proxy <ipaddr> port <port> operatorid <id> roaming <0/1> limit <limit> billingstart <1-31>
    Changes the settings of the provider     		interface mobile bearer set id 1 carrier "Telekom Internet" apn internet.telekom password telekom username telekom operatorid 26201 roaming 0
    abc The other parameters and their syntax are identical to the command interface mobile bearer new
    interface mobile bearer delete id Syntax: interface mobile bearer delete id <id>
    Deleting a provider entry.     		interface mobile bearer delete id 1
    Retrieved from "https://wiki.securepoint.de/index.php?title=UTM/CLI/Interface&oldid=82769"