Configure UDP serial mode for a serial port

The UDP serial mode option in the serial port configuration provides access to the serial port using UDP.

To change the configuration to match the serial configuration of the device to which you want to connect:

 

  1. Log into the IX30 WebUI as a user with full Admin access rights.

  2. On the menu, click System. Under Configuration, click Serial Configuration.

    The Serial Configuration page is displayed.

    Note You can also configure the serial port by using Device Configuration > Serial. Changes made by using either Device Configuration or Serial Configuration will be reflected in both.

  3. Click to expand the port that you want to configure for UDP serial mode.

    4. The serial port is enabled by default. To disable, toggle off Enable.

  4. For Mode, select UDP serial.

    5. The default is Remote.

  5. (Optional) For Label, enter a label that will be used when referring to this port.

  6. For Signalling, select the electrical signaling interface type used on this serial port:

    • RS-232
    • RS-422
      • Enable Termination if you want to enable electrical termination on this serial port.
    • RS-485
      • Enable Termination if you want to enable electrical termination on this serial port.

    The default is RS-232.

  7. Expand Serial Settings.

    1. For Baud rate, select the baud rate used by the device to which you want to connect.
    2. For Data bits, select the number of data bits used by the device to which you want to connect.
    3. For Parity, select the type of parity used by the device to which you want to connect.
    4. For Stop bits, select the number of stop bits used by the device to which you want to connect.
    5. For Flow control, select the type of flow control used by the device to which you want to connect.
  8. Expand Data Framing Settings.

    1. Click to expand Data Framing.
      1. Click Enable to enable the data framing feature.
      2. For Maximum Frame Count, enter the maximum size of the packet. The default is 1024.
      3. For Idle Time, enter the length of time the device should wait before sending the packet.
      4. For End Pattern, enter the end pattern. The packet is sent when this pattern is received from the serial port.
      5. Click Strip End Pattern if you want to remove the end pattern from the packet before it is sent.
  9. Expand UDP Serial Settings.

    1. For Local port, enter the UDP port. The default is 4001 or serial port 1, 4002 for serial port 2, etc.
    2. (Optional) For Socket String ID, enter a string that should be added at the beginning of each packet.
    3. For Destinations, you can configure the remote sites to which you want to send data. If you do not specify any destinations, the IX30 sends new data from the last IP address and port from which data was received. To add a destination:

      1. Click Add Destination. A destination row is added.

      2. (Optional) For Description, enter a description of the destination.

      3. For Hostname, enter the host name or IP address of the remote site to which data should be sent.

      4. For Port, enter the port number of the remote site to which data should be sent.

    10. To do this, you need to go to Device Configuration:

    1. On the menu, click System. Under Configuration, click Device Configuration.

      The Configuration window is displayed.

    2. Access the configuration for the appropriate type of service:

      1. Click to expand Serial.

      2. Click to expand the appropriate serial port.

      3. Click to expand UDP serial.

      4. Click to expand Access Control List.

      • To limit access to specified IPv4 addresses and networks:
        1. Click IPv4 Addresses.
        2. For Add Address, click .
        3. For Address, enter the IPv4 address or network that can access the device's service-type. Allowed values are:
          • A single IP address or host name.
          • A network designation in CIDR notation, for example, 192.168.1.0/24.
          • any: No limit to IPv4 addresses that can access the service-type.
        4. Click again to list additional IP addresses or networks.
      • To limit access to specified IPv6 addresses and networks:
        1. Click IPv6 Addresses.
        2. For Add Address, click .
        3. For Address, enter the IPv6 address or network that can access the device's service-type. Allowed values are:
          • A single IP address or host name.
          • A network designation in CIDR notation, for example, 2001:db8::/48.
          • any: No limit to IPv6 addresses that can access the service-type.
        4. Click again to list additional IP addresses or networks.
      • To limit access to hosts connected through a specified interface on the device:
        1. Click Interfaces.
        2. For Add Interface, click .
        3. For Interface, select the appropriate interface from the dropdown.
        4. Click again to allow access through additional interfaces.
      • To limit access based on firewall zones:
        1. Click Zones.
        2. For Add Zone, click .
        3. For Zone, select the appropriate firewall zone from the dropdown.

          See Firewall configuration for information about firewall zones.

        4. Click again to allow access through additional firewall zones.

  10. Expand Logging Settings to configure logging for this serial port.

    1. To enable logging, click to toggle on Enable.

    2. In the Log file name field, enter a descriptive name for the log file.

    3. For Log file size, type the size of the log file. When the log file reaches the size limit, the current file is saved and a new file is created. The default is 65536 bytes.

    4. From the Type of data to log list box, specify the type of data that should be saved.

      • Received

      • Transmitted

      • Both

      • Both with arrows. This is the default.

    5. If you want to log the time at which date was received or transmitted, click the Timestamps toggle to Enable.

    6. If you want to log the data as hexadecimal values, click the Hexadecimal toggle to Enable.

      Note You can review the message log in the Serial Port Log page. See Review the serial port message log.

  11. Click Apply to save the configuration and apply the change.
  1. Select the device in Remote Manager and click Actions > Open Console, or log into the IX30 local command line as a user with full Admin access rights.

    Depending on your device configuration, you may be presented with an Access selection menu. Type admin to access the Admin CLI.

  2. At the command line, type config to enter configuration mode:
    > config
