Applies To:

Show Versions Show Versions

Archived Manual Chapter: BIG-IP Link Controller Reference Guide v4.3: bigpipe Command Reference
Manual Chapter
Table of Contents   |   << Previous Chapter   |   Next Chapter >>

This article has been archived, and is no longer maintained.



A

bigpipe Command Reference



bigpipe commands

This chapter lists the various bigpipe commands, including syntax requirements and functional descriptions. Table A.1 outlines the conventions used in the command line syntax.

Command line conventions

Item in text

Description

\

Continue to the next line without typing a line break.

< >

You enter text for the enclosed item. For example, if the command has <your name>, type in your name.

|

Separates alternate options for a command.

[ ]

Syntax inside the brackets is optional.

...

Indicates that you can type a series of items.

The following table provides a concise listing of the individual bigpipe commands, along with the page reference where you can find the detailed description.

Command

Description

-?

Displays online help for an individual bigpipe command.

config

Synchronizes the /config/bigip.conf between the two Link Controller units in a redundant system.

conn

Shows information about current connections such as the source IP address, virtual server and port, and node.

default_gateway

Creates a pool of default gateways.

failover

Sets the Link Controller as active or standby.

global

Sets global variable definitions.

-h and help

Displays online help for bigpipe command syntax.

interface

Sets options on individual interfaces.

load

Loads the Link Controller configuration and resets.

maint

Toggles the Link Controller into and out of maintenance mode.

merge

Loads a saved Link Controller configuration without resetting the current configuration.

mirror

Copies traffic from any port or set of ports to a single, separate port.

monitor

Defines a health check monitor.

-n

Displays addresses and ports numerically rather than by name.

nat

Defines external network address translations for nodes.

node

Defines node property settings.

pool

Defines load balancing pools.

ratio

Sets load-balancing weights and priority levels used in the Ratio and Priority load balancing modes.

reset

Clears the Link Controller configuration and counter values.

save

Writes the current configuration to a file.

self

Assigns a self IP address for a VLAN or interface.

service

Defines properties for services.

snat

Defines and sets options for SNAT (Secure NAT).

stp

Implements spanning tree protocol (STP).

summary

Displays summary statistics for the Link Controller.

trunk

Aggregates links to form a trunk.

unit

Displays the unit number assigned to a particular Link Controller.

verbose

Used to modify the verbose log level.

verify

Parses the command line and checks syntax without executing the specified command.

version

Displays the bigpipe utility version number.

virtual

Defines virtual servers, virtual server mappings, and virtual server properties.

vlan

Defines VLANs, VLAN mappings, and VLAN properties.

vlangroup

Defines VLAN groups.

-?

b <command> -?

For certain commands, displays online help, including complete syntax, description, and other related information. For example, to see online help for the bigpipe service command, type:

b service -?

config

b config save <file>

b config install <file>

b config sync

b config sync all

b config sync running

Manages user configuration sets. A user configuration set (UCS) is the set of all configuration files that a user may edit to configure a Link Controller. A UCS file is an archive that contains all the configuration files in a UCS.

The config command allows you to save the system configuration to a UCS file, install the configuration from a UCS file, and synchronize the configuration with the other systems in a redundant pair.

Options

The config save <file> option saves the currently running configuration to /config/bigip.conf and /config/bigip_base.conf, and creates the UCS file with the file name specified by <file>.

The config install <file> option unpacks and installs the UCS file specified by <file>, overwriting all configuration files, including the file /config/bigip.conf.

The config sync option saves the currently running configuration to the file /config/bigip.conf and copies the file /config/bigip.conf to the other Link Controller in a redundant pair.

The config sync all option creates a temporary UCS file and transfers it to the other Link Controller.

The config sync running option saves the currently-running configuration to a temporary file and copies it to the other Link Controller.

Saving configuration files to an archive

The config save <file> command saves all configuration files to a single archive file, <file>.ucs, on the local unit without copying it to the standby unit. By default, <file>.ucs is saved to the directory /user/local/ucs. An alternate location can be specified by expressing <file> as a relative or absolute path. For example:

b config save /user/local/config_backup/my_conf

This writes the file my_conf.ucs to the directory /user/local/config_backup.

Installing an archived configuration file

config install <file> reinstalls the archived configuration files saved as <file>.ucs to their working locations on the local unit.

If you use command line utilities to set configuration options, be sure to save the current configuration to the relevant files before you use the configuration synchronization feature. (Alternatively, if you want to test the memory version on the standby unit first, use bigpipe config sync running.) Use the following bigpipe command to save the current configuration:

b save

Note: A file named /usr/local/ucs/cs_backup.ucs is created prior to installing a UCS from a remote machine.

Synchronizing configuration files

config sync without the all option synchronizes only the basic configuration file /config/bigip.conf.

config sync all synchronizes the following configuration files:

  • The common BIG/db keys
  • All common files in /config
  • All common files in /etc

config sync running synchronizes the running version of /config/bigip.conf, which is the image that resides in memory as the system runs. This file is loaded into memory on the standby unit, it is not saved.

Note: The config sync command applies only to Link Controller and not to 3-DNS.

config save <file> saves all configuration files to a single archive file, <file>.ucs, on the local unit without copying it to the standby unit. By default, <file>.ucs is saved to the directory /user/local/ucs. An alternate location can be specified by expressing <file> as a relative or absolute path. For example:

b config save /user/local/config_backup/my_conf

This writes the file my_conf.ucs to the directory /user/local/config_backup.

conn

b conn [ <client_ip>[:<client_service>] ] dump [mirror]

Displays information about current client connections to virtual addresses and virtual servers. This command can also show connections that are active on the given Link Controller, as well as those that are standby connections for the peer Link Controller. By default, the dump command only shows items that are active on the given unit.

Displaying all current connections

The following command displays all current client connections:

b conn dump

The output shows the source IP address, virtual server IP address, and node to which the client is connected.

Figure A.1 Formatted output of the conn command

 bigip conn dump    

from virtual node
100.100.100.30:49152 -> 100.100.100.100:23 -> 200.200.200.10:23
100.100.101.90:49153 -> 100.100.100.100:80 -> 200.200.200.10:80
...

This command can also show connections that are active on the given Link Controller, as well as those that are standby connections for the peer Link Controller. By default, the dump command only shows items that are active on the given unit.

Displaying connections for a specific virtual server

Use the following syntax to display the current connections for a specific virtual server:

b conn <client_ip>[:<client_service>] dump

Note that the argument <client_service> refers to what is typically a five-digit number displayed in the output of this command.

Displaying standby connections

To view standby items, you must use the mirror qualifier, as follows.

b conn dump mirror

default_gateway

b default_gateway use pool <pool_name>

b default_gateway show

b default_gateway delete

This command creates, shows, or deletes a pool of default gateways, with nodes in the pool corresponding to different routes. Connections originating from the system with a destination for which there is no other route choose a route from the default gateway pool. Note that the default gateway pool is not a last-hop pool for services running on the system.

There can be only one default gateway pool at any one time.

Defining a default gateway pool removes the need to define a default route. However, if a default route is defined, that route will be used when all the nodes in the default gateway pool are down.

Since the system performs route lookups on nodes as they are defined, the default gateway pool must be stored at the top of the bigip.conf file. Also, all nodes in the default gateway pool must reside on the same IP network as the system.

We recommend that all nodes in the default gateway pool have the same MTU.

As an alternative to using the default_gateway command, you can use the Setup utility, which allows you to create the default gateway pool at the time that you configure your base network.

Options

The use pool <pool_name> option specifies the name of the default gateway pool and must be 1-31 characters in length. Example: my_pool.

The show option shows the members of the default gateway pool.

The delete option deletes the default gateway pool.

failover

b failover standby | show | init | failback

Switches the Link Controller to be the standby unit in a redundant configuration. This command should be used with care, and is provided only for special situations. The Controller automatically switches between active and standby modes, without operator intervention.

Options

The standby option switches the Link Controller to the standby unit.

The show option displays the node on which the Link Controller is currently running.

The init option initializes the Link Controller's initial state.

Changing failover state

Before you switch the current mode, first determine which mode the Controller is running using the command above. In an active/standby or active-active configuration, run the following command to switch the Controller to be the standby unit:

b failover standby

Displaying failover status

Show the status of the Link Controller with the following command:

b failover show

Initializing failover state

You can use the bigpipe failover init command to refresh the parameters of the failover mechanism with any new configuration data entered into the BIG/db database.

b failover init

global

b global auto_lasthop enable | disable | show

b global fastest_max_idle_time <seconds>

b global fastflow_active auto | on | off | show

b global fastflow_active auto | on | off | show

b global gateway failsafe arm | disarm | show

b global ipforwarding enable | disable

b global mirror enable | disable | show

b global memory_reboot_percent <percent>

b global open_3dns_ports enable | disable | show

b global open_corba_ports enable | disable | show

b global open_snmp_ports enable | disable | show

b global open_telnet_port enable | disable

