1 Overview of the Oracle Traffic Director Command-Line Interface

This chapter provides an overview of the general syntax, usage modes, CLI (Command-Line Interface) commands, common options, variables, security, and error messages that are relevant to Oracle Traffic Director.

1.1 General Syntax

The general syntax provides the command name, common options, and mandatory options, followed by the operand. All options start with the (--) notation. The short option names must be prefixed with the (-) notation. Non-mandatory options are indicated by []. For more information about common options, see help.

Example for options:

$tadm --user=admin --port=1895

Example for short options:

$tadm -u admin -p 1895

An example of general syntax is provided below.

Figure 1-1 CLI Syntax

Description of ''Figure 1-1 CLI Syntax''

1.2 Usage Modes

This section provides information on the command-line modes of Oracle® Traffic Director, including Standalone mode, Shell mode, and File mode.

1.2.1 Standalone Mode

In the standalone mode option, users invoke the CLI (tadm) from a command shell by specifying the command, options, and operands. Once the command is executed, the CLI exits to the shell. For more information, see help.

Example:

$tadm create-config --user=admin --password-file=./admin.pwd --listener-port=2222 --server-name=syrinx myconfig

CLI201 Command 'create-config' ran successfully.

1.2.2 Shell Mode

In the shell mode option, users invoke CLI (tadm) from a command shell by not entering the command. The CLI prompts users to enter a command. Once the command is executed, the control returns to the tadm shell. The shell can be exited by typing exit or quit command. For more information, see help.

Example:

$tadm --user=admin --password-file=./admin.pwd --host=admin.example.com --port=8989
OTD 1.0 B06/07/2011 09:40
tadm> list-configs
www.example.com
soa.example.org
tadm> exit
$

Note:

Shell mode does not support non-ASCII character input. However, it is supported in standalone mode.

1.2.3 File Mode

In the file mode option, users specify the commands file which contains a list of valid commands.

Example:

$tadm --user admin --password-file ./admin.pwd --host=localhost --port 8888 --commands-file file.txt

1.3 Security

Guidelines for entering the user name and password while performing tasks in the CLI is provided below. User name and password must be used in accordance with the policies that are defined in Oracle Traffic Director application. While performing multiple tasks in the CLI, user name and password must be used in the following combinations:

• The user name and password must be entered for each user command running in a standalone mode.

Example:

$tadm list-configs --user=admin --password-file=./admin.pwd --host=admin.example.com --port=8888

• While performing tasks in the shell mode, user name and password file are accepted when tadm executable is invoked. The user name and password file options may not be entered while the user commands are invoked in the shell mode.

Example:

$tadm --user=admin --host=admin.example.com --port=8888
Enter the password>
tadm>

• Oracle recommends that the password file be provided in read-only mode to the administrator and not stored on NFS or a shared disk. The contents of the password file must be provided as
  tadm_password=password

• The password file can contain multiple passwords. For example,

  tadm_password=<password>
    tadm_token-pin=<pin>
  

If a tadm command requires password and it is not provided in the password file, the user will be prompted for the password

Note:

File mode is similar to the shell mode.

1.4 Command-Line Interface Utilities

Some of the command-line utilities that Oracle® Traffic Director supports are described in this section.

1.4.1 Short Name Option

When you execute tadm commands, you can use short names of the boolean options as a standalone option.

Example: -e, -v and -p can be combined and used as -evp

Note:

You can specify options in any order without any change in the functional behavior of the command.

1.4.2 Tab Completion

Tab completion is a tadm feature. The Tab key must be pressed twice to autocomplete tadm commands and their options. For tadm options, if you type "--" and press the Tab key twice, the tadm shell will list the available options of a particular command. If you type "--c" and press the Tab key twice, the tadm shell will attempt to complete the option if there are no other options starting with c. If there are any options, they will be listed.

Example:

$ tadm
$ tadm p<tab><tab>
$ tadm pull-config

1.5 Error Messages

The general format that is used while specifying errors and warnings are described below.

CLI<Error-code>: <Error Message>

Example:

CLI004: Required option --vs not found in the command. Please run the command again with --vs option.

For more information about the error codes and their description, see help.

1.6 List of Commands

This section contains the functional list of CLI commands that are used in Oracle® Traffic Director. Using this section you can look for specific commands based on the functional role of Oracle® Traffic Director.

Instance Root Configuration

• configure-server

• unconfigure-server

Configuration Management

• create-config

• delete-config

• list-configs

• copy-config

• deploy-config

• pull-config

• list-config-files

