Initial login and common commands

Some commands are available before you enter a configuration mode, which is at initial logon. Some commands are available in most configuration modes.

Initial login commands
Initial login commands are available after you log in to the DataPower® Gateway but before you enter a configuration mode. These commands are to run actions, not to configure object instances. For this list of these commands, see Common action commands that are available after initial login.
Common configuration commands
Common configuration commands are available after you enter a configuration mode. These commands are to define properties that are specific to this object instance. For a list of these commands, see Common configuration commands that are available to define properties.
Common configuration actions commands during configuration
Common configuration actions are available while you are in a configuration mode. For a list of these commands, see Common action commands that are available in configuration modes.

Common action commands that are available after initial login

After you log in to the DataPower Gateway but before you enter a configuration mode, initial login commands are available. These commands are to run actions, not to configure object instances. The following table lists these action commands and their purpose.
Table 1. Initial login commands and their purpose
Command Purpose
all-domains1 This command enables or disables the administrative state of all application domains. This command is also available in global mode.
clear intrusion-detected This command clears the detected intrusion when the appliance is in failsafe mode.
clock This command modifies the date or time for the system clock. This command is also available in global mode.
configure terminal This command enters global mode.
diagnostics This command enters diagnostics mode. Use this command only at the explicit direction of IBM Support.
disconnect This command closes the session for an active user.
echo This command writes the associated text to the console.
exec This command calls and runs a configuration script.
exit This command exits the configuration mode and saves the changes to the running configuration. On completion, you are returned to your parent mode.
help This command displays the help for all properties as command-summary pairs or the available information for a specific property.
login This command logs you out from one account and in to another account on the DataPower Gateway.
ping This command determines whether the network can reach a remote target.
show This command displays configuration or status information that is relevant to the provided argument.
shutdown This command can reload the firmware, can restart the DataPower Gateway, or can stop and turn off the power to the DataPower Gateway. This command is also available in flash mode.
switch domain This command moves to a specified domain. This command is also available in global mode.
template This command runs an interactive command script. This command is also available in global mode.
test schema This command tests conformity of an XML file against a schema. This command is also available in global mode.
test tcp-connection This command verifies TCP connectivity to a specific port on a remote target. This command is also available in global mode.
top This command returns you to your initial login mode.
traceroute This command traces the network path to a remote target. This command is also available in global mode.

Common configuration commands that are available to define properties

After you enter a configuration mode, common configuration commands are available. These commands are to define properties that are specific to this object instance. The following table lists these configuration commands and their purpose.
Table 2. Common configuration commands and their purpose
Command Purpose
admin-state This command sets the administrative state for the configuration. This property applies to most object instances.
correlation-path This command specifies the part of the API definition that correlates with the policy. This property applies to API and assembly object instances only.
summary This command specifies the brief, descriptive summary for the object instance. This property applies to most object instances.
title This command specifies the title for the configuration. This property applies to API and assembly object instances only.

Common action commands that are available in configuration modes

While you are in a configuration mode, common actions are available. The following table lists these action commands and their purpose.
Table 3. Common commands and their purpose
Command Purpose
cancel This command exit the configuration mode and does not save the changes to the running configuration. On completion, you are returned to your parent mode.
exit1 This command exits the configuration mode and saves the changes to the running configuration. On completion, you are returned to your parent mode.
help This command displays the help for all properties as command-summary pairs or the available information for a specific property.
reset This command restores the default values for properties in the object instance.
show This command displays the current configuration as command-value pairs for the object instance that you are editing.