ILB Command-Line Interface

The ILB command–line interface is located in the /usr/sbin/ilbadm directory. The CLI includes subcommands to configure load-balancing rules, server groups, and health checks. It also includes subcommands to display statistics as well as view configuration details. The subcommands can be divided into two categories:

Configuration subcommands – These subcommands enable you to perform the following tasks:
- Create and delete load-balancing rules
- Enable and disable load-balancing rules
- Create and delete server groups
- Add and remove servers from a server group
- Enable and disable back-end servers
- Create and delete server health checks for a server group within a load-balancing rule
Note - To administer the configuration subcommands, you require privileges. The privileges are obtained through the role-based access control (RBAC) of Oracle Solaris. To create the appropriate role and assign the role to a user, see Initially Configuring RBAC (Task Map) in Oracle Solaris 11.1 Administration: Security Services.
View subcommands – These subcommands enable you to perform the following tasks:
- View configured load-balancing rules, server groups, and health checks
- View packet forwarding statistics
- View the NAT connection table
- View health check results
- View the session persistence mapping table
Note - You do not need privileges to administer the view subcommands.

For a list of ilbadm subcommands, see ILB Command and Subcommands. For more detailed information about ilbadm subcommands, refer to the ilbadm(1M) man page.

ILB Command and Subcommands

You can use ilbadm and its subcommands to manipulate the load-balancing rules. For more detailed information about ilbadm subcommands, refer to the ilbadm(1M) man page.

Table 10-4 ILB Subcommands Used to Manipulate the Load-balancing Rules

ILB Subcommand	Description
`ilbadm create-rule`	Creates a `rule name` with the given characteristics.
`ilbadm show-rule`	Displays the characteristics of specified rules or displays all the rules if no rules are specified.
`ilbadm delete-rule`	Removes all information pertaining to a `rule name`. If `rule name` does not exist, this subcommand fails.
`ilbadm enable-rule`	Enables a named rule or all the rules if no names are specified.
`ilbadm disable-rule`	Disables a named rule or all the rules if no names are specified.
`ilbadm show-statistics`	Shows ILB statistics. For example, `-t` with this subcommand includes a time stamp with every header.
`ilbadm show-hc-result`	Shows the health check results for the servers that are associated with the specified name of the rule `rule-name`. If `rule-name` is not specified, the health check results of servers for all the rules are displayed.
`ilbadm show-nat`	Displays NAT table information.
`ilbadm create-servergroup`	Creates a server group with one or more servers. Additional servers can be added by using `ilbadm add-server`.
`ilbadm delete-servergroup`	Deletes a server group.
`ilbadm show-servergroup`	Lists a server group or lists all the server groups if no server group is specified.
`ilbadm enable-server`	Enables a disabled server.
`ilbadm disable-server`	Disables the specified servers.
`ilbadm add-server`	Adds the specified servers to server groups.
`ilbadm show-server`	Displays servers associated with the named rules or displays all the servers if a rule name is not specified.
`ilbadm remove-server`	Removes one or more servers from a server group.
`ilbadm create-healthcheck`	Sets up health check information that can be used to set up rules.
`ilbadm show-healthcheck`	Displays detailed information about the configured the health check.
`ilbadm delete-healthcheck`	Deletes the health check information.
`ilbadm show-persist`	Displays the session persistence mapping table.
`ilbadm export-config filename`	Exports the existing ILB configuration file in a format suitable for importing by using `ilbadm import`. If `filename` is not specified, then `ilbadm export` writes to `stdout`.
`ilbadm import-config -p filename`	Imports a file and replaces the existing ILB configuration with the contents of this imported file. If `filename` is not specified, then `ilbadm import` reads from `stdin`.

Skip Navigation Links
Exit Print View
	Managing Oracle Solaris 11.1 Network Performance Oracle Solaris 11.1 Information Library