(config)>
  3. The serial port is enabled by default. To disable:
    (config)> serial port1 enable false
(config)>
  4. Set the mode:
    (config)> serial port1 mode udp
(config)>

  5. Set the signaling interface type used on this serial port:

    • rs -232
    • rs -422
      • Enable Termination if you want to enable electrical termination on this serial port.
    • rs -485
      • Enable termination if you want to enable electrical termination on this serial port:
        (config)> serial port1 termination true
(config)>

    The default is rs-232.

  6. (Optional) Set a label that will be used when referring to this port.
    (config)>serial port1 label label
(config)>
  7. Set the baud rate used by the device to which you want to connect:
    (config)>serial port1 label baudrate rate
(config)>
  8. Set the number of data bits used by the device to which you want to connect:
    (config)>serial port1 label databits bits
(config)>
  9. Set the type of parity used by the device to which you want to connect:
    (config)>serial port1 label parity parity
(config)>

    Allowed values are:

    • even
    • odd
    • none

    The default is none.

  10. Set the stop bits used by the device to which you want to connect:
    (config)>serial port1 label stopbits bits
(config)>
  11. Set the type of flow control used by the device to which you want to connect:
    (config)>serial port1 label flow type
(config)

    Allowed values are:

    • none
    • rts/cts
    • xon/xoff

    The default is none.

    1. Enable data framing:
      (config)>serial port1 framing enable true
(config)
    2. Set the maximum size of the packet:
      (config)>serial port1 framing max_count int
(config)

      The default is 1024.

    3. Set the length of time the device should wait before sending the packet:
      (config)>serial port1 framing idle_time value
(config)

      where value is in milliseconds (ms) or seconds (s). The maximum value is 60s.

    4. Set the end pattern. The packet is sent when this pattern is received from the serial port:
      (config)>serial port1 framing end_pattern backslash-escaped-string
(config)
    5. Set the strip end pattern if you want to remove the end pattern from the packet before it is sent:
      (config)>serial port1 framing strip_pattern true
(config)
  13. Set the UDP port: 
    (config)> serial port1 udp port port
(config)>

    The default is 4001.

  14. (Optional) Enter a string that should be added at the beginning of each packet:
    (config)> serial port1 udp socketid backslash-escaped-string
(config)>
  15. Configure the remote sites to which you want to send data. If you do not specify any destinations, the IX30 send new data to the last hostname and port from which data was received. To add a destination:

    1. Add a destination:

      (config)> add serial port1 upd destination end
(config serial port1 udp destination 0)>

    2. (Optional) Enter a description of the destination:

      (config serial port1 udp destination 0)> description string
(config serial port1 udp destination 0)>

    3. Set the host name or IP address of the remote site to which data should be sent:

      (config serial port1 udp destination 0)>hostname hostanme-or-IP-address
(config serial port1 udp destination 0)>

    4. Set the port number of the remote site to which data should be sent:

      (config serial port1 udp destination 0)> port port
(config serial port1 udp destination 0)>

    1. Return to the root configuration prompt by typing ...:
      (config serial port1 udp destination 0)> ...
(config)>
    2. Set the Access Control List:
      • To limit access to specified IPv4 addresses and networks:
        (config)> add serial port1 udp acl address end value