b global open_ftp_ports enable | disable

b global open_ssh_port enable | disable

b global open_rsh_ports enable | disable

b global open_failover_ports enable | disable | show

b global persist_map_proxies enable | disable

b global persist timer limit | timeout | show

b global persist across_services enable | disable

b global persist across_virtuals enable | disable

b global self_conn_timeout enable | disable | show

b global sticky table_limit <max_num> | show

b global verbose_log_level <level>

b global webadmin_port <port>

b global l2_aging_time <seconds>

auto_lasthop

When this variable is enabled, it automatically designates the lasthop router inside IP address as a lasthop route for replies to inbound traffic. If auto_lasthop is disabled, the lasthop router inside IP address must be specified as a lasthop pool. The default setting is enable.

fastest_max_idle_time

Sets the number of seconds a node can be left idle by the fastest load balancing mode. This forces the Link Controller to send fewer connections to a node that is responding slowly, and also allows the Link Controller to periodically recalculate the response time of the slow node.

fastflow_active

You can use this variable to control additional enhancements that speed packet flow for TCP connections when the packets are not fragmented. In most configurations these software enhancements are automatically turned on and do not require any additional configuration.

However, you may want to turn off these enhancements for individual virtual servers that use IPFW rate filters. With the speed enhancements on, IPFW only examines the first SYN packet in any given connection. If you want to filter all packets, you should turn the speed enhancements off. To do this, you first set the global state of the system on, and then you turn the feature off for individual virtual servers that use IPFW rate filtering. You can also change the settings for these enhancements from the command line or in the Configuration utility.

There are three global states you can set with fastflow_active. The default state is auto. The global states are:

  • off
  • auto
  • on

The additional speed enhancements are globally disabled if the sysctl variable fastflow_active is off or if fastflow_active is set to auto and an IPFW rate filter exists in the configuration.

To provide the benefits of software acceleration for virtual servers that do not use rate filtering and turn off software acceleration for virtual servers that use IPFW rate filtering, you can set the global variable fastflow_active to on with the following command:

b global fastflow_active on

After you set the sysctl variable, use the following bigpipe command to disable software acceleration for virtual servers that use IPFW rate filtering:

b virtual <ip>:<port> accelerate disable

gateway failsafe

Turns the gateway fail-safe feature on and off. This command is supported only for redundant systems.

The typical use of gateway fail-safe is a setup where active and standby Link Controller units use different routers as gateways to the Internet. Fail-over is triggered if the gateway for the active unit is unreachable.

To arm fail-safe on the gateway, enter the following command:

b global gateway failsafe arm

To disarm fail-safe on the gateway, enter the following command:

b global gateway failsafe disarm

To see the current fail-safe status for the gateway, enter the following command:

b global gateway failsafe show

For more information about configuring gateway fail-safe, see Health monitors, on page 2-79 .

ip forwarding

Enables IP forwarding for the Link Controller. IP forwarding exposes all of the node IP addresses to the external network, making them routable on that network. The default setting is disabled.

mirror

Enables mirroring functions globally for the Link Controller. The mirror feature duplicates the active unit's real-time connection or persistence information state on the standby unit for smooth transition to the inactive unit at fail-over. The default setting is enabled.

memory_reboot_percent

The value you type, 80 or higher, is the percentage of memory that is in use before the Link Controller automatically reboots. The default value for this variable is 95. To disable this feature, set the value to 0.

open_3dns_ports

This variable is required only when running one or more separate 3-DNS Controllers in the network. It does not apply to running the 3-DNS software module on the Link Controller itself. The variable is disabled on the Link Controller when the 3-DNS Controller is not present in the network configuration.

open_corba_ports

This variable enables and disables the CORBA ports, which allow administrative CORBA connections. The default setting is disabled.

open_snmp_ports

This variable enables and disables the SNMP ports, which allow administrative SNMP connections. The default setting is disabled.

open_telnet_port

This variable enables or disables ports for Telnet access, and the default setting is disable.

The following command sets this variable to open the Telnet port (23) to allow administrative Telnet connections. This is useful for Link Controller units that do not support encrypted communications, or for a unit that needs to communicate with the 3-DNS software.

The following command opens the Telnet port:

b global open_telnet_port enable

The following command closes the Telnet port:

b global open_telnet_port disable

open_ftp_ports

This variable enables or disables ports for FTP access, and the default setting is disable.

The following command open the FTP ports (20 and 21) to allow administrative FTP connections, which is useful for Link Controller units that do not support encrypted communications.

b global open_ftp_ports enable

The following command closes FTP ports:

b global open_ftp_ports disable

open_ssh_ports

This variable enables or disables ports for SSH access on Link Controller units that support encrypted communication. The default setting is enable.

The following command opens the SSH port (22) to allow encrypted administrative connections:

b global open_ssh_port enable

The following command closes the SSH port:

b global open_ssh_port disable

open_rsh_ports

This variable enables or disables ports for RSH access, and it is useful for Link Controller units that do not support encrypted communications, or for connecting to 3-DNS Controllers that do not support encrypted communication.

The default setting is disable.

The following command opens the RSH ports (512, 513, and 514) to allow RSH connections:

b global open_rsh_ports enable

The following command closes RSH ports:

b global open_rsh_ports disable

open_failover_ports

This variable enables or disables network failover when a VLAN has port lockdown enabled.

The following command enables network failover:

b global open_failover_ports enable

The following command disables network failover:

b global open_failover_ports disable

persist map_proxies

The default setting for the map proxies for the persistence variable is enable. The AOL proxy addresses are hard-coded. This enables you to use client IP address persistence with a simple persist mask, but forces all AOL clients to persist to the same server. All AOL clients will persist to the node that was picked for the first AOL client connection received.

The class B networks, 195.93 and 205.188, are mapped to 152.163 for persistence. For example, client 195.93.3.4 would map to 152.63.3.4 for persistence records only. This mapping is done prior to applying the persist mask. Use bigpipe pool persist dump to verify that the mapping is working.

We recommend that in addition to setting this sysctl variable, you set a persist mask of 255.255.0.0 so that all the AOL addresses map to a common address. For example, Table A.2 is an example of how setting this variable and a persist mask of 255.255.0.0 would map a sample set of client addresses.

Address mapping of sample clients

Sample Client Address

Persist Address

152.44.12.3

195.93.0.0

152.2.99.7

195.93.0.0

170.11.19.22

195.93.0.0

202.67.34.11

195.93.0.0

205.188.11.2

195.93.0.0

208.33.23.4

208.33.0.0 (non AOL address is not mapped)

persist timer

The following command forces the persistent connection timer to reset on each packet for persistent sessions. This is the default value.

b global persist timer limit

The following command resets the timer only when the persistent connection is initiated.

b global persist timer timeout

Note: For SSL persistence, the timer is always reset on each packet.

persist across_services

When this variable is enabled, all simple persistence connections from a client IP address that go to the same virtual address also go to the same node (matches the client address and the virtual IP address but not the virtual port).

The default setting for this variable is disabled.

persist across_virtuals

When this variable is enabled, all simple persistent connections from the same client IP address are sent to the same node (matches the client IP address but not the virtual address or virtual port the client is using). The default setting for this variable is disabled.

self_conn_timeout

This variable is used as a tracking mechanism for UDP connections. After the number of seconds specified by this variable has expired, the UDP connection terminates. The default value for this variable is 5.

sticky table_limit

This is the maximum number of sticky entries allowed to accumulate on the Link Controller when using destination address affinity (sticky persistence). When the maximum value is reached, the Link Controller stops accumulating sticky entries. The default value for this entry is 2048.

verbose_log_level

This variable sets logging levels for both TCP and UDP traffic. Each log level is identified by a level number used in place of the <level> parameter.

The following command turns on port denial logging for both TCP and UDP traffic. This logs TCP and UDP port denials to the virtual server address and the Link Controller address.

b global verbose_log_level 15

The following command turns logging off altogether:

b global verbose_log_level 0

Setting log levels only for TCP traffic

The following command turns on only TCP port denial logging, which logs TCP port denials to the Link Controller address.

b global verbose_log_level 2

The following command turns on virtual TCP port denial logging, which logs TCP port denials to the virtual server address.

b global verbose_log_level 8

Setting log levels for UDP traffic

The following command turns on only UDP port denial logging, which logs UDP port denials to the Link Controller address.

b global verbose_log_level 1

The following command turns on only virtual UDP port denial logging, which logs UDP port denials to the virtual server address.

b global verbose_log_level 4

webadmin_port

Specifies the port number used for administrative web access. The default port for web administration is port 443.

l2_aging_time

Specifies a time period after which dynamic entries in the L2 forwarding table are flushed out if the MAC address is no longer present on the network. The default value is 300 seconds.

-h and -help

b [-h | -help ]

Displays the bigpipe command syntax or usage text for all current commands.

Note: More detailed man pages are available for some individual bigpipe commands. To display detailed online help for the bigpipe command, type: man bigpipe.

interface

b interface show