• get-config-file

• set-config-file

• list-backups

• restore-config

Listener Management

• create-http-listener

• delete-http-listener

• list-http-listeners

• get-http-listener-prop

• set-http-listener-prop

Server Pool Management

• create-origin-server-pool

• delete-origin-server-pool

• list-origin-server-pools

• get-origin-server-pool-prop

• set-origin-server-pool-prop

• enable-maintenance

• disable-maintenance

• get-maintenance-prop

Health Check

• get-health-check-prop

• set-health-check-prop

Origin Server

• create-origin-server

• delete-origin-server

• list-origin-servers

• get-origin-server-prop

• set-origin-server-prop

Configuration Properties

• get-config-prop

• set-config-prop

Localization Properties

• get-localization-prop

• set-localization-prop

HTTP Properties

• get-http-prop

• set-http-prop

Keep-Alive

• get-keep-alive-prop

• set-keep-alive-prop

Thread Pool

• get-thread-pool-prop

• set-thread-pool-prop

Quality of Service (QoS)

• get-qos-prop

• set-qos-prop

Domain Name Service

• get-dns-prop

• set-dns-prop

Domain Name Service Cache

• get-dns-cache-prop

• set-dns-cache-prop

SSL Session Cache

• get-ssl-session-cache-prop

• set-ssl-session-cache-prop

Access Log Buffer Properties

• get-access-log-buffer-prop

• set-access-log-buffer-prop

Variables

• create-variable

• delete-variable

• list-variables

Proxy Cache

• get-cache-prop

• set-cache-prop

Virtual Server Management

• create-virtual-server

• delete-virtual-server

• list-virtual-servers

• get-virtual-server-prop

• set-virtual-server-prop

• copy-virtual-server

(QoS) Limits

• get-qos-limits-prop

• set-qos-limits-prop

Error Page Settings

• create-error-page

• delete-error-page

• list-error-pages

Rules Management

• create-route

• delete-route

• list-routes

• get-route-prop

• set-route-prop

• enable-route-auth

• disable-route-auth

• get-route-auth-prop

• list-proxy-info

• forward-proxy-info

• block-proxy-info

Proxy Cache Rules

• create-cache-rule

• delete-cache-rule

• list-cache-rules

• get-cache-rule-prop

• set-cache-rule-prop

Request Limit Rules

• create-request-limit

• delete-request-limit

• list-request-limits

• get-request-limit-prop

• set-request-limit-prop

Compression Rules

• create-compression-rule

• delete-compression-rule

• list-compression-rules

• get-compression-rule-prop

• set-compression-rule-prop

SSL

• get-ssl-prop

• set-ssl-prop

Ciphers

• enable-ciphers

• disable-ciphers

• list-ciphers

PKCS11

• get-pkcs11-prop

• set-pkcs11-prop

• list-tokens

• set-token-prop

• set-token-pin

Certificate Management

• install-cert

• delete-cert

• list-certs

• get-cert-prop

• set-cert-trust-prop

• create-selfsigned-cert

• create-cert-request

Certificate Revocation List

• install-crl

• delete-crl

• list-crls

• get-crl-prop

Monitoring

• get-log

• get-access-log

• get-config-stats

• get-origin-server-stats

• get-tcp-proxy-stats

• get-virtual-server-stats

• get-stats-xml

• get-perfdump

Error Log

• get-log-prop

• set-log-prop

Access Log

• enable-access-log

• disable-access-log

• get-access-log-prop

Stats XML Configuration

• enable-stats-xml

• disable-stats-xml

• get-stats-xml-prop

Perfdump Configuration

• enable-perfdump

• disable-perfdump

• get-perfdump-prop

SNMP

• get-snmp-prop

• set-snmp-prop

• start-snmp-subagent

• stop-snmp-subagent

Stats

• get-stats-prop

• set-stats-prop

Events

• create-event

• enable-event

• disable-event

• delete-event

• list-events

Instance Management

• create-instance

• delete-instance

• list-instances

• start-instance

• stop-instance

• restart-instance

• reconfig-instance

• rotate-log

Administration Server and Node Management

• list-nodes

• get-admin-prop

• set-admin-prop

• reset-admin-password

• restart-admin

• stop-admin

• remove-node

• enable-admin-ldap-auth

• disable-admin-ldap-auth

• get-admin-ldap-auth-prop

• renew-admin-certs

• renew-node-certs

High Availability

• create-failover-group

• delete-failover-group

• list-failover-groups

• get-failover-group-prop

• set-failover-group-primary