(config)>

        Where value can be:

        • A single IP address or host name.
        • A network designation in CIDR notation, for example, 192.168.1.0/24.
        • any: No limit to IPv4 addresses that can access the service-type.

        Repeat this step to list additional IP addresses or networks.

      • To limit access to specified IPv6 addresses and networks:
        (config)> add serial port1 udp acl address6 end value
(config)>

        Where value can be:

        • A single IP address or host name.
        • A network designation in CIDR notation, for example, 2001:db8::/48.
        • any: No limit to IPv6 addresses that can access the service-type.

        Repeat this step to list additional IP addresses or networks.

      • To limit access to hosts connected through a specified interface on the IX30 device:
        (config)> add serial port1 udp acl interface end value
(config)>

        Where value is an interface defined on your device.

        Use ... network interface ? to display interface information:

        (config)> ... network interface ?

Interfaces

Additional Configuration
-------------------------------------------
 defaultip              Default IP  
 defaultlinklocal       Default Link-local IP
 eth1                   ETH1
 eth2                   ETH2
 loopback               Loopback 
 modem                  Modem 

(config)>

        Repeat this step to list additional interfaces.

      • To limit access based on firewall zones:
        (config)> add serial port1 udp acl zone end value
(config)>

        Where value is a firewall zone defined on your device, or the any keyword.

        Type ... firewall zone ? at the config prompt:

        (config)> ... firewall zone ?

Zones: A list of groups of network interfaces that can be referred to by packet
filtering rules and access control lists.

 Additional Configuration
 -------------------------------------------------------------------------------
  any
  dynamic_routes
  edge
  external
  internal
  ipsec
  loopback
  setup

(config)>

        Repeat this step to include additional firewall zones.

    • To limit access to specified IPv4 addresses and networks:
      (config)> add serial port1 udp acl address end value
(config)>

      Where value can be:

      • A single IP address or host name.
      • A network designation in CIDR notation, for example, 192.168.1.0/24.
      • any: No limit to IPv4 addresses that can access the service-type.

      Repeat this step to list additional IP addresses or networks.

    • To limit access to specified IPv6 addresses and networks:
      (config)> add serial port1 udp acl address6 end value
(config)>

      Where value can be:

      • A single IP address or host name.
      • A network designation in CIDR notation, for example, 2001:db8::/48.
      • any: No limit to IPv6 addresses that can access the service-type.

      Repeat this step to list additional IP addresses or networks.

    • To limit access to hosts connected through a specified interface on the IX30 device:
      (config)> add serial port1 udp acl interface end value
(config)>

      Where value is an interface defined on your device.

      Use ... network interface ? to display interface information:

      (config)> ... network interface ?

Interfaces

Additional Configuration
-------------------------------------------
 defaultip              Default IP  
 defaultlinklocal       Default Link-local IP
 eth1                   ETH1
 eth2                   ETH2
 loopback               Loopback 
 modem                  Modem 

(config)>

      Repeat this step to list additional interfaces.

    • To limit access based on firewall zones:
      (config)> add serial port1 udp acl zone end value
(config)>

      Where value is a firewall zone defined on your device, or the any keyword.

      Type ... firewall zone ? at the config prompt:

      (config)> ... firewall zone ?

Zones: A list of groups of network interfaces that can be referred to by packet
filtering rules and access control lists.

 Additional Configuration
 -------------------------------------------------------------------------------
  any
  dynamic_routes
  edge
  external
  internal
  ipsec
  loopback
  setup

(config)>

      Repeat this step to include additional firewall zones.

  17. Configure serial port logging:
    1. Enable serial port logging:
      (config)>serial port1 logging enable true
(config)>

    2. Set the file name:

      (config)>serial port1 logging filename string
(config)>

    3. Set the maximum allowed log size for the serial port log when starting the log:

      (config)>serial port1 logging size value
(config)>

      where value is the size of the log file in bytes. The default is 65536.

    4. Specify the data type:

      (config)>serial port1 logging type value
(config)>

      where value is one of:

      • received

      • transmitted

      • both

      • arrows. This is the default.

    5. Log the time at which date was received or transmitted:

      (config)>serial port1 logging hex true
(config)>

    6. Log data as hexadecimal values:

      (config)>serial port1 logging timestamp true
(config)>
  18. Save the configuration and apply the change
    (config)> save
Configuration saved.
>
  19. Type exit to exit the Admin CLI.

    Depending on your device configuration, you may be presented with an Access selection menu. Type quit to disconnect from the device.