b interface [<interface_name>] show [verbose]

b interface <inteface_name> media show

b interface <inteface_name> duplex show

b interface <interface_name> media <media_type>

b interface <interface_name> duplex full | half | auto

b interface [<interface_name>] stats reset

b interface <interface_name> enable | disable

b interface <interface_name> renames <driver_name>

Displays the names of installed network interface cards and, for each interface, sets properties such as MAC address, media options, duplex mode, and status, resets interface statistics, enable or disable interfaces, and change driver name mappings.

Options

The <interface_name> variable is a name such as 3.1, where 3 is the physical slot number holding the network interface hardware and 1 is the physical port number on that interface on that hardware.

The show [verbose] option displays the current status, settings, and network statistics for the specified interface. The verbose argument provides more detailed information. If no interface is specified, this option displays information for all interfaces.

The media show option displays information about the media type for the specified interface.

The duplex show option displays the duplex mode of the specified interface.

The media <media_type> option is a valid media type for the specified interface. Examples include auto, 100baseTX, and 10baseT. Note that only certain combinations of media type and duplex mode are valid for any particular type of interface.

The duplex full | half | auto option sets the duplex mode of the specified interface.

The stats reset option resets the statistics for the specified interface.

The enable | disable option enables or disables the specified interface.

The renames <driver_name> option changes the mapping from the interface's driver name to its physical location name. The <driver_name> option is the network interface name in the form of driver and unit number, such as exp0 and bs1. Note that this is the old-style network interface name.

Displaying interface information

To display the status, settings, and statistics for all interfaces on the Link Controller, use the following command.

b interface show [verbose]

To display the status, settings, and statistics for a specific interface on the Link Controller, use the following command-line syntax.

b interface <interface_name> show [verbose]

Note that if the verbose argument is used, the output provides additional information on status. If the verbose argument is not used, the output focuses on statistics.

To display the media type for an interface, use the following command-line syntax,

b interface <interface_name> media show

To display the duplex mode for an interface, use the following command-line syntax.

b interface <interface_name> duplex show

Setting the media type

The media type may be set to the specific media type for the interface card or it may be set to auto for auto detection. If the media type is set is set to auto and the card does not support auto detection, the default type for that interface will be used, for example 1000BaseTX.

To set the media type, use the following command-line syntax.

b interface <interface_name> media <media_type>

Setting the duplex mode

Duplex mode may be set to full, half duplex, or auto. If the media type does not allow duplex mode to be set, this will be indicated by an onscreen message. If media type is set to auto, or if setting duplex mode is not supported, the duplex setting will not be saved to the bigip.conf file.

To set the duplex mode, use the following command-line syntax.

b interface <interface_name> duplex full | half | auto

Resetting statistics

You can reset interface statistics for all interfaces or for a specific interface.

To reset statistics for all interfaces, use the following command.

b interface stats reset

To reset statistics for a specific interface, use the following command-line syntax:

b interface <interface_name> stats reset

Enabling or disabling an interface

Enabling or disabling an interface allows you to control whether the interface receives and sends packets. If an interface begins to behave strangely, you disable and then enable the interface to effectively reset it.

To enable or disable an interface, use the following command-line syntax.

b interface <interface_name> enable | disable

Changing driver name mapping

You can change the mapping from an interface's driver name to its physical location name, using the following syntax.

b interface <interface name> renames <driver name>

load

b [verify] load [ <filename> | - ]

b [-log] load [ <filename> | - ]

Resets all of the Link Controller settings and then loads the configuration settings, by default from the /config/bigip.conf and /config/bigip_base.conf files.

For testing purposes, you can save a test configuration by renaming it to avoid confusion with the boot configuration file. To load a test configuration, use the load command with the <filename> parameter. For example, if you renamed your configuration file to /config/bigtest.conf, the command would be:

b load /config/bigtest.conf

The command checks the syntax and logic, reporting any errors that would be encountered if the command executed.

You can type b load - in place of a file name, to display the configuration on the standard output device.

b save -

Use the load command together with the verify command to validate the specified configuration file. For example, to check the syntax of the configuration file /config/altbigpipe.conf, use the following command:

b verify load /config/altbigip.conf

The -log option will cause any error messages to be written to /var/log/bigip in addition to the terminal.

maint

b maint

Toggles a Link Controller into and out of maintenance mode. When in maintenance mode, a Link Controller accepts no new connections, but it does allow existing connections to complete.

The maint command interactively prompts you to enter or exit the maintenance mode.

b maint

If the Link Controller is already in maintenance mode, the maint command takes the Link Controller out of maintenance mode. If the Link Controller is in maintenance mode for more than 20 minutes, that Link Controller immediately begins to accept new connection requests.

If the Link Controller has been in maintenance mode for more than 20 minutes, it automatically updates all network ARP caches; this process normally takes a few seconds. However, you can speed up the process by reloading the configuration file, using the following command:

b -f /config/bigip.conf

merge

b [-log] merge [<file_name>]

Loads the Link Controller configuration from the file specified in the <file_name> variable, without resetting the current configuration.

mirror

b mirror [<mirror_to_interface>] show

b mirror <mirror_to_interface> interfaces add <interface_list>

b mirror <mirror_to_interface> interfaces delete <interface_list>

b mirror <mirror_to_interface> delete

For the Link Controller, you can copy traffic from any port or set of ports to a single, separate port. This is called port mirroring. You should attach a sniffer device to the target port, called the mirror-to port, for debugging and/or monitoring.

Options

The <mirror_to_interface> variable specifies the port to which you want one or more ports to be mirrored.

The show option displays a specific mirror-to interface. If no interface is specified, this option displays all mirror-to interfaces.

The interfaces add <interface_list> variable specifies one or more ports that you want to mirror to the mirror-to port.

The interfaces delete <interface_list> variable specifies one or more ports that you want to delete from a port mirror.

The delete option deletes the specified mirror-to interface.

Displaying port mirroring

Using the argument, you can display all mirror-to interfaces or a specific mirror-to interface.

To display all mirror-to interfaces, type the following command:

b mirror show

To display a specific mirror-to interface, use the following command-line syntax:

b mirror <mirror_to_interface> show

Creating a port mirror

Creating a port mirror consists of specifying a mirror-to port and adding to it one or more ports (that is, a port list) to be mirrored. The bigpipe syntax for setting up port mirroring is:

b mirror <mirror_to_interface> interfaces add <interface_list>

For example, you could type the following command:

b mirror 3.24 interfaces add 3.1 3.3 3.10

Deleting interfaces from a port mirror

The bigpipe syntax for deleting interfaces from a port mirror is as follows:

b mirror <mirror_to_interface> interfaces delete <inteface_list>

For example, you could type the following command:

b mirror 3.24 interfaces delete 3.10

Deleting a port mirror

The bigpipe syntax for deleting a port mirror is:

b mirror <mirror_to_interface> delete

For example, you could type the following command:

b mirror 3.24 delete

monitor

b monitor <monitor_name> '{ use <monitor_template> [<attr> <attr_value>]... }'

b monitor show all

b monitor <monitor_name> show

b monitor dump [all]

b monitor <name> delete

b monitor <name> enable | disable

b monitor instance <ip_address>:<service> enable | disable

b monitor instance <ip_address> enable | disable

Defines a health monitor. A health monitor is a configuration object that defines how and at what intervals a node is pinged to determine if it is up or down. Once a monitor is defined, instances of the monitor are created for a node or nodes, one instance per node, using the bigpipe node command.

Monitors verify services and connections of node servers. The icmp or tcp_echo monitors may be used to monitor node addresses. If the node server or node address fails to respond in the specified timeout period, it will be marked as down. When a node server or node address is marked as down, traffic is no longer directed to it.

Several steps are needed to create a monitor and associate it with a node server or node address. A monitor must be created, based on a monitor template that the Link Controller provides. In some cases, a monitor template is directly usable. Once a monitor is created, the node address or node server is associated with the monitor, creating a monitor instance.

Options

The <monitor_name> variable specifies the name you want to use for the monitor you are creating or managing.

The <monitor_template> variable specifies the health monitor template you want to use to create your monitor. For a list of templates that you can specify, see Monitor templates, on page A-29 .

The <attr> variable specifies an attribute of the monitor to which you want to assign a value. For a list of monitor attributes, see Monitor templates, on page A-29 .

The <attr_value> variable specifies the value of the attribute specified with the <attr> option.

The show all option displays all existing monitors.

The show option displays the specified monitor.

The delete option deletes the specified monitor.

The enable | disable option enables or disables the specified monitor.

The instance <ip address>:<service> option enables or disables a monitor instance for the specified IP address and port.

The instance <ip address> option enables or disables a monitor instance for the specified IP address.

Creating a monitor

Creating a monitor simply names and sets the options for a monitor, based on a monitor template. The options may be obtained from a predefined set of default options or the option values may be specified on the command line during creation.

Options include destination address, interval time, timeout value, send string, and receive string, etc. Options can be changed later using the modify option.

The following is an example of a command to create an http monitor:

b monitor my_http '{ use http send "GET /my.html"\
recv "TESTING" }'

The command above creates a monitor with the name my_http, based on the http template. The send and recv strings are modified from the default values. The interval, timeout, destination address, username, and passwd configuration options are not specified on the command line because the monitor will use the default values.

Note that single quotes are used when entering monitor commands on the command line, to prevent the command shell from attempting to interpret the double quotes within the monitor definition.

Modifying a monitor

If you want to change the default values of certain options, such as interval and timeout, you can use syntax as in the following example:

b monitor my_http '{ interval <seconds> timeout <seconds> }'

Creating a monitor instance

Creating a monitor instance simply associates a monitor or group of monitors with a node address or node server.

Each monitor template contains a destination address option. Almost always, this is the meta character string "*:*", which causes the Link Controller to create the monitor instance using the IP address and port supplied on the command line. For example, the destination address option dest in the tcp monitor template is shown in Figure A.2 .

Figure A.2 Destination address option in a monitor template

 monitor tcp {    
# type tcp
interval 5
timeout 16
dest *:*
send ""
recv ""

}

We can create two instances of this monitor by entering the following command:

b node 10.10.10.10:80 10.10.10.12:80 monitor use tcp

The dest *:* attribute in the tcp monitor causes the two monitor instances to be created, substituting the IP address and port combination supplied on the command line into the destination address. In other words, there are two monitor instances created, one that communicates with address 10.10.10.10:80, and one that communicates with 10.10.10.12:80. The node 10.10.10.10:80 depends on the monitor instance 10.10.10.10:80. If the monitor instance cannot get a response from node 10.10.10.10:80, then the node is marked as down. The same is true for node 10.10.10.12:80.

It is also possible to enter explicit addresses into a monitor. For example, Figure A.3 shows a monitor called exp_tcp that specifies an explicit destination address.

Figure A.3 Explicit destination address in a monitor

 monitor exp_tcp {    
# type tcp
use "tcp"
interval 5
timeout 16
dest 10.10.10.24:80
send ""
recv ""

}

In this case, the following command causes one monitor instance to be created, one that communicates with address 10.10.10.24:80:

b node 10.10.10.10:80 10.10.10.12:80 monitor use exp_tcp

In this case, the nodes 10.10.10.10:80 and 10.10.10.12:80 depend on the health of node 10.10.10.24:80. If that node does not respond, both 10.10.10.10:80 and 10.10.10.12:80 are marked as down.

The following is another example of specifying a destination address on the command line:

b node '*:http' monitor use my_http

The command above creates a monitor instance for all node addresses with a service of http. Note that it is necessary to enter the single quotes when entering this command on the command line to prevent the shell from interpreting the special character *.

Modifying a monitor instance

The enable/disable attribute can be changed within a monitor instance. For example:

b monitor instance 10.20.3.2:http disable

This command disables a monitor instance for a node server. The monitor will not attempt to establish a connection with the service until it is later enabled.

Deleting a monitor

To delete a monitor, use the bigpipe monitor command with the delete option, as in the following example:

b monitor my_http delete

Deleting a monitor instance

To delete a monitor instance, use the bigpipe node command with the delete option, as in the following example:

b node '*:http' monitor delete

Displaying monitor templates

To display a specific monitor template, use the following command-line syntax:

b monitor <monitor template> show

When you issue the above command, the Link Controller displays the specified template.

To display all monitor templates, use the following command:

b monitor show all

Displaying monitor instances

Using the bigpipe node command, you can display the status of a monitor instance, along with the corresponding node status. For example:

b node 192.168.200.50:http monitor show

To see this information for all monitor instances, use the following command:

b node monitor show

Monitor templates

Table A.3 lists the monitor templates and shows the template-specific attribute sets for each.

The monitor templates

Name/Type

Template-Specific Attribute Set

icmp

none

tcp_echo

transparent (optional)

tcp

send ""
recv ""
transparent (optional)

reverse (optional)

http

username ""
password ""
send "GET /index.html"
recv ""
get (optional)
url (optional)
transparent (optional)
reverse (optional)

https

username ""
password ""
send "GET /index.html"
recv ""
get (optional)
url (optional)
transparent (optional)
reverse (optional)

external

run ""
args ""

ftp

username "anonymous"
password "bigip1@internal"
get "/README"
url (optional)

nntp

username ""
password ""
newsgroup "local"

pop3

username ""
password ""

smtp

domain "bigip1@internal"

snmp_dca

CPU coefficient ""
CPU threshold ""
memory coefficient ""
memory threshold ""
disk coefficient ""
disk threshold ""
useroid ""
useroid coefficient ""
useroid threshold ""

snmp_dca_base

useroid ""
useroid coefficient ""
useroid threshold ""

imap

username ""
password ""
folder "INBOX"
message_num (optional)

radius

username "username"
password "password"
secret "12345678"

ldap

base "o=Org, c=US"
filter "sn=Doe"

sql

username ""
password ""
database ""

https_443

dest *:443

Table A.4 defines the attributes used in the templates.

Monitor attributes

Attribute

Definition

interval <seconds>

Ping frequency time interval in seconds.

timeout <seconds>

Ping timeout in seconds.

dest <node_addr>

Ping destination node. <node_address> Usually *:* for simple monitors, *:* for all others, causing the monitor instance to ping the address or address:port for which it is instantiated. Specifying address and/or port forces the destination to that address/port.

send <string>

Send string for ECV. Default send and recv values are empty (""), matching any string.

recv <string>

Receive expression for ECV. Default send and recv values are empty (""), matching any string.

get <string>

For the http and https monitors get replaces the recv statement, automatically filling in "GET". For the ftp monitor get can be used to specify a full path to a file. This will automatically fill in dest.

url

For the http, https, and ftp monitors, url replaces the recv statement, supplying a URL and automatically fill in dest with the URL address.

reverse

A mode that sets the node down if the received content matches the recv string.

transparent

A mode that forces pinging through the node to the dest address for transparent nodes, such as firewalls.

run <program>

An external user-added EAV program.

args <program_args>

List of command line arguments for external program. args are quoted strings set apart by spaces.

username <username>

User name for services with password security. For ldap this is a distinguished name (an LDAP-format user name).

password <password>

Password for services with password security.

newsgroup <newsgroup>

Newsgroup, for type nntp EAV checking only

database <database>

Database name, for type sql EAV checking only.

domain <domain_name>

Domain name, for type smtp EAV checking only

secret

Shared secret for radius EAV checking only.

folder

Folder name for imap EAV checking only.

message_num

Optional message number for imap EAV checking only

base

Starting place in the LDAP hierarchy from which to begin the query, for ldap EAV checking only.

filter

LDAP- format key of what is to be searched for, for ldap EAV checking only.

-n

b -n

Used with other commands, such as bigpipe virtual, to display services and IP addresses numerically rather than by service name and host name, respectively. For example, type the following command to display services numerically:

b -n virtual

Figure A.4 shows an example of output that uses IP address instead of host names.

Figure A.4 The output of bigpipe -n virtual

 virtual +------> 11.100.1.1          UNIT 1     
| (cur, max, limit, tot) = (0, 0, 0, 0)
| (pckts,bits) in = (0, 0), out = (0, 0)
+---+--> SERVICE 80 UP
| (cur, max, limit, tot) = (0, 0, 0, 0)
| (pckts,bits) in = (0, 0), out = (0, 0)
MEMBER 11.12.1.100:80 UP
(cur, max, limit, tot) = (0, 0, 0, 0)
(pckts,bits) in = (0, 0), out = (0, 0)

nat

b nat <orig_addr> to <trans_addr> [unit <unit ID>]

b nat <orig_addr> [...<orig_addr>] delete

b nat [<trans_addr> [...<trans_addr>] ] show | delete

b nat [<orig_addr> [...<orig_addr>] ] show | delete

b nat [<orig_addr>...] stats reset

b nat <orig_addr> vlans <vlan_list> enable | disable

b nat <orig_addr> vlans delete all

b nat <orig_addr> vlans show

b nat <orig_addr> arp [enable | disable | show]

Defines a network address translation (NAT), which is an IP address, routable on the external network, that a node can use to initiate connections to hosts on the external network and receive direct connections from clients on the external network. The nat command defines a mapping between the IP address of a server behind the Link Controller <orig_addr> and an unused routable address on the network in front of the Link Controller <trans_addr>.

The primary reason to define a NAT is to allow one of the servers in the server array behind the Link Controller to initiate communication with a computer in front of or external to the Link Controller.

Options

The <orig addr> variable is the originating IP address.

The <trans addr> variable is the translated IP address.

The unit <unit ID> option specifies a unit ID, currently 1 or 2. The default unit ID is set to 1.

The delete option deletes a NAT from the Link Controller.

The stats reset option resets statistics for the specified NAT.

The vlans <vlan_list> option lists the existing VLANs on which access to the NAT is enabled or disabled. A NAT is accessible on all VLANs by default.

The vlans delete all option deletes the specified NAT for all VLANs.

The vlans show option displays the VLANs on which the specified NAT is enabled.

Defining a NAT

Use the following syntax to define a NAT:

b nat <orig ip> to <trans ip> [unit <id>] [arp disable] \
[vlans <vlan name>... disable]

The node behind the Link Controller with the IP address specified by <orig ip> has a presence in front of the Link Controller as IP address <trans ip>.

For example:

b nat 11.0.0.100 to 10.0.140.100

Deleting a NAT

Use either of the following commands to permanently delete one or more NAT's from the Link Controller configuration:

b nat <orig_addr>... <orig_addr> delete

b nat <trans_addr>... <trans_addr> delete

Additional Restrictions

The nat command has the following additional restrictions:

  • A virtual server cannot use the IP address defined in the <trans ip> parameter.
  • A NAT cannot use a Link Controller IP address.
  • The IP address defined in the <origin ip> parameter must be routable to a specific server behind the Link Controller.
  • A NAT cannot use an originating or translated IP address defined fo and used by a SNAT or another NAT.
  • You must delete a NAT before you can redefine it.

node

b node <node_ip>[:<service>]... enable | disable

b node <node_ip>[:<service>... show

b node <node_ip>[:<service>]... limit <max_conn>

b node [<node_ip>:<service>]... stats reset

b node <node_ip>[:service] up | down

b node <node_ip>[:<service>] monitor use <monitor_name> [and <monitor_name>]...

b node [<node_ip>[:<service>]] monitor show | delete

b node <node_ip>[<node_ip>]... virtual | actual

Displays information about nodes and allows you to set properties for nodes, and node addresses. Nodes may be identified using wildcard notation. Thus * represents all nodes on the network, *.80 represents all port 80 nodes, 11.11.11.1:* represents all nodes with address 11.11.11.1.

Options

The <node_ip>[:<service>] variable is an IP address of the node address.

The enable | disable options enable or disable traffic for one or more specified IP addresses.

The limit <max_conn> option defines the maximum number of connections allowed for one or more specified nodes.

The stats reset option resets statistics for the specified node.

The monitor use <monitor_name> option associates one or more specified monitors with the specified node.

The monitor show | delete option shows or deletes a monitor instance running on the specified node.

Displaying nodes

You can display information about a specified node. For example, the following command displays information about node 192.168.200.50:20:

b node 192.168.200.50:20 show

Note that the show keyword is optional. The resulting information is displayed as follows:

NODE 192.168.200.50 UP CHECKED

| (cur, max, limit, tot) = (0, 0, 0, 0)

| (pckts,bits) in = (0, 0), out = (0, 0)

+- PORT 20 UP CHECKED

(cur, max, limit, tot) = (0, 0, 0, 0)

(pckts,bits) in = (0, 0), out = (0, 0)

Modifying nodes

Use the following syntax to set the maximum number of connections allowed for one or more nodes:

b node <ip addr>:<port>... <ip addr>:<port> limit <limit>

Note that to remove a connection limit, you also issue the above command, but you set the <limit> variable to zero.

Use the following syntax to set the maximum number of connections allowed for one or more IP addresses:

b node <ip addr>... <ip addr> limit <limit>

Note that to remove a connection limit, you also issue the above command, but you set the <limit> variable to zero.

Use the following syntax to enable or disable traffic for one or more IP addresses:

b node <ip addr>... <ip addr> enable

b node <ip addr>... <ip addr> disable

Note: For information on using the bigpipe node command to associate a node with a health monitor, see monitor, on page A-25 .

pool

b pool <pool-_name> { lb_method <lb_method_specification> <member_definition> }

b pool <pool-_name> { lb_method <lb_method_specification> persist_mode <persist_mode_specification> <member definition>... }

b pool <pool-_name> { lb_method <lb_method_specification> min_active_members <min_value> <member definition>... }

b pool <pool-_name> { lb_method <lb_method_specification> <member_definition> fallback <host> <protocol> <port> <URI path> }

b pool <pool_name> { forward }

b pool <pool_name> add { <member definition>... }

b pool <pool_name> delete { <member definition>... }

b pool <pool_name> modify { [lb_method <lb_method_specification>] [persist_mode <persist_mode_specification>] <member definition>... }

b pool <pool_name> { snat disable }

b pool <pool_name> header insert <quoted string>

b pool <pool_name> delete

b pool [<pool_name>] show

b pool <pool_name> lb_method show

b pool <pool_name> persist dump

b pool <pool_name> persist dump mirror

b pool <pool_name> { persist_mode simple | cookie | ssl | sip [sip_timeout <timeout>] | sticky | msrdp }

b pool sip dump

b pool <pool_name> sticky clear

b pool <pool_name> stats reset

Displays, creates, modifies, or deletes a pool definition. You can use pools to group members together with a common load-balancing mode and persistence mode.

Options

The <pool name> variable is a string from 1 to 31 characters, for example, new_pools.

The <member_definition> variable specifies the IP address of the member node being added to the pool.

The <cookie name> variable specifies a cookie name, which must be 1-31 characters in length.

The lb_method <lb_method_specification> option specifies the load balancing mode that Link Controller is to use for the specified pool.

The persist_mode <persist_mode_specification> option specifies the persistence type that Link Controller is to use for the specified pool.

The min_active_members <min_value> option specifies the minimum number of members that must remain available for traffic to be confined to a priority group when using priority-based activation.

The fallback option specifies HTTP redirection, using a set of format strings. You can use these strings to indicate unchanged host names, ports, and URI paths. For more information, see Specifying HTTP redirection, on page A-39 .

The forward option specifies that the pool is to be a forwarding pool.

The snat disable option specifies that SNAT connections are to be disabled for that pool.

Displaying a pool

Using the bigpipe pool command, you can display specific pools or all pools, and display persistence within a pool.

Use the following syntax to display all pools:

bigpipe pool show

Use the following syntax to display a specific pool, such as cgi_pool:

bigpipe pool cgi_pool show

Use a command such as the following to display persistence within a pool:

bigpipe pool cgi_pool persist show

Creating a pool

To create a pool, use command-line syntax such as the following:

bigpipe pool cgi_pool { lb_method rr member 10.2.3.11:http \
member 10.2.3.12:http }

This command creates a pool with two members 10.2.3.11 and 10.2.3.12, and both members use the round robin load balancing method.

If the lb_method option is not set, it defaults to round robin.

To create a pool using simple persistence, use command-line syntax such as the following:

bigpipe pool cgi_pool { lb_method rr persist_mode simple \
simple_timeout 100 simple_mask 255.255.255.0 \
member 10.20.3.11:http member 10.20.3.12:http }

This command creates a pool with two members, 10.20.3.11 and 10.20.3.12.

Both members use the round robin load balance method. Also, a simple persistence timeout of 100 seconds will be used with this pool. Note that an optional persistence mask may be specified with simple persistence.

Modifying a pool

You can modify a pool to change the defined attributes, such as adding or deleting members, changing the load balancing method, or changing the type of persistence being used.

The following example adds a new member to the existing pool cgi_pool:

bigpipe pool cgi_pool add { member 10.20.3.2:http }

The following example deletes a member from the existing pool cgi_pool:

bigpipe pool cgi_pool delete { member 10.20.3.2:http }

Deleting a pool

You can delete a pool altogether. For example, the following command deletes the pool cgi_pool:

bigpipe pool cgi_pool delete

Note that all references to a pool must be removed before a pool can be deleted.

Specifying HTTP redirection

To specify HTTP redirection (also known as fallback), you can use a set of format strings to indicate unchanged host names, ports, and URI paths. These format strings are as follows:

%h Host name, as obtained from the Host: header of the client
%p Port, from the virtual server listening port
%u URI path, as obtained from a GET/POST request

For example, the following command configures a pool to redirect an HTTP request from http://www.example.com:8080/sample.html to https://www.example.com:443/sample.html:

bigpipe pool my_pool fallback https://%h:443/%u

To indicate that the host name, port, and URI path remain unchanged, you would use the following command:

bigpipe pool my_pool fallback %h:%p/%u

Specifying a load balancing mode

The load balancing modes are specified as values of the attribute lb_mode. The lb_mode values are shown in Table A.5 .

Load balancing modes

Mode Name

lb_mode attribute value

Round Robin

rr or omit lb_mode specification

Ratio

ratio

Ratio Member

ratio_member

Fastest

fastest

Fastest Member

fastest_member

Least Connections

least_conn

Least Connections Member

least_conn_member

Observed

observed

Observed Member

observed_member

Predictive

predictive

Predictive Member

predictive_member

Dynamic Ratio

dynamic_ratio

For more information about the load balancing modes, refer to Load balancing method, on page 2-5 .

ratio

b ratio [<node_ip>] [node_ip> ...] show

b ratio <node_ip> [<node_ip>...] <weight>

For the ratio load-balancing mode, this command sets the weight or proportions for one or more node addresses. For the priority load balancing mode, the command sets the priority level. Note that multiple node addresses can have the same priority level setting.

Options

The <node_ip> variable specifies an IP address of a specific node.

The <weight> variable specifies a whole number. The default weight for any node address is 1.

The show option displays the ratio weights for the specified node addresses.

Displaying ratio settings

To display the current ratio settings for all node address that have ratio settings, use the following command:

b ratio [show]

The following output is displayed:

192.168.200.51 ratio = 3

192.168.200.52 ratio = 1

To display the ratio settings for specific node addresses, use the following command-line syntax:

b ratio <node addr> ... <node addr> [show]

Modifying ratio settings

The following command sets the ratio to 3 for the node address specified:

b ratio 192.168.103.20 3

reset

b reset

Clears the configuration values and counter values from memory.

Warning: Use this command with caution. All network traffic stops when you run this command.

Typically, this command is used on a standby Link Controller prior to loading a new /config/bigip.conf file that contains new service enable and timeout values.

For example, you can execute the following commands on a standby Link Controller:

b reset

b load <filename>

This sequence of commands ensures that only the values set in the <filename> specified are in use.

save

b save [ <filename> | - ]

b base save [ <filename> | - ]

Writes the current Link Controller configuration settings from memory to the configuration files named /config/bigip.conf and /config/bigip_base.conf. (/config/bigip.conf stores high level configuration settings, such as pools, virtual servers, NATs, SNATs, and proxies. /config/bigip_base.conf stores low level configuration settings, like, VLANs, non-floating self IP addresses, and interface settings.)

You can type b save <filename>, or a hyphen character (-) in place of a file name, to display the configuration on the standard output device.

b [base] save -

If you are testing and integrating Link Controller units into a network, you may want to use multiple test configuration files. Use the following syntax to write the current configuration to a file name that you specify:

b [base] save <filename>

For example, the following command saves the current configuration from memory to an alternate configuration file named /config/bigip.conf2.

b save /config/bigip.conf2

self

b self <ip_addr> vlan <vlan_name | vlangroup_name> [ netmask <ip_mask> ][ broadcast <broadcast_addr>] [unit <id>]

b self <ip_addr> floating enable | disable

b self <ip_addr> delete

b self <ip_addr> show

b self show

b self <ip_addr> snat automap enable | disable

Defines a self IP address on a Link Controller. A self IP address is an IP address mapping to a VLAN or VLAN group and their associated interfaces on a Link Controller. A one true self IP address is assigned to each interface on the unit as part of first time boot configuration, and also a floating (shared) self IP address for units in a redundant pair. Additional self IP addresses may be created for health checking, gateway failsafe, routing, or other purposes. These additional self IP addresses are created using the self command.

Options

The <ip_addr> variable specifies an IP address to assign to the Link Controller.

The vlan <vlan_name | vlangroup_name> option specifies the VLAN or VLAN group to which the self IP address is being assigned.

The netmask <ip mask> option specifies an IP mask used to set the network of the self IP address.

The broadcast <broadcast_addr> option specifies the broadcast address.

The unit <id> option specifies an optional unit ID, 1 or 2. The default value is 1.

The floating option enables or disables a floating self IP address.

The snat automap option enables or disables SNAT automapping on the specified self IP address. Once snat automap is enabled, the self IP address can be used as the translation address when SNAT automapping is enabled for a VLAN.

Creating self IP addresses

The following are examples of using the bigpipe self command to create self IP addresses:

b self 10.1.0.1 vlan external netmask 255.255.0.0

b self 10.2.0.1 vlan internal netmask 255.255.0.0

For a redundant configuration, the IP addresses that are shared by the two units are configured as floating IP addresses. For example:

b self 10.1.1.1 vlan external netmask 255.255.0.0 floating enable

b self 10.2.1.1 vlan internal netmask 255.255.0.0 floating enable

To create self IP addresses that are shared between the two units in an active-active configuration, assign a unit number to each self IP address, as in the following examples:

b self 10.1.1.1 vlan external netmask 255.255.0.0 unit 1 floating enable

b self 10.1.1.2 vlan external netmask 255.255.0.0 unit 2 floating enable

b self 10.2.1.1 vlan internal netmask 255.255.0.0 unit 1 floating enable

b self 10.2.1.2 vlan internal netmask 255.255.0.0 unit 2 floating enable

service

b service <service> [<service>...] limit <limit>

b service <service> [<service>...] tcp enable | disable

b service <service> [<service>...] timeout tcp <timeout>

b service <service> [<service>...] udp enable | disable

b service <service> [<service>...] timeout udp <timeout>

b service [<service>... ] show

b service [<service>... ] stats reset

Enables and disables network traffic on services, and also sets connection limits and timeouts. An idle connection is one in which no data has been received or sent for the number of seconds specified by the service timeout command.

The default timeout value for tcp services is 1005, and 60 seconds for udp services. For idle connection reaping to be effective, you should set the timeout value to be greater than the configured timeout for the service daemons installed on your nodes.

You can use port numbers or service names (for example, www, http, or 80) for the <service> parameter. Note that the settings you define with this command control the service for all virtual servers that use it. By default, all services are disabled.

Options

The <service> variable specifies any valid port number, between 1 and 65535, inclusive, or any valid service name in the /etc/services file.

The <limit> variable specifies the maximum number of simultaneous connections to be allowed to the service for all virtual servers. To turn off a connection limit for a service, specify a value of 0.

The <seconds> variable specifies the number of seconds until a connection to the service times out.

snat

b snat map <orig_ip> [...<orig_ip>] to <snat_ip><snat_ip> [unit <unit ID>] [netmask <ip>] [arp disable] [vlan <vlan_name_list> disable]

b snat map default to <snat_ip> [unit <unit ID>] [netmask <ip>]

b snat <snat_ip> [...<snat_ip>] delete | show

b snat default delete | show

b snat default dump [verbose]

b snat [<snat_ip> [...<snat_ip>] ] dump [verbose]

b snat globals show

b snat default show

b snat [<snat_ip> [...<snat_ip>] ] show

b snat [<snat_ip> [...<snat_ip>] ] delete

b snat [<snat_ip> [...<snat_ip>] ] arp show

b snat [<orig_ip> [...<orig_ip>] limit <max_conn>

b snat limit <max_conn>

b snat default limit <max conn>

b snat <orig_ip> [...<orig_ip>] mirror enable | disable

b snat default mirror enable | disable

b snat <orig_ip> [...<orig_ip>] timeout tcp | udp <seconds>

b snat default timeout tcp | udp <seconds>

b snat <orig_ip> [...<orig_ip>] stats reset

b snat default stats reset

b snat <orig_ip> [...<orig_ip>]> disable | enable

b snat <snat_ip> [...<snat_ip>] vlans <vlan_list> disable | enable

b snat <snat_ip> [...<snat_ip>] vlans enable all

b snat <snat_ip> [...<snat_ip>] vlans show

b snat map <vlan_name> to auto

b snat <snat_ip> [...<snat_ip>] arp [enable | disable]

The snat command creates and deletes secure network address translations (SNATs), and displays information about them. A SNAT defines one or more addresses that nodes can use as a source IP address when initiating connections to hosts on the external network. Note that clients cannot use SNAT addresses to connect directly to nodes.

This command also allows you to set properties on a SNAT. A SNAT defines the relationship between an externally visible IP address, or translated address, and a group of internal IP addresses, or originating address, of individual servers at your site.

Options

The <orig addr> variable specifies an originating IP address, that is, an address that is behind the Link Controller.

The <trans addr> variable specifies a translated IP address, that is, an address that is outside the Link Controller.

The <ip addr> variable can specify either an originating or a translated address.

The <vlan name> variable specifies the name of an existing VLAN on which access to the SNAT is enabled or disabled. By default, a SNAT is accessible on all VLANs.

The <id> variable specifies a unit ID, currently 1 or 2. The default unit ID value is 1.

The <limit> variable specifies a connection limit.

The <seconds> variable specifies the number of seconds for timeout.

The auto option enables SNAT automapping.

Defining a SNAT

SNATs map one or more originating addresses to a single translated address. Use the following syntax to define one or many originating addresses to translated address maps:

b snat map <orig addr> [<orig addr>... ] to <trans addr>

For example, the following command maps a SNAT, which has two clients, to a single translated address:

b snat map 192.140.100.10 192.140.100.20 to 192.168.11.22

You can set the following properties on a SNAT:

  • A connection limit (limit option)
  • A tcp timeout value (timeout tcp option)
  • A udp timeout value (timeout udp option)
  • Connection mirroring (mirror option)
  • ARP enable or disable
  • A VLAN deny access list

Deleting SNAT

Use the following command-line syntax to permanently delete one or more SNAT's from the Link Controller configuration:

b snat <ip addr>... <ip addr> delete

stp

b stp <stp_name> interfaces add <if_list> | all

b stp <stp_name> hello <interval>

b stp <stp_name> max_age <interval>

b stp <stp_name> forward_delay <interval>

b stp <stp_name> interfaces delete <if _list>

b stp <stp_name> enable | disable

The Link Controller provides Spanning Tree Protocol (STP) implementation for loop resolution in configurations where one or more external switches is connected in parallel with the Link Controller. This feature allows you to configure two or more interfaces on the platform as an STP domain. For interfaces in the STP domain, the spanning tree algorithm identifies the most efficient path between the network segments, and establishes the switch associated with that path as the root. Links forming redundant paths are shut down, to be re-activated only if the root fails.

The STP domain should contain all ports that are connected in parallel to an external switch where there are nodes on the link capable of generating or receiving traffic. You will want a second domain if there is an additional switch or switches connected in parallel with additional Link Controller interfaces.

Options

The <stp_name> variable specifies an arbitrary name for the spanning tree protocol (STP) domain.

The <interface_name> variable specifies an interface name, for example, 3.1.

summary

b summary

Displays a summary of current usage statistics. The output display format for the summary command is shown in Figure A.5 . You can find detailed descriptions of each of statistic displayed by the summary command in Monitoring the Link Controller, on page 6-2 .

Figure A.5 The summary output display

 BIG-IP total uptime           = 1 (day) 4 (hr) 40 (min) 8 (sec)
BIG-IP total uptime (secs) = 103208
BIG-IP total # connections = 0
BIG-IP total # pkts = 0
BIG-IP total # bits = 0
BIG-IP total # pkts(inbound) = 0
BIG-IP total # bits(inbound) = 0
BIG-IP total # pkts(outbound) = 0
BIG-IP total # bits(outbound) = 0
BIG-IP error no nodes available = 0
BIG-IP tcp port deny = 0
BIG-IP udp port deny = 0
BIG-IP virtual tcp port deny = 0
BIG-IP virtual udp port deny = 0
BIG-IP max connections deny = 0
BIG-IP virtual duplicate syn ssl = 0
BIG-IP virtual duplicate syn wrong dest = 0
BIG-IP virtual duplicate syn node down = 0
BIG-IP virtual maint mode deny = 0
BIG-IP virtual addr max connections deny = 0
BIG-IP virtual path max connections deny = 0
BIG-IP virtual non syn = 0
BIG-IP error not in out table = 0
BIG-IP error not in in table = 0
BIG-IP error virtual fragment no port = 0
BIG-IP error virtual fragment no conn = 0
BIG-IP error standby shared drop = 0
BIG-IP dropped inbound = 0
BIG-IP dropped outbound = 0
BIG-IP reaped = 0
BIG-IP ssl reaped = 0
BIG-IP persist reaped = 0
BIG-IP udp reaped = 0
BIG-IP malloc errors = 0
BIG-IP bad type = 0
BIG-IP mem pool total 96636758 mem pool used 95552 mem percent used 0.10

For more information on the out put of the bigpipe summary command, see Explanation of summary statistics, on page 6-3 .

trunk

b trunk <controlling_if> define <if_list>

b trunk [<controlling_if>] show [verbose]

b trunk [<controlling_if>] stats reset

The trunk command aggregates links (individual physical interfaces) to form a trunk. This link aggregation increases the bandwidth of the individual NICs in an additive manner. Thus, four fast Ethernet links, if aggregated, create a single 400 Mb/s link. The other advantage of link aggregation is link failover. If one link in a trunk goes down, traffic is simply redistributed over the remaining links.

A trunk must have a controlling link and acquires all the attributes of that controlling link from Layer 2 and above. Thus, the trunk automatically acquires the VLAN membership of the controlling link but does not acquire its media type and speed. Outbound packets to the controlling link are load balanced across all of the known-good links in the trunk. Inbound packets from any link in the trunk are treated as if they came from the controlling link.

A maximum of eight links may be aggregated. For optimal performance, links should be aggregated in powers of two. Thus, ideally, you will aggregate two, four, or eight links. Gigabit and fast ethernet links cannot be placed in the same trunk.

For more information on interface naming, refer to Interface naming conventions, on page 1-2 .

Options

The <controlling link> variable specifies the name of the interface chosen to be the controlling link for the trunk. Any attributes of the controlling link at layer 2 and above, such as membership in a VLAN, apply to the trunk.

The <link> variable specifies an interface name, for example 3.1.

The show option displays information and statistics for the trunk, on a single line.

The <verbose> option, used with the show option, displays the information and statistics for the trunk in more detailed format.

unit

b unit [show]

b unit peer [show]

The unit number on a system designates which virtual servers use a particular unit in an active-active redundant configuration. You can use the bigpipe unit command to display the unit number assigned to a particular Link Controller. For example, to display the unit number of the unit you are on, type the following command:

b unit show

To display the unit number of the other unit in a redundant system, type in the following command:

b unit peer show

Note: If you use this command on a redundant system in active/standby mode, the active unit shows as unit 1 and 2, and the standby unit has no unit numbers.

Tip: The bigpipe unit peer show command is the best way to determine whether the respective state mirroring mechanisms are connected.

verbose

b verbose virtual_server_udp_port_denial

b verbose virtual_server_tcp_port_denial

b verbose bigip_udp_ort_denial

b verbose bigip_tcp_port_denial

Used to modify the verbose log level. This command is an alternative to using the bigpipe global verbose command.

Table A.6 defines the command and shows the equivalencies.

bigpipe verbose and global verbose command equivalencies

b verbose command

b global verbose command

b verbose bigip_udp_port_denial

Turns UDP port denial logging on. This logs UDP port denials to the Link Controller address.

b global verbose_log_level=1

b verbose bigip_tcp_port_denial

Turns TCP port denial logging on. This logs TCP port denials to the Link Controller address.

b global verbose_log_level=2

b verbose virtual_server_udp_port_denial

Turns virtual UDP port denial logging on. This logs UDP port denials to the virtual server address.

b global verbose_log_level=4

b verbose virtual_server_tcp_port_denial

Turns virtual TCP port denial logging on. This logs TCP port denials to the virtual server address.

b global verbose_log_level=8

b verbose bigip_udp_port_denial
b verbose bigip_tcp_port_denial
b verbose bigip_udp_ort_denial
b verbose bigip_tcp_port_denial

Turns UDP and TCP port denial on for both virtual server and Link Controller addresses.

b global verbose_log_level=15

verify

b [log] verify <command...]

verify load [<filename> | -]

Parses the command line and checks syntax without executing the specified command. This distinguishes between valid and invalid commands

Use the verify command followed by a command that you want to validate:

b verify virtual 10.10.10.100:80 use pool my_pool

The command checks the syntax and logic, reporting any errors that would be encountered if the command executed.

Use the verify command together with the load <filename> command to validate the specified configuration file. For example, to check the syntax of the configuration file /config/altbigpipe.conf, use the following command:

b verify load /config/altbigip.conf

version

b version

Displays the version of the Link Controller operating system and the features enabled.

For example, for a Link Controller, the bigpipe version command displays the output shown in Figure A.6

Figure A.6 The version output display

 Product Code:    
BIG-IP Link Controller

Enabled Features:
Statistics Journaling Network Proximity Table
IP Classifier Internet Weather Map
VS Availability Dependencies Metrics and Limits
Wide IP Persistence 3-DNS Network-Performance Load Balancing
3-DNS Server-Performance Load Balancing 3-DNS Static Load Balancing
Zone File Management 3-DNS EAV
3-DNS ECV 3-DNS Link Control
BIG-IP Link Control HTTP Header Insert
Dynamic Ratio Load Balancing HTTP Redirects
Gateway Failsafe Static Load Balancing
SNAT NAT
Pools Mirroring
Failover Node HA
Dynamic Load Balancing Destination Address Affinity
Simple Persistence ECV
ECV Transparent Health Check

virtual

b virtual <virt_ip>[:<service>] [unit <ID>] [netmask <ip>] [broadcast <ip>] use pool <pool_name>

b virtual <virt_ip>:<service> [/<bitmask>][unit <ID>] use pool <pool_name>

b virtual <virt_ip>[:<service>] [unit <ID>] [netmask <ip>] forward

b virtual <virt_ip>:<service> translate port enable | disable | show

b virtual <virt_ip>:<service> svc_down_reset enable | disable | show

b virtual <virt_ip>:<service> translate addr enable | disable | show

b virtual <virt_ip>:<service> lasthop pool <pool_name> | none | show

b virtual <virt_ip>:<service> mirror conn enable | disable | show

b virtual <virt_ip>:<service> conn rebind enable | disable | show

b virtual [<virt_ip:service>] stats reset

b virtual <virt_ip>:<service> accelerate enable | disable | show

b virtual <virt_ip>:<service> use pool <pool_name> accelerate disable

b virtual <virt_ip>:<service> vlans <vlan_list> disable | enable

b virtual <virt_ip>:<service> vlans show

b virtual <virt_ip> arp enable | disable | show

b virtual <virt_ip> any_ip enable | disable

b virtual <virt_ip> any_ip timeout <seconds>

b virtual <virt_ip> [:<service>] [...<virt_ip>[:<service>]] show

b virtual <virt_ip> [:<service>] [...<virt_ip>[:<service>]] enable | disable

b virtual <virt_ip>[:<service>] [ ... <virt_ip>[:<service>]] delete

b virtual <virt_ip>[:<service>] [... <virt_ip>[:<service>]] limit <max_conn>

b virtual <vlan_name>[:service>]

b virtual <vlan_name> use pool <pool_name>

Creates, deletes, and displays information about virtual servers. This command also allows you to set properties on a virtual server, such as connection mirroring, connection limits, and timeouts.

A virtual server defines the relationships between an externally visible IP address that clients use to connect to your site, and the internal IP addresses of individual member servers that actually provide services for your site.

Options

The <virtual addr> variable specifies the IP address of the virtual server.

The <virtual port> variable specifies a port number or service name.

The <bitmask> variable specifies a number representing the bits that are the network part of the virtual IP address.

The <vlan name> variable specifies the name of an existing VLAN for which you want to enable or disable access. By default, a virtual server is accessible on all VLANs.

The <id> variable specifies a unit ID, currently 1 or 2. The default value for the unit ID is 1.

The <ip addr> variable specifies the IP address, of the form 10.20.30.40.

The <pool name> variable specifies the name of an existing server pool.

The translate port option enables, disables, or shows port translation for a virtual server.

The svc_down_reset option enables, disables, or shows the ability of the Link Controller to automatically reset connections when a service becomes unavailable.

The translate addr option enables, disables, or shows address translation for a virtual server.

The lasthop pool option allows you to specify a pool to which to send connections back, instead of using the same router from which the connection was received.

The mirror conn option enables, disables, or shows the mirroring of connections in active/standby configurations.

The conn rebind option enables, disables, or shows dynamic connection rebinding.

The stats reset option resets statistics for a virtual server.

The accelerate option enables, disables, or shows FastFlow acceleration, that is, increased speed of packet flow for TCP connections when the packets are not fragmented.

The arp option causes the Link Controller to respond to ARP requests for the virtual server address and send a gratuitous ARP request for router table updates.

The any_ip option allows you to configure a virtual server to load balance IP traffic other than TCP and UDP traffic, such as IPSEC traffic.

Defining a virtual server using pools and rules

To associate a pool of members with a virtual server, use a command such as this:

b virtual 10.20.2.102:http use pool cgi_pool

Defining a virtual server with a wildcard port

Use the following syntax to define an individual virtual server and the node or nodes to which the virtual server maps. Note that this syntax allows wildcard ports:

b virtual <virt addr> use pool <pool name>

You can also create multiple wildcard servers, one per VLAN. To create a wildcard server for a VLAN, use the following syntax:

b virtual <vlan_name> use pool <pool_name>

Deleting a virtual server

Use the following syntax to permanently delete one or more virtual servers from the Link Controller configuration:

b virtual <virt addr>:<port>... <virt addr>:<port> delete

vlan

b vlan <name> rename <new_name>

b vlan <vlan_name> delete

b vlan <vlan_name> tag <tag_number>

b vlan <vlan_name> interfaces add [tagged] <if_list>

b vlan <vlan_name> interfaces delete <if_list>

b vlan <vlan_name> interfaces delete all

b vlan <vlan_name> interfaces show

b vlan <vlan_name> port_lockdown enable | disable

b vlan <vlan_name> bridging enable | disable

b vlan <vlangroup_name> proxy_forward enable | disable

b vlan <vlan_name> failsafe arm | disarm | show

b vlan <vlan_name> timeout <seconds> | show

b vlan <vlan_name> snat automap

b vlan show

b vlan <vlan_name> show

b vlan <vlan_name> rename <new_vlan_name>

b vlan <if_name> mac_masq <mac_addr> | show

b vlan <if_name> mac_masq 0:0:0:0:0

b vlan <vlan name> l2_agingtime <seconds>

b vlan <vlan name> fdb add <MAC address> interface <if_name>

b vlan <vlan name> fdb delete <MAC address> interface <if_name>

b vlan <vlan name> fdb static show

b vlan <vlan name> fdb dynamic show

b vlan <vlan name> fdb show

This command creates, displays and modifies settings for VLANs. VLANs are part of the base configuration.

When creating a VLAN, a tag value (VLAN ID) for the VLAN is automatically chosen unless it is specified on the command line. If a tag is specified on the command line and that tag number is 0, the vlan command creates an empty VLAN.

A VLAN can have both tagged and untagged interfaces. An interface can be added to a single VLAN as an untagged interface. Also, an interface can be added to multiple VLANs as a tagged interface.

The vlan command defines VLANs, VLAN mappings, and VLAN properties. By default, each interface on a Link Controller is an untagged member of a VLAN. The lowest-numbered interface is assigned to the external VLAN, the interface on the main board is assigned to the admin VLAN, and all other interfaces are assigned to the internal VLAN.

Options

The <vlan name> variable specifies a VLAN name, 1-15 characters in length.

The tag <tag number> option specifies a valid VLAN tag number, in the range 0-4095. Note that if 0 is specified as the tag number, the vlan command creates an empty VLAN.

The interfaces add [tagged] option specifies that the interfaces specified with the <if_list> argument are to be added to the specified VLAN, as either tagged or untagged interfaces.

The interfaces delete option deletes all interfaces for the specified VLAN.

The <if_list> variable specifies a list of interfaces to be added to a VLAN.

The interfaces show all option shows all interfaces for the specified VLAN.

The port_lockdown option enables or disables connection to the Link Controller through the specified VLAN.

The proxy_forward option enables or disables proxy forwarding, for purposes of L2 forwarding.

The failsafe option allows you to arm, disarm, or show the failsafe mechanism for redundant systems.

The timeout <timeout> option specifies a timeout value for the failsafe mechanism.

The snat automap option enables SNAT automapping for the specified VLAN.

The rename <new_vlan_name> option specifies the name to which you want to rename the specified VLAN.

The <if_name> variable specifies an interface name.

The mac_masq <MAC address> option specifies a MAC address, such as 0:a0:be:ef:1f:3a, that will be shared by both Link Controller units in a redundant system.

The l2_agingtime <seconds> option specifies the value in seconds of L2 forwarding time.

The fdb option adds the specified interfaces as entries in the L2 forwarding table.

The port_lockdown option enables or disables connection to the Link Controller through the specified VLAN.

vlangroup

b vlangroup [<vlan name list>] [show]

b vlangroup [<vlan name list>] list

b vlangroup <vlan name list> delete

b vlangroup <vlan name> tag <number>

b vlangroup [<vlan name list>] tag [show]

b vlangroup [<vlan name list>] interfaces [show]

b vlangroup <vlan name> vlans add <vlan if name list>

b vlangroup <vlan name list> vlans delete <vlan if name list>

b vlangroup <vlan name list> vlans delete all

b vlangroup [<vlan name list>] vlans [show]

b vlangroup <vlan name list> port_lockdown enable | disable

b vlangroup [<vlan name list>] port_lockdown [show]

b vlangroup <vlan name list> proxy_forward enable | disable

b vlangroup [<vlan name list>] proxy_forward [show] vlangroup <vlan name list> failsafe arm

b vlangroup <vlan name list> failsafe disarm

b vlangroup [<vlan name list>] failsafe [show]

b vlangroup <vlan name list> timeout <number>

b vlangroup [<vlan name list>] timeout [show] vlangroup <vlan name list> snat automap enable (deprecated)

b vlangroup <vlan name list> snat automap disable (deprecated)

b vlangroup <vlan name list> mac_masq <MAC addr>

b vlangroup [<vlan name list>] mac_masq [show]

b vlangroup <vlan name list> fdb add <MAC addr> interface <if name>

b vlangroup <vlan name list> fdb delete <MAC addr> interface <if name>

b vlangroup [<vlan name list>] fdb [show]

b vlangroup [<vlan name list>] fdb show static

b vlangroup [<vlan name list>] fdb show dynamic

b vlangroup <vlan name> rename <vlan name>

The vlangroup command defines a VLAN group, which is a grouping of two or more VLANs belonging to the same IP network for the purpose of allowing L2 packet forwarding between those VLANs.

The VLANs between which the packets are to be passed must be on the same IP network, and they must be grouped using the vlangroup command. For example:

b vlangroup network11 { vlans add internal external }

A self IP address must be assigned to the VLAN group using the following command:

b self <ip_addr> vlan network11

L2 forwarding must be enabled for the VLAN group using the VLAN proxy_forward attribute. This attribute is enabled by default when the VLAN group is enabled.

Options

For a description of the bigpipe vlangroup command options, see Options, on page A-60 .

Table of Contents   |   << Previous Chapter   |   Next Chapter >>

Was this resource helpful in solving your issue?




NOTE: Please do not provide personal information.



Incorrect answer. Please try again: Please enter the words to the right: Please enter the numbers you hear:

Additional Comments (optional)