Oracle® Traffic Director

Command-Line Reference

11g Release 1 (11.1.1.9.0)

E21037-05

December 2016

Oracle Traffic Director Command-Line Reference, 11g Release 1 (11.1.1.9.0)

E21037-05

Copyright © 2011, 2016,  Oracle and/or its affiliates. All rights reserved.

Primary Author: Trupthi NT

Contributing Authors: Savija TV

Contributors: Amit Gupta, Nagakishore Sidde, Isvaran Krishnamurthy

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

List of Figures

Preface

- Audience

- Documentation Accessibility

- Related Documents

- Conventions

1 Overview of the Oracle Traffic Director Command-Line Interface

- 1.1 General Syntax

- 1.2 Usage Modes

- 1.2.1 Standalone Mode

- 1.2.2 Shell Mode

- 1.2.3 File Mode

- 1.3 Security

- 1.4 Command-Line Interface Utilities

- 1.4.1 Short Name Option

- 1.4.2 Tab Completion

- 1.5 Error Messages

- 1.6 List of Commands

2 Oracle Traffic Director CLI Commands

- block-proxy-info

- configure-server

- copy-config

- copy-virtual-server

- create-cache-rule

- create-cert-request

- create-compression-rule

- create-config

- create-error-page

- create-event

- create-failover-group

- create-http-listener

- create-instance

- create-origin-server

- create-origin-server-pool

- create-request-limit

- create-route

- create-selfsigned-cert

- create-tcp-listener

- create-tcp-proxy

- create-variable

- create-virtual-server

- delete-cache-rule

- delete-cert

- delete-compression-rule

- delete-config

- delete-crl

- delete-error-page

- delete-event

- delete-failover-group

- delete-http-listener

- delete-instance

- delete-origin-server

- delete-origin-server-pool

- delete-request-limit

- delete-route

- delete-tcp-listener

- delete-tcp-proxy

- delete-variable

- delete-virtual-server

- delete-webapp-firewall-ruleset

- deploy-config

- disable-access-log

- disable-admin-ldap-auth

- disable-ciphers

- disable-event

- disable-maintenance

- disable-perfdump

- disable-route-auth

- disable-services

- disable-stats-xml

- disable-tcp-access-log

- disable-webapp-firewall

- enable-access-log

- enable-admin-ldap-auth

- enable-ciphers

- enable-event

- enable-maintenance

- enable-perfdump

- enable-route-auth

- enable-services

- enable-stats-xml

- enable-tcp-access-log

- enable-webapp-firewall

- forward-proxy-info

- get-access-log

- get-access-log-buffer-prop

- get-access-log-prop

- get-admin-ldap-auth-prop

- get-admin-prop

- get-cache-prop

- get-cache-rule-prop

- get-cert-prop

- get-compression-rule-prop

- get-config-file

- get-config-prop

- get-config-stats

- get-crl-prop

- get-dns-cache-prop

- get-dns-prop

- get-failover-group-prop

- get-health-check-prop

- get-http-listener-prop

- get-http-prop

- get-keep-alive-prop

- get-localization-prop

- get-log

- get-log-prop

- get-maintenance-prop

- get-origin-server-pool-prop

- get-origin-server-prop

- get-origin-server-stats

- get-perfdump

- get-perfdump-prop

- get-pkcs11-prop

- get-qos-limits-prop

- get-qos-prop

- get-request-limit-prop

- get-route-auth-prop

- get-route-prop

- get-snmp-prop

- get-ssl-prop

- get-ssl-session-cache-prop

- get-stats-prop

- get-stats-xml

- get-stats-xml-prop

- get-tcp-access-log

- get-tcp-access-log-prop

- get-tcp-listener-prop

- get-tcp-proxy-prop

- get-tcp-proxy-stats

- get-tcp-thread-pool-prop

- get-thread-pool-prop

- get-virtual-server-prop

- get-virtual-server-stats

- get-webapp-firewall-prop

- help

- install-cert

- install-crl

- install-webapp-firewall-ruleset

- list-backups

- list-cache-rules

- list-certs

- list-ciphers

- list-compression-rules

- list-configs

- list-config-files

- list-crls

- list-error-pages

- list-events

- list-failover-groups

- list-http-listeners

- list-instances

- list-nodes

- list-origin-servers

- list-origin-server-pools

- list-proxy-info

- list-request-limits

- list-routes

- list-tcp-listeners

- list-tcp-proxies

- list-tokens

- list-variables

- list-virtual-servers

- list-webapp-firewall-rulesets

- pull-config

- reconfig-instance

- remove-node

- renew-admin-certs

- renew-node-certs

- reset-admin-password

- restart-admin

- restart-instance

- restore-config

- rotate-log

- set-access-log-buffer-prop

- set-admin-prop

- set-cache-prop

- set-cache-rule-prop

- set-cert-trust-prop

- set-compression-rule-prop

- set-config-file

- set-config-prop

- set-dns-cache-prop

- set-dns-prop

- set-failover-group-primary

- set-health-check-prop

- set-http-listener-prop

- set-http-prop

- set-keep-alive-prop

- set-localization-prop

- set-log-prop

- set-origin-server-pool-prop

- set-origin-server-prop

- set-pkcs11-prop

- set-qos-limits-prop

- set-qos-prop

- set-request-limit-prop

- set-route-prop

- set-snmp-prop

- set-ssl-prop

- set-ssl-session-cache-prop

- set-stats-prop

- set-tcp-listener-prop

- set-tcp-proxy-prop

- set-tcp-thread-pool-prop

- set-thread-pool-prop

- set-token-pin

- set-token-prop

- set-virtual-server-prop

- start-failover

- start-instance

- start-snmp-subagent

- stop-admin

- stop-failover

- stop-instance

- stop-snmp-subagent

- unconfigure-server

Index

List of Figures

- 1-1 CLI Syntax

Preface

This document describes the Oracle Traffic Director command-line interface (CLI).

Audience

This book is intended for Oracle Traffic Director administrators. This book assumes you are familiar with the following topics:

- Installing software

- Performing basic system administration tasks

- Issuing commands in a terminal window

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Documents

For more information, see the following documents, which are available on the Oracle Technology Network:

- Oracle Traffic Director Administrator Guide

- Oracle Traffic Director Configuration File Reference

- Oracle Traffic Director Installation Guide

- Oracle Virtual Assembly Builder User's Guide

- Oracle Exalogic Elastic Cloud Documentation

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

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

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

2 Oracle Traffic Director CLI Commands

This chapter lists and describes the CLI user commands and their options for Oracle Traffic Director in alphabetical order.

block-proxy-info

Syntax

tadm block-proxy-info common_options --config=config_name --vs=vs_name --route=route_name (param)

Description

Use this command to block proxy information.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to block the proxy parameter.

--vs|-s

Specify the name of the virtual server for which you want to block the proxy parameter.

--route|-r

Specify the name of the route to block the proxy parameter.

Operands

Specify the name of the proxy parameter you want to block.

jroute

via

ip

cipher

proxy-agent

proxy-auth

keysize

secret-keysize

ssl-id

issuer-dn

user-dn

auth-cert

xforwarded-for

cache-info

ssl

Example

tadm block-proxy-info --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
--route=route1 jroute

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-proxy-info, forward-proxy-info

configure-server

Syntax

tadm configure-server common_options ([--admin-node]
[--node-host=node_host] [--node-port=node_port])
[--server-user=admin_server_user] [--bind-ip=bind_ip] [--java-home=java_home] --instance-home=instance_home

Description

Use this command to create the administration server and administration nodes. Before you create an administration node, make sure that the administration server is running. The newly created administration node will be registered with the administration server.

Note:
If configure-server is executed as a privileged user, then services are enabled on the server by default.

Options

For information about common_options, run the help command.

--admin-node|-n

This option specifies that the command should create an administration node.

--node-host|-H

Indicates the host name of the administration node.

--node-port|-P

Indicates the SSL port of the administration node.

--server-user|-r

Specifies the administrator server user.

--java-home|-j

Specifies the Java home directory.

--instance-home|-i

Specifies the absolute path name of the directory in which the configuration files and binaries pertaining to the administration server or administration node should be created.

--bind-ip|-b

While configuring the administration server, it is used as an ip value for the administration server's default listener. While configuring administration node, it is used as a remote administration server's bind-ip to the administration node.

Example

To configure the administration server:

tadm configure-server --instance-home=/home/otd

Note:
The command prompts you to specify the administrator password.

To configure the administration node:

tadm configure-server --user=admin --admin-node --host=admin.example.com --instance-home=/home/otd

Note:
The command prompts you for the administration server password.

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-failover-group, unconfigure-server, list-nodes

copy-config

Syntax

tadm copy-config common_options --config=config_name copy_name

Description

Use this command to create a copy of an existing configuration. The newly copied configuration is identical to the existing configuration. However, the new configuration does not have any instances even though the configuration from which it has been copied has instances.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to be copied.

Operands

copy-name

Specify the name of the configuration that you want to copy

Example

tadm copy-config --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org Config-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, delete-config, list-configs, deploy-config, pull-config

copy-virtual-server

Syntax

tadm copy-virtual-server common_options --config=config_name
--vs=source_virtual_server_name new_virtual_server_name

Description

Use this command to create a copy of an existing virtual-server.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to copy an existing virtual-server.

--vs|-s

Specify the name of the source virtual server.

Operands

new-virtual-server-name

Specify the name of the virtual server that you want to create.

Example

tadm copy-virtual-server --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
virtual-server-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-virtual-server, set-virtual-server-prop, delete-virtual-server, get-virtual-server-prop, list-virtual-servers

create-cache-rule

Syntax

tadm create-cache-rule common_options --config=config_name
--vs=vs_name [--condition=expr] cache_rule_name

Description

Use this command to create a cache rule.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to create a cache rule.

--vs|-s

Specify the virtual server.

--condition|-C

Specify the condition for creating the cache rule.

Operands

cache-rule-name

Specify the cache rule name.

Example

tadm create-cache-rule --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org cache-rule-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-cache-rule, get-cache-prop, get-cache-rule-prop, list-cache-rules

create-cert-request

Syntax

tadm create-cert-request common_options [--key-type=rsa|ecc] ([--key-size=size] | [--curve=curve_name]) [--org=org]
[--org-unit=org_unit] [--locality=place] [--state=name]
[--country=name] --config=config_name --token=name
--server-name=[dns_name,..]

Description

Use this command to create a new certificate request. A certificate consists of digital data that specifies the name of an individual, company, or other entity, and certifies that the public key included in the certificate belongs to that entity. Both clients and servers can have certificates.

A certificate is issued and digitally signed by a (CA) Certificate Authority. The CA can be a company that sells certificates over the Internet, or it can be a department responsible for issuing certificates for your company's intranet or extranet. You decide which CAs you trust enough to serve as verifiers of other user's identities. The create-cert-request command prompts for a token password if the token is password protected.

When you choose the key-size as rsa, specify the key size. When you choose the key-type as ecc, specify the name for the curve. The key-size and curve options in the command are mutually exclusive.

Options

For information about common_options, run the help command.

--key-type|-k

Specify the type of the certificate key. The key types can be rsa or ecc, where:

- rsa is an internet encryption and authentication system using public and private keys.

- ecc (elliptic curve cryptography) is a public key encryption technique. It is based on the elliptic curve theory that enables security with smaller key sizes. This results in faster computations, lower power consumption, as well as memory and bandwidth savings

--key-size|-z

Specify the size of the certificate key. This option is applicable if you choose the key-type as rsa. The key size can be 1024, 2048, or 4098.

--curve|-r

Specify the name of the curve. This option is applicable if you choose the key-type as ecc.

--org|-g

Specify the name of your organization, company, or educational institution.

--org-unit|-o

Enter a description of an organizational unit within your company.

--locality|-l

Enter a description of the city, principality, or country of the organization.

--state|-a

Specify the state or province where your organization is located.

--country|-y

Specify a two-character abbreviation of your country's name (in ISO format). For example, the country code for the United States is US.

--config|-c

Specify the name of the configuration for which you want to create the certificate.

--token|-t

Specify the token (cryptographic device) name, which contains the encrypted public key.

--server-name|-s

Specify the host name of the server for which you are requesting a certificate from the CA.

Note:
The property server-name enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

Example

When you choose key-type as rsa

tadm create-cert-request --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --key-size=2048 --org=ora --country=IN
--locality=abc --config=www.example.org --token=internal --server-name=config1.org

When you choose key-type as ecc

tadm create-cert-request --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --curve=certificate_manager --org=ora --country=IN
--locality=abc --config=www.example.org --token=internal
--server-name=config2.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-cert, list-certs, delete-cert, get-cert-prop, set-cert-trust-prop

create-compression-rule

Syntax

tadm create-compression-rule common_options
[--condition=expr] --config=config_name --vs=vs_name
compression_rule_name

Description

Use this command to create a compression rule.

Options

For information about common_options, run the help command.

--condition|-C

Specify the condition for the compression rule.

--config|-c

Specify the configuration name for which you want to create a compression rule.

--vs|-s

Specify the name of the virtual server.

Operands

create-compression-rule

Specify the compression rule name.

Example

tadm create-compression-rule --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
compression-rule-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-compression-rule, set-compression-rule-prop, list-compression-rules

create-config

Syntax

tadm create-config common_options [--server-user=user_id]
[--ip=ip] [--server-name=server_name] [--origin-server-type=http|https|tcp] --listener-port=port [--origin-server=host:port[,host:port,..]] config_name

Description

Use this command to create a new configuration that listens to HTTP and TCP traffic on a given port and front-ends a set of HTTP and TCP origin servers. By using this command, you can create a default virtual server that handles HTTP traffic and a default tcp proxy that handles TCP traffic. In addition, it creates a default route and forwards all traffic to the origin server.

Options

For information about common_options, run the help command.

--server-user|-r

Specify the user ID of a server user, for example, root. This option is mandatory if the administration server is on UNIX.

--ip|-I

Specify the Internet Protocol (IP) address for the default listener. If you provide the IP address, the server will bind to the IP address for the default listener. Only traffic sent to this IP address will be serviced.

--listener-port|-

Specify the listener port details for creating the configuration.

--origin-server-type|

Specify the type of requests handled by the origin servers.

--server-name|-s

Specify the host name of the server. This option is required if origin-server-type is http or https, and is not relevant if origin-server-type is tcp.

--origin-server|-O

Specify the comma separated list of origin servers of the format host:port. If the origin server is specified and the origin server port is 80, the port need not be specified. For example: os1.example.com and os2.example.com

Note:
The property origin-server enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

Operands

config-name

Specify the name of the configuration that you want to create. Configuration name should not contain spaces, invalid characters or non-ASCII characters.

Example

Creating a configuration with an HTTP listener.

tadm create-config --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--listener-port=18022 --server-name=test1 --origin-server=www.mail.com,www.hotmail.com:8081
config-1

Creating a configuration with a TCP listener.

tadm create-config --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--listener-port=8080 --origin-server=www.mail.com,www.hotmail.com:8081
config-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-backups, list-configs, delete-config, copy-config, pull-config, restore-config, list-config-files, get-config-file, set-config-file, deploy-config

create-error-page

Syntax

tadm create-error-page common_options --config=config_name --vs=vs_name --code=error_code --error-page=error_page

Description

Use this command to create an error page.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to create an error page.

--vs|-v

Specify the name of the virtual server.

--code|-d

Specify the error code for which you want to create an error page. Range is between 400 to 599

--error-page|-g

Specify the absolute path for which you want to create an error page.

Example

tadm create-error-page --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--no-enabled=true --config=www.example.org --vs=soa.example.org
--code=408 --error-page=/documents/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-error-page, list-error-pages

create-event

Syntax

tadm create-event common_options [--no-enabled] --config=config_name
--command=restart|reconfig|rotate-log|rotate-access-log|update-crl|commandline ((--time=hh:mm [--month=1-12]
[--day-of-week=sun|mon|tue|wed|thu|fri|sat] [--day-of-month=1-31]) | --interval=number_of_seconds))

Description

Use this command to create a new event. Additionally, you can set a specific time and interval for scheduling automatic instance reconfiguration. You can also create an event to restart and reconfigure all running instances, rotate access and error logs, and update the certificate revocation list. Also, you can provide the absolute path to a file to be executed.

Options

For information about common_options, run the help command.

--no-enabled|-n

Specify this option to disable the event at runtime.

--config|-c

Specify the name of the configuration for which you want to create the event.

--command|-C

Specify the command that the event executes. The value can be restart, reconfig, rotate-log, rotate-access-log, and update-crl, or any executable command.

--time|-t

Specify the time, for example, 12:30, when you want this event to start. The format of the time is hh:mm.

--month|-m

Specify the month when you want this event to occur. The range of values is 1 to 12.

--day-of-week|-k

Specify the day of the week when you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri, or Sat.

--day-of-month|-d

Specify the day of the month when you want this event to occur. The range of values is 1 to 31.

--interval|-r

Specify the time interval at which you want this event to occur. The range of values is 60 to 86400 seconds.

Example

tadm create-event --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--no-enabled=true --config=www.example.org --command=rotate-log
--interval=120

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-event, list-events, disable-event, enable-event

create-failover-group

Syntax

create-failover-group common_options --config=config_name --virtual-ip=VIP
[--network-prefix-length=number_of_bits] --primary-node=node [--force]
--backup-node=node [--primary-nic=network_interface]
[--backup-nic=network_interface] [--router-id=router_id]

Description

Use this command to create a failover group consisting of two Oracle Traffic Director instances grouped by a unique virtual IP address (VIP), to provide high availability in active-passive mode. Requests are received at the specified VIP address and routed to the Oracle Traffic Director instance that is designated as the primary instance. If the primary instance is not reachable, requests are routed to the backup instance.

For active-active failover, you should create two failover groups, both consisting of the same two nodes, but with the primary and backup roles reversed. Each instance is the primary instance for one VIP address and the backup for the other VIP.

There can be a maximum of 255 failover groups, across configurations.

When creating a failover group, if the administration node process is running as non-root on the node where the instances are located, then you must run start-failover on those nodes as a root user. This is to manually start the failover. If this command is not executed, failover will not start and there will be no high availability.

For more information about how failover works in Oracle Traffic Director, see the Oracle Traffic Director Administrator's Guide on OTN.

Options

For information about common_options, run the help command.

--config|-c

The name of the configuration for which you want to create a failover group.

--virtual-ip|-i

A unique virtual IP address (VIP) to identify the failover group.

The VIP can be a host name or an IPv4/IPv6 address. The VIP should belong to the same subnet as that of the nodes in the failover group. In other words, make sure that the VIP, primary-nic and the backup-nic are on the same subnet.

--network-prefix-length|-z

The network prefix of the interface on which the VIP should be managed.

The network prefix is the subnet mask represented in the Classless Inter-Domain Routing (CIDR) format. For example, for an IPv4 VIP address in a subnet that contains 256 addresses (8 bits), the CIDR notation of the subnet mask 255.255.255.0 would be 24, which is derived by deducting the number of addresses in the given subnet (8 bits) from the maximum number of IPv4 addresses possible (32 bits).

To calculate the CIDR notation of the subnet mask for an IPv6 subnet, deduct the bit-size of the subnet's address space from 128 bits, which is the maximum number of IPv6 addresses possible.

If you do not specify the network prefix, the default of 24 is assumed for an IPv4 VIP, and 64 for an IPv6 VIP.

--primary-node|-n, --backup-node|-b

The administration nodes that you want to specify as the primary and backup nodes in the failover group. Both the nodes should be in the same subnet and should be running as the root user. The nodes should not have an instance that is already part of another failover group. Note that the administration nodes that you select need not have Oracle Traffic Director instances running on them.

--force|-f

Specify this option to force creation of the failover group even if a failover group already exists with the specified VIP. The existing failover group will be replaced.

--primary-nic|-m, --backup-nic|-k

The network interfaces, on the primary and back up node, on which the VIP must be managed. If you do not specify the network interfaces, Oracle Traffic Director discovers them automatically.

--router-id|-r

The router ID for the failover group. The value should be unique across failover groups. If you do not specify the router ID, it is set to 255 for the first failover group. For every subsequent failover group that you create, the default router ID is decremented by one: 254, 253, and so on.

Example

tadm create-failover-group --config=soa --virtual-ip=10.229.227.80 --primary-node=node1.example.com --backup-node=node2.example.com

tadm start-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=soa --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-failover-group, get-failover-group-prop, set-failover-group-primary, list-failover-groups, start-failover, stop-failover

create-http-listener

Syntax

tadm create-http-listener common_options [--no_enabled]
[--ip=address] [--acceptor-threads=count] [--blocking-io=true|false] [--handle-protocol-mismatch=true|false][--family=[name] [--listen-queue-size=size] [--receive-buffer-size=size]
[--send-buffer-size=size] [--description=text] --listener-port=number --config=config_name --server-name=server_name --default-virtual-server-name=vs_name
listener_name

Description

Use this command to create a new HTTP listener socket. All virtual servers have an HTTP listener specified. When a new request comes in, Oracle Traffic Director determines which virtual server to send it to, based on the configured HTTP listener.

Options

For information about common_options, run the help command.

--no-enabled|-n

Specify this option if you want to disable the HTTP listener at runtime.

--ip|-I

Indicates the IP address of the host computer. Specify an asterisk (*) for the HTTP listener to listen to all the available IP addresses on the host computer.

--acceptor-threads|-a

Specify the number of threads dedicated to accept the connections received by this listener. The range of values is 1 to 128.

--blocking-io|-b

If you specify this option, the HTTP listener socket is in the blocking mode.

--handle-protocol-mismatch|-m

If you specify this option, the server responds to Secure Sockets Layer (SSL) or non-SSL protocol mismatches in client requests with an HTTP redirect or SSL alert. The default is true, meaning that the server attempts to detect SSL or non-SSL protocol mismatches and send an HTTP redirect or SSL alert when a mismatch is detected.

--family|-f

Specify the internet protocol family, for example: IPV4, and IPV6. The default is IPv4(family=inet). To use the IPv6 address, specify family=inet6.

--listen-queue-size|-l

Specify the size (in bytes) of the operating system listen queue back log. The range of values is 1 to 65536.

--receive-buffer-size|-r

Specify the size (in bytes) of the operating system socket receive buffer. The range of values is 1 to 1048576.

--send-buffer-size|-B

Specify the size (in bytes) of the operating system socket send buffer. The range of values is 1 to 1048576.

--description|-D

Enter a description of the HTTP listener.

--listener-port|-P

Specify the port number where the configuration binds to and listens for requests. The range of values is 1 to 65535.

--config|-c

Specify the name of the configuration for which you want to create the new HTTP listener socket.

--server-name|-s

Specify the name of the default server.

--default-virtual-server-name|-d

Specify the name of the default virtual server that processes requests that do not match a host-pattern. host-pattern defines a list of hosts to be added to the new virtual server. To specify multiple URLs, separate them by a comma (,).

Operands

listener-name

Specify the name of the HTTP listener that you want to create.

Example

tadm create-http-listener --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt  --listener-port=18033
--config=www.example.org --server-name=config1.com --default-virtual-server-name=config1
http-listener-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-http-listener-prop, list-http-listeners, delete-http-listener

create-instance

Syntax

tadm create-instance common_options [--force] --config=config_name (node_host)+

Description

Use this command to create an instance of Oracle Traffic Director. Instance refers to the environment of a Oracle Traffic Director daemon on a given node, including its configuration, log files, and other runtime artifacts such as lock databases, caches, and temporary files. A node is a network resource, such as a server or a host. In a typical data center, a network of nodes is called a server farm.

Note:
If the node is service-enabled, when you create a new instance, a service is also created for that instance.

Options

For information about common_options, run the help command.

--force|-f

Specify this option to enable a forced creation of an instance. Providing this option deletes any existing instance for the specified configuration on the specified node before creating the instance.

--config|-c

Specify the name of the configuration for which you want to create the instance.

Operands

node-host

Specify the name of the node.

Example

tadm create-instance --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-instance, list-instances, start-instance, stop-instance, restart-instance, reconfig-instance, list-nodes, list-nodes, remove-node

create-origin-server

Syntax

tadm create-origin-server common_options [--backup=true|false] [--ramp-up-time=number_of_seconds)]
[--max-connections=number_of_connections)]
--config=config_name --origin-server-pool=origin_server_pool_name host:port

Description

Use this command to create a origin pool server to the existing origin server pool. The origin server defines a member of a server pool.

Options

For information about common_options, run the help command.

--backup|-b

When you specify this option, the Oracle Traffic Director sends requests to this origin server only when none of the primary (non-backup) origin servers is available.

--ramp-up-time|-r

The time taken by the application to expedite the sending rate to match the newly set up origin server. The range of values is 0.001 to 3600.

--max-connections|-x

Specify the maximum number of concurrent connections to a server. The range of values is 1 to 1048576.

--config|-c

Specify the name of the configuration for which you want to create origin server.

Note:
For origin servers of type HTTP and HTTPS, the default port values are provided if they are not specified.

Example

tadm create-origin-server --user=admin
--host=admin.example.com --password-file=./admin.passwd
--port=8989 --no-prompt --config=www.example.org --origin-server-pool=origin-server-pool-1 www.mail.com:8080

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-origin-server, list-origin-servers, get-origin-server-prop, set-origin-server-prop

create-origin-server-pool

Syntax

tadm create-origin-server-pool common_options [--load-distribution=round-robin|least-connection-count|least-response-time|ip-hash] [--family=default|inet|inet6|inet-sdp]
--type=http|https|tcp --config=config_name [--origin-server=host:port[,host:port,..] [--proxy-server=proxy-server-host[:proxy-server-port]] origin_server_pool_name

Description

Use this command to create a origin-server pool. The origin-server pool configures a pool of origin servers that are used for load balancing requests.

Options

For information about common_options, run the help command.

--load-distribution|-l

Specify the load distribution algorithm. Values are round-robin, least-response-time, ip-hash, and least-connection-count (default).

--family|-f

Specify the internet protocol family, for example:IPV4, and IPV6. The default is IPv4(family=inet). To use the IPv6 address, specify family=inet6.

--type|-t

Specify the type of requests handled by each server in the server pool, for example: HTTP, HTTPS, TCP.

--config|-c

Specify the configuration for which you want to create a origin-server pool.

--origin-server|-O

Specify the list of origin servers of the format host:port separated by comma. For origin servers of type HTTP and HTTPS, if the port information is not specified, it defaults to 80 and 443 respectively. For origin servers of type TCP, port information is mandatory.

Note:
The property origin-server enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

--proxy-server|-p

Specify an HTTP forward proxy server of the format host:port that you can associate with an origin server pool, so that all member origin servers of the pool are communicated with through the configured HTTP forward proxy server.

Operands

origin-server-pool-name

Specify the name of the origin-server pool.

Example

tadm create-origin-server-pool --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --type=http --config=www.example.org --origin-server=www.mail.com:8080 --proxy-server=proxy.example.org --load-distribution=least-response-time http-pool-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-origin-server-pool-prop, get-origin-server-pool-prop, delete-origin-server-pool, list-origin-server-pools

create-request-limit

Syntax

tadm create-request-limit common_options --config=config_name
--vs=vs_name (--max-rps=x | --max-connections=c) [--condition=expr] request_limit_name

Description

Use this command to create a request limit rule.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to create a request limit rule.

--vs|-s

Specify the name of the virtual server.

--max-rps|-r

Specify the maximum requests per second.

--max-connections|-x

Specify the maximum number of concurrent connections to a server. Values are 0 or a positive integer. Default: 0. The maximum allowable value is 20480.

--condition|-C

Specify the condition for the request limit.

Operands

request-limit-name

Specify the request limit rule name.

Example

tadm create-request-limit --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--vs=soa.example.org --max-connections=25 request-limit-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-request-limit, list-request-limits, get-request-limit-prop, set-request-limit-prop

create-route

Syntax

tadm create-route common_options --origin-server-pool=pool_name --config=config_name --vs=vs_name [--condition=expr] route_name

Description

Use this command to create a route. Based on the condition specified while creating a route, the load balancing requests are routed to the specified origin-server pool. A default route is created when a virtual-server is created.

Options

For information about common_options, run the help command.

--origin-server-pool|-o

Specify the name of the origin-server pool to which the load balancing requests must be routed.

--config|-c

Specify the name of the configuration for which you want to create route rule.

--vs|-s

Specify the name of the virtual server.

--condition|-C

Specify the condition for the route rule.

Operands

route-name

Specify the route name.

Example

tadm create-route --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989 --no-prompt --config=www.example.org --vs=soa.example.org route-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-route, list-routes, get-route-prop, set-route-prop

create-selfsigned-cert

Syntax

tadm create-selfsigned-cert common_options [--token=name]
[--org-unit=org_unit] [--locality=place] [--state=name]
[--validity=number_of_months] [--org=org] [--country=name]
[--key-type=rsa|ecc] ([--key-size=size] | [--curve=curve_name])
--config=config_name --server-name=[dns_name,..] --nickname=nick_name

Description

Use this command to create a new self-signed certificate. The create-selfsigned-cert command prompts for a token password if the token is password protected. A self-signed certificate is an identity certificate that is signed by its own creator. In a typical SSL server deployment, if a particular server certificate is valid (contains correct information), it is attested by a digital signature from a Certificate Authority (CA).

Options

For information about common_options, run the help command.

--token|-t

Specify the token (cryptographic device) name, which contains the encrypted public key

--org-unit|-o

Enter a description of an organizational unit within your company.

--locality|-l

Enter a description of the city, principality, or country of the organization.

--state|-a

Specify the state or province where the business is located.

--token-pin|-P

Specify the Personal Identification Number (PIN) required to initialize the token. You can also define the token-pin in the password file.

--validity|-d

Specify the validity of the certificate.

--org|-g

Enter the official name of your company, educational institution, or organization.

--country|-y

Enter a two-character abbreviation of your country's name (in ISO format). For example, the country code for the United States is US.

--key-type|-k

Specify the type of the certificate key. The key types can be rsa or ecc. The default key type is rsa if this option is not specified.

--key-size|-z

Specify the size of the certificate key. This option is applicable only if the key-type is rsa. The key size can be 1024, 2048, or 4098. The default key size is 2048 if this option is not specified.

--curve|-r

Specify the name of the key curve. This option is applicable if you specify the key-type as ecc. The key curves can be prime256v1, secp256r1, nistp256, secp256k1, secp384r1, nistp384, secp521r1, nistp521, sect163k1, nistk163, sect163r1, sect163r2, nistb163, sect193r1, sect193r2, sect233k1, nistk233k1, nistk233, sect233r1, nistb233, sect239k1, sect283k1, nistk283, sect283r1, nistb283, sect409k1, nistk409, sect571k1, nistk571, sect571r1, nistb571, secp160k1, secp160r1, secp160r2, secp192k1, secp192r1, nistp192, secp224k1, secp224r1, nistp224, or prime192v1.

secp256r1 is considered as the default curve if this option is not specified.

--config|-c

Specify the name of the configuration for which you want to create the certificate.

--server-name|-s

Specify the host name of the server for which you are creating a self-signed certificate. This option can also be referred to as the Common Name.

--nickname|-n

Enter a short name for the certificate that you want to create.

Example

tadm create-selfsigned-cert --user=admin --port=8989 --password-file=./admin.pwd --no-prompt
--config=www.example.org --server-name=serverhost
--nickname=cert1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-cert, list-certs, delete-cert, get-cert-prop, create-cert-request, set-cert-trust-prop

create-tcp-listener

Syntax

tadm create-tcp-listener common_options [--no_enabled] [--ip=address] [--acceptor-threads=count] [--family=name] [--listen-queue-size=size] [--receive-buffer-size=size] [--send-buffer-size=size] [--description=text] --listener-port=number --config=config_name --tcp-proxy=tcp_proxy_name listener_name

Description

Use this command to create a new TCP listener socket. When a new request comes in, Oracle Traffic Director determines which TCP proxy to send it to, based on the configured TCP listener.

Options

For information about common_options, run the help command.

--no-enabled|-n

Specify this option to disable the TCP listener at runtime.

--ip|-I

Indicates the IP address of the host computer. Specify an asterisk (*) for the TCP listener to listen to all the available IP addresses on the host computer.

--acceptor-threads|-a

Specify the number of threads dedicated to accept the connections received by this listener. The range of values is 1 to 128.

--family|-f

Specify the internet protocol family, for example: IPV4, and IPV6. The default is IPv4(family=inet). To use the IPv6 address, specify family=inet6. For Sockets Direct Protocol (SDP), specify family=inet-sdp.

--listen-queue-size|-l

Specify the size (in bytes) of the operating system listen queue back log. The range of values is 1 to 65536.

--receive-buffer-size|-r

Specify the size (in bytes) of the operating system socket receive buffer. The range of values is 1 to 1048576.

--send-buffer-size|-B

Specify the size (in bytes) of the operating system socket send buffer. The range of values is 1 to 1048576.

--description|-D

Enter a description for the TCP listener.

--listener-port|-P

Specify the port number where the configuration binds to and listens for requests. The range of values is 1 to 65535.

--config|-c

Specify the name of the configuration for which you want to create the new TCP listener socket.

--tcp-proxy|-r

Specify the name of the TCP proxy.

Operands

listener-name

Specify the name for the TCP listener that you want to create.

Example

tadm create-tcp-listener --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --listener-port=8082 --tcp-proxy=TCP_Proxy1 --config=www.example.org TCP_Listener1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-tcp-listener, list-tcp-listeners, get-tcp-listener-prop, set-tcp-listener-prop

create-tcp-proxy

Syntax

tadm create-tcp-proxy common_options
[--origin-server-pool=origin_server_pool_name] --config=config_name tcp_proxy_name

Description

Use this command to create a new TCP proxy. A TCP proxy handles TCP requests through TCP listeners for traffic tunnelling to the listed origin servers. A TCP proxy can have several TCP listeners associated with it.

Options

For information about common_options, run the help command.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to

--config|-c

Specify the name of the configuration for which you want to create a variable.

Operands

tcp-proxy-name

The name of the TCP proxy.

Example

tadm create-tcp-proxy --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--origin-server-pool=test-pool --config=www.example.org tcp_name1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-tcp-proxy, list-tcp-proxies, get-tcp-proxy-prop, set-tcp-proxy-prop

create-variable

Syntax

tadm create-variable common_options [--vs=vs_name]
[--description=text] --config=config_name (var_name=value)+

Description

Use this command to create a server.xml variable. You can create a variable at the server as well as the virtual server levels. The variable element defines a variable for use in expressions, log formats, and obj.conf parameters.

Options

For information about common_options, run the help command.

--vs|-s

Specify the name of the virtual server for which you want to create a variable.

--description|-D

Specify the description of the server.xml variable that you want to create.

--config|-c

Specify the name of the configuration for which you want to create a variable.

Operands

var-name=value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

Example

tadm create-variable --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org foo=bar

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-variable, list-variables

create-virtual-server

Syntax

tadm create-virtual-sever common_options [--http-listener=name] [--host-pattern=pattern1,pattern2...]
[--canonical-server-name=hostname][--log-file=path] --origin-server-pool=name --config=config_name virtual_server_name

Description

Use this command to create a new virtual server. All virtual servers have an HTTP listener specified. When a new request comes in, the Oracle Traffic Director determines which virtual server to send it to, based on the configured HTTP listener.

Options

For information about common_options, run the help command.

--http-listener|-r

Specify the name of an HTTP listener associated with one or more of the virtual server's host names.

Note:
The property http-listener enables you to specify multiple values, with each value enclosed in quotes and separated by commas. For example: http-listener="http_listener1", "http-listener2"

--host-pattern|-t

Define a list of hosts to be added to the new virtual server.

Note:
The property host-pattern enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

--canonical-server-name|-n

Specify a canonical host name of the virtual server. Requests that use a different host name are redirected to this host name.

--log-file|-f

Specifies the log file for the virtual server. The value is the log file name, for example, ../logs/errors.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to create a virtual-server.

--config|-c

Specify the configuration where you want to create a new virtual server.

Operands

virtual-server-name

Specify the name of the virtual server.

Example

tadm create-virtual-server --user=admin --host=admin.example.com  --password-file=./admin.passwd --port=8989
--no-prompt --origin-server-pool=test-pool
--config=www.example.org virtual-server-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-virtual-server-prop, delete-virtual-server, get-virtual-server-prop, list-virtual-servers, copy-virtual-server

delete-cache-rule

Syntax

tadm delete-cache-rule common_options --config=config_name --vs=vs_name cache_rule_name

Description

Use this command to delete a cache rule.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to delete a cache rule.

--vs|-s

Specify the virtual server.

Operands

cache-rule-name

Specify the cache rule name.

Example

tadm delete-cache-rule --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org
cache-rule-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-cache-rule, list-cache-rules

delete-cert

Syntax

tadm delete-cert common_options [--token=name] [--force]
--config=config_name nickname

Description

Use this command to delete a certificate. The delete-cert command prompts for a token password if the token is password protected.

Options

For information about common_options, run the help command.

--token|-t

Specify the token (cryptographic device) name, which contains the encrypted public key.

--force|-f

Specify this option to enable a forced deletion of a certificate.

--config|-c

Specify the name of the configuration for which you are deleting the certificate.

Operands

nickname

Specify the short name of the certificate that you want to delete.

Example

tadm delete-cert --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org "Certificate Manager - Oracle"

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-cert-request, list-certs, install-cert, get-cert-prop, create-selfsigned-cert

delete-compression-rule

Syntax

tadm delete-compression-rule common_options --config=config_name
--vs=vs_name compression_rule_name

Description

Use this command to delete a compression rule.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration name for which you want to delete a compression rule.

--vs|-s

Specify the name of the virtual server.

Operands

compression-rule-name

Specify the compression rule name.

Example

tadm delete-compression-rule --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org compression-rule-2

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-compression-rule, get-compression-rule-prop, list-compression-rules, set-compression-rule-prop

delete-config

Syntax

tadm delete-config common_options config_name

Description

Use this command to delete a configuration. You can delete a configuration only if the configuration has no server instances referring to it.

Options

For information about common_options, run the help command.

Operands

config-name

Specify the name of the configuration that you want to delete.

Example

tadm delete-config --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989 --no-prompt
config-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, list-configs, deploy-config, copy-config, pull-config, set-config-file, get-config-file, restore-config

delete-crl

Syntax

tadm delete-crl common_options --config=config_name issuer_name

Description

Use this command to delete a CRL (Certificate Revocation List).

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration from which the CRL is being deleted.

Operands

issuer-name

Specify the name of the CRL issuer.

Example

tadm delete-crl --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org "GlobalSign ServerSign CA"

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-crl, list-crls, get-crl-prop

delete-error-page

Syntax

tadm delete-error-page common_options --config=config_name --vs=vs_name --code=error_code

Description

Use this command to delete a error page.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete a error page.

--vs|-s

Specify the name of the virtual server.

--code|-d

Specify the error code for which you want to create an error page. Range is between 400 to 599, inclusive.

Example

tadm delete-error-page --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
--code=404

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-error-page, list-error-pages

delete-event

Syntax

tadm delete-event common_options
--config=config_name --command=restart|reconfig|rotate-log|rotate-access-log|update-crl|commandline
((--time=hh:mm[--month=1-12]
[--day-of-week=sun|mon|tue|wed|thu|fri|sat] [--day-of-month=1-31])| --interval=number_of_seconds)]

Description

Use this command to delete a scheduled event.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete an event.

--command|-C

Specify the command that the event executes. The values can be restart, reconfig, rotate-log, rotate-access-log, update-crl, or any executable command.

--time|-t

Specify the time when you want this event to start. The time format is hh:mm, for example, 12:30.

--month|-m

Specify the month when you want this event to start. The range of values is 1 to 12.

--day-of-week|-k

Specify the day of the week when you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri or Sat.

--day-of-month|-d

Specify the day of the month when you want this event to occur. The range of values is 1 to 31.

--interval|-r

Specify the time interval at which you want this event to occur. The range of values is 60 to 86400 seconds.

Example

tadm delete-event --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --command=restart
--interval=600

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-event, list-events, disable-event, enable-event

delete-failover-group

Syntax

tadm delete-failover-group common_options --config=config_name [--force] --virtual-ip=VIP

Description

Use this command to delete a failover group. To change the VIP or any property of a failover group, you should delete the failover group and create it afresh.

When deleting a failover group, if the administration node process is running as non-root on the node where the instances are located and if at least one failover group is still available, then you must run start-failover on those nodes as a root user. This is to manually restart the failover. On the other hand, after deleting a failover group, if no other failover groups are available for the corresponding instances, then stop-failover must be executed to stop the failover. If you do not execute either start-failover or stop-failover, then the VIP associated with the deleted failover group will continue to be available.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete a failover group.

--virtual-ip|-i

Specify the virtual IP address of the failover group that you want to delete.

force|-f

Specify this option to delete the failover group even if the nodes are offline.

Example

tadm delete-failover-group --config=soa --virtual-ip=10.228.12.250

tadm start-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=soa --instance-home=/home/otd

tadm stop-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=www.example.org --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-failover-group, list-failover-groups, set-failover-group-primary, get-failover-group-prop, start-failover, stop-failover

delete-http-listener

Syntax

tadm delete-http-listener common_options [--force] --config=config_name listener_name

Description

Use this command to delete an HTTP listener socket.

Options

For information about common_options, run the help command.

--force|-f

Specify this option to enable a forced deletion of a HTTP listener.

--config|-c

Specify the name of the configuration where the HTTP listener socket exists.

Operands

listener-name

Specify the name of the HTTP listener that you want to delete.

Example

tadm delete-http-listener --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org http-listener-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-http-listener, set-http-listener-prop, set-http-listener-prop, list-http-listeners

delete-instance

Syntax

tadm delete-instance common_options [--save-logs] [--force]
--config=config_name (node_host)+

Description

Use this command to delete instances of the specified configuration and nodes. If a specific instance is participating in failover groups, you cannot delete it.

Note:
When you delete instances of a node that is service-enabled, then the corresponding services for those instances are also deleted.

Options

For information about common_options, run the help command.

--save-logs|-S

Specify this option to save the logs while deleting an instance.

--force|-f

Specify this option to enable a forced deletion of an instance. You can delete a instance which is participating in a failover group.

--config|-c

Specify the name of the configuration that the instance points to.

Operands

node-host

Specify the name of the node.

Example

tadm delete-instance --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-instance, list-instances, start-instance, stop-instance, restart-instance, reconfig-instance, list-nodes

delete-origin-server

Syntax

tadm delete-origin-server common_options --config=config_name  --origin-server-pool=origin_server_pool_name host:port

Description

Use this command to delete an origin server.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete an origin server.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to delete an origin server.

Example

tadm delete-origin-server --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --origin-server-pool=test-pool
www.mail.com:8080. ':'

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-origin-server, list-origin-servers, get-origin-server-prop set-origin-server-prop

delete-origin-server-pool

Syntax

tadm delete-origin-server-pool common_options --config=config_name
origin_server_pool_name

Description

Use this command to delete a origin-server pool.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete the origin-server pool.

Operands

origin-server-pool-name

Specify the name of the origin-server pool to be deleted.

Example

tadm delete-origin-server-pool --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org test-pool

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-origin-server-pools, delete-origin-server-pool, get-origin-server-pool-prop, set-origin-server-pool-prop

delete-request-limit

Syntax

tadm delete-request-limit common_options --config=config_name --vs=vs_name request_limit_name

Description

Use this command to delete the request limit.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete the request limit.

--vs|-s

Specify the name of the virtual server for which you want to delete the request limit.

Operands

request-limit-name

Specify the name of the request limit to be deleted.

Example

tadm delete-request-limit --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
request-limit-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-request-limit, list-request-limits, get-request-limit-prop, set-request-limit-prop

delete-route

Syntax

tadm delete-route commons_options --config=config_name --vs=vs_name route_name

Description

Use this command to delete the route.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete the route.

--vs|-s

Specify the name of the virtual server for which you want to delete the route.

Operands

route-name

Specify the route name.

Example

tadm delete-route --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
route-5

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-route, list-routes, get-route-prop, set-route-prop

delete-tcp-listener

Syntax

tadm delete-tcp-listener common_options --config=config_name listener_name

Description

Use this command to delete a TCP listener socket.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete a variable.

Operands

listener-name

Specify the name of the TCP listener that you want to delete.

Example

tadm delete-tcp-listener --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org TCP_Listener1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-listener, list-tcp-listeners, get-tcp-listener-prop, set-tcp-listener-prop

delete-tcp-proxy

Syntax

tadm delete-tcp-proxy common_options --config=config_name tcp_proxy_name

Description

Use this command to delete a TCP proxy.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete a variable.

Operands

tcp-proxy-name

Specify the name of the proxy that you want to delete.

Example

tadm delete-tcp-proxy --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org tcp_proxy1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-proxy, list-tcp-proxies, get-tcp-proxy-prop, set-tcp-proxy-prop

delete-variable

Syntax

tadm delete-variable common_options [--vs=vs_name] --config=config_name (var_name)+

Description

Use this command to delete a server.xml variable.

Options

For information about common_options, run the help command.

--vs|-s

Specify the name of the virtual server for which you want to delete a variable.

--config|-c

Specify the configuration for which you want to delete a variable.

Operands

var-name

Specify the name of the variable that you want to delete.

Example

tadm delete-variable --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --vs=soa.example.org --config=www.example.org foo

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-variable, list-variables

delete-virtual-server

Syntax

tadm delete-virtual-server common_options --config=config_name
virtual_server_name

Description

Use this command to delete a virtual server.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete a virtual server.

Operands

virtual-server-name

Specify the name of the virtual server that you want to delete.

Example

tadm delete-virtual-server --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org virtual-server-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-virtual-server, set-virtual-server-prop, get-virtual-server-prop, list-virtual-servers, copy-virtual-server

delete-webapp-firewall-ruleset

Syntax

tadm delete-webapp-firewall-ruleset common_options --config=config_name [--vs=vs_name] ruleset_file_name

Description

Use this command to delete a ruleset file for a web application firewall.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to delete a web application firewall ruleset.

--vs|-s

Specify the name of the virtual server.

Operands

ruleset-file-name

Specify the name of the ruleset file that needs to be deleted.

Example

tadm delete-webapp-firewall-ruleset --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org waf-rule.conf

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-webapp-firewall-ruleset, list-webapp-firewall-rulesets

deploy-config

Syntax

tadm deploy-config common_options [--force] [--restart] [--no-reconfig] config_name

Description

Use this command to deploy a configuration to the nodes. Whenever you create a new configuration or make changes to an existing configuration, you must deploy the configuration for the changes to take effect. The configuration is deployed to all the instances of a configuration.

Options

For information about common_options, run the help command.

--force|-f

Specify this option for the command to overwrite any manual changes done to the configuration files in the instance. By using this option, the instance is overwritten with the latest version of all the files in the config-store.

--restart|-r

Specify this option for the command to restart the instances running in this configuration.

--no-reconfig|-o

If you specify this option, the command does not reconfigure the running server instances of this configuration.

Operands

config-name

Specify the name of the configuration that you want to deploy.

Example

tadm deploy-config --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt configuration-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, list-configs, delete-config, copy-config, pull-config, restore-config, list-config-files, get-config-file, set-config-file

disable-access-log

Syntax

tadm disable-access-log common_options --config=config_name
[--vs=vs_name]

Description

Use this command to disable the access-log.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for disabling the access-log.

--vs|-s

Specify the name of the virtual server.

Example

tadm disable-access-log --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-access-log-prop, enable-access-log

disable-admin-ldap-auth

Syntax

tadm disable-admin-ldap-auth common_options

Description

Use this command to disable the administration server from authenticating against a Lightweight Directory Access Protocol (LDAP) server. The administration server would use the default keyfile for authentication instead of LDAP.

Options

For information about common_options, run the help command.

Example

tadm disable-admin-ldap-auth --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-admin-ldap-auth, get-admin-ldap-auth-prop, renew-admin-certs, reset-admin-password

disable-ciphers

Syntax

tadm disable-ciphers common_options --config=config_name (--http-listener=name|--tcp-listener=name) (ssl3tls_cipher_name)+

Description

Use this command to disable Secure Sockets Layer (SSL) ciphers.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration file that contains the metadata to configure the runtime services of Oracle Traffic Director.

--http-listener|-r

Specify the name of the HTTP listener.

--tcp-listener|-t

Specify the name of the TCP listener.

Operands

ssl3tls-cipher-name

Specify the name of the ssl3tls cipher that you want to disable.

Example

tadm disable-ciphers --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --http-listener=www.example.org_ls
cipher-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-ciphers, list-ciphers

disable-event

Syntax

tadm disable-event common_options [ (--time=hh:mm [--month=1-12] [--day-of-week=sun|mon|tue|wed|thu|fri|sat]
[--day-of-month=1-31]) | --interval=number_of_seconds ]
--config=config_name --command=restart|reconfig|rotate-log|rotate-access-log|update-crl|commandline

Description

Use this command to disable a scheduled event.

Options

For information about common_options, run the help command.

--time|-t

Specify the time when you want this event to start. The time format is hh:mm, (for example, 12:30).

--month|-m

Specify the month when you want this event to occur. The range of values is 1 to 12.

--day-of-week|-k

Specify the day of the week when you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri, or Sat.

--day-of-month|-d

Specify the day of the month when you want this event to occur. The range of values is 1 to 31.

--interval|-r

Specify the time interval at which you want this event to occur. The range of values is 60 to 86400 seconds.

--config|-c

Specify the name of the configuration for disabling the event.

--command|-C

Specify the command that the event executes. The value can be restart, reconfig, rotate-log, rotate-access-log, update-crl, or any executable command.

Example

tadm disable-event --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --interval=3600 --config=www.example.org
--command=restart

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-event, delete-event, list-events, enable-event

disable-maintenance

Syntax

tadm disable-maintenance common_options --config=config_name --origin-server-pool=origin_server_pool_name

Description

Use this command to disable maintenance for an origin-server-pool.

Options

For information about common_options, run the help command.

--config|-c

Specify the origin-server-pool for which you want to disable maintenance.

--origin-server-pool|-o

Specify the name of an origin-server-pool.

Example

tadm disable-maintenance --config=test --origin-server-pool=http-pool-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-maintenance, get-maintenance-prop

disable-perfdump

Syntax

tadm disable-perfdump common_options --config=config_name --vs=vs_name

Description

Use this command to disable perfdump.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to disable perfdump.

--vs|-s

Specify the name of the virtual server for which you want to disable perfdump.

Example

tadm disable-perfdump --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-perfdump, get-perfdump-prop

disable-route-auth

Syntax

tadm disable-route-auth common_options --config=config_name
--vs=vs_name --route=route_name

Description

Use this command to disable the route authentication.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to disable route authentication.

--vs|-s

Specify the virtual server.

--route|-r

Specify the route name.

Example

tadm disable-route-auth --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org --route=Route-2

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-route-auth

disable-services

Syntax

tadm disable-services common_options
(node_host)*

Description

Use this command to remove services for all the instances on a specified node.

Note:
The disable-services command will fail if the administration server is not running as a privileged user.

Operands

node-host

Specify the name of the node.

Example

tadm disable-services --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-services

disable-stats-xml

Syntax

tadm disable-stats-xml common_options --config=config_name
--vs=vs_name

Description

Use this command to disable the server instance statistics.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to disable the server instance statistics.

--vs|-s

Specify the name of the virtual server.

Example

tadm disable-stats-xml --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-stats-xml, get-stats-xml-prop, enable-stats-xml

disable-tcp-access-log

Syntax

tadm disable-tcp-access-log common_options --config=config_name

Description

Use this command to disable the TCP access log for a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to disable TCP access log.

Example

tadm disable-tcp-access-log --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-tcp-access-log, get-tcp-access-log, get-tcp-thread-pool-prop

disable-webapp-firewall

Syntax

tadm disable-webapp-firewall common_options --config=config_name
--vs=vs_name

Description

Use this command to disable the web application firewall for a specific virtual server.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to disable the web application firewall.

--vs|-s

Specify the name of the virtual server.

Example

tadm disable-webapp-firewall --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-webapp-firewall, get-webapp-firewall-prop

enable-access-log

Syntax

tadm enable-access-log common_options [--log-ip]
[--format=log_format] --config=config_name [--vs=vs_name]
--file=log_file

Description

Use this command to enable the access-log.

Options

For information about common_options, run the help command.

--log-ip|-o

Set this option to true to log the IP of the client into the access log.

--format|-f

Specify the log format string for an access log.

--config|-c

Specify the name of the configuration for enabling the access-log.

--vs|-s

Specify the name of the virtual server.

--file|-l

Specify the file name for the access log.

Example

tadm enable-access-log --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org --file=../logs/access.log

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-access-log-prop, disable-access-log

enable-admin-ldap-auth

Syntax

tadm enable-admin-ldap-auth common_options [--group-search-filter=filter] [--search-filter=filter] [--dc-suffix=suffix]
[--group-search-attr=attribute] [--bind-dn=bind_dn] [--auth-expiring-url=url][--timeout=timeout] --ldap-url=ldap:://server:port/dc=acme,dc=com --allow-group=(comma separated list of valid group names)

Description

Use this command to enable the administration server to authenticate against a Lightweight Directory Access Protocol (LDAP) server.

Options

For information about common_options, run the help command.

--group-search-filter|-o

Specify the search filter to find group memberships for the user. Default value: uniquemember.

--search-filter|-f

Specify the search filter to find a user. Default value: uid. You can use the search options to interoperate with Microsoft Active Directory (MSAD). By default, MSAD does not store the user IDs in the usual uid attribute. Instead, it stores the user IDs in an attribute called samAccountName. Therefore, when LDAP searches a MSAD directory to find a user, it does not find a match because it attempts to match the uid attribute. In Oracle Traffic Director, you can set the --search-filter option to override the MSAD default attribute.

--dc-suffix|-x

Specify a suffix for the LDAP database. This parameter defines the root of the Domain Component (dc) tree and is relative to the base DN in the LDAP URL.

--group-search-attr|-t

Specify the LDAP attribute name that contains group name entries. Default value: CN.

--bind-dn|-d

Specify the name that the administration server uses to initially bind or log in to the directory server, for example, cn=Directory Manager. Binding determines the permission level that you are granted for the duration of a connection. The DN supplied in a bind request can be the DN of an alias entry.

--auth-expiring-url|-a

Specify the URL to which the server redirects the request if the password is going to expire soon.

--time-out|-m

Specify the time out option for the LDAP authentication.

--ldap-url|-l

Specify the URL of the LDAP authentication database. The type of authentication database is specified in the URL scheme. The URL format is: ldap://ldaphost:port/<base-dn>

--allow-group|-g

Specify a comma separated list of groups. Users belonging to these groups are allowed to login.

Example

tadm enable-admin-ldap-auth --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt
rcfile=null --ldap-url=ldap://serverhost.com:3950/dc=xyz,dc=xyz,dc=xyz

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-admin-ldap-auth, get-admin-ldap-auth-prop

enable-ciphers

Syntax

tadm enable-ciphers common_options --config=config_name (--http-listener=name|--tcp-listener=name) (ssl3tls_cipher_name)+

Description

Use this command to enable the Secure Sockets Layer (SSL) ciphers. A cipher is a cryptographic algorithm that is used for encryption or decryption.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration file that contains the metadata to configure the runtime services of Oracle Traffic Director.

--http-listener|-r

Specify the name of the HTTP listener.

--tcp-listener|-t

Specify the name of the TCP listener.

Operands

ssl3tls-cipher-name

Specify the name of the ssl3tls cipher. For a list of ciphers, see the list-ciphers help page.

Example

tadm enable-ciphers --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --http-listener=config1_ls
SSL_RSA_EXPORT_WITH_RC4_40_MD5

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-ciphers, list-ciphers

enable-event

Syntax

tadm enable-event common_options (--time=hh:mm [--month=1-12] [--day-of-week=sun|mon|tue|wed|thu|fri|sat]
[--day-of-month=1-31]) | --interval=number_of_seconds ] --config=config_name --command=restart|reconfig|rotate-log|rotate-access-log|update-crl|commandline

For more information about the syntax notations, run the help command.

Description

Use this command to enable an event that you have created.

Options

For information about common_options, run the help command.

--time|-t

Specify the time when you want this event to start. The time format is hh:mm, for example, 12:30.

--month|-m

Specify the month when you want this event to occur. The range of values is 1 to 12.

--day-of-week|-k

Specify the day of the week when you want this event to occur. The values can be Sun, Mon, Tue, Wed, Thu, Fri, or Sat.

--day-of-month|-d

Specify the day of the month when you want this event to occur. The range of values is 1 to 31.

--interval|-r

Specify the time interval at which you want this event to occur. The range of values is 60 to 86400 seconds.

--config|-c

Specify the configuration for which you want to enable an event.

--command|-C

Specify the command the event executes. The value can be restart, reconfig, rotate-log, rotate-access-log, update-crl, or any executable command.

Example

tadm enable-event --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt --time=20:30 --month=11
--day-of-week=mon --day-of-month=15 --config=www.example.org
--command=restart

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-event, delete-event, list-events, disable-event

enable-maintenance

Syntax

tadm enable-maintenance common_options --config=config_name --origin-server-pool=origin_server_pool_name [--response-code=response-code] [--response-file=response-file]

Description

Use this command to enable the maintenance for an origin-server-pool. This command takes response-code and response-file as optional properties. The response-code 200 is not allowed without a response-file.

Options

For information about common_options, run the help command.

--config|-c

Specify the origin-server-pool for which you want to enable maintenance.

--origin-server-pool|-o

Specify the name of an origin-server-pool.

--response-code|-r

Specify the response code of the request when it lands on a maintenance enabled origin server pool. Values: 200 and 400-599. Default: when this code is not configured, its implicit value will be 200 if response-file is specified, else it will be 503.

--response-file|-f

Specify the absolute path of an HTML file to send to the client when the request lands on a maintenance enabled origin server pool.

Example

tadm enable-maintenance --config=test --origin-server-pool=http-pool-1 --response-code=505

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-maintenance, get-maintenance-prop

enable-perfdump

Syntax

tadm enable-perfdump common_options [--uri=uri] --config=config_name --vs=vs_name

Description

Use this command to enable the perfdump utility. Perfdump is a Server Application Function (SAF) built into Oracle Traffic Director that collects various pieces of performance data from the OTD internal statistics and displays them in ASCII text. The perfdump output does not display all the statistics available through the command-line statistics or the Administrator Console.

You can use perfdump even if the Administration Server is not running. You can view the perfdump output through the CLI, which is enabled by default, or you can view the perfdump output through a URI, which you have to enable. If you enable the URI, you must control access to the perfdump URI, else it is visible to users. With perfdump, the statistics are unified. Rather than monitoring a single process, statistics are multiplied by the number of processes, which provides you with an accurate view of the server as a whole.

Options

For information about common_options, run the help command.

--uri|-r

Specify the URI at which the perfdump report should be available.

--config|-c

Specify the name of the configuration to enable perfdump.

--vs|-s

Specify the name of the virtual server for which you want to enable perfdump.

Example

tadm enable-perfdump --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-perfdump, get-perfdump-prop, disable-perfdump

enable-route-auth

Syntax

tadm enable-route-auth common_options --config=config_name
--vs=vs_name --route=route_name ((--client-cert-nickname=nick_name) | (--auth-user=user --auth-header=auth_header))

Description

Use this command to enable the route authentication. Specify the client-cert-nickname to enable the client authentication. Specify the auth-user to enable the basic authentication.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to enable route authentication.

--vs|-s

Specify the virtual server.

--route|-r

Specify the route name.

--client-cert-nickname|-l

Specify the client certificate nickname.

--auth-user|-t

Specify the authenticated user.

--auth-header|-d

Specify the name of the authentication header.

Example

tadm enable-route-auth --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org
--route=Route1 --auth-user=admin --auth-header=header-1-auth

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-admin-ldap-auth, get-admin-ldap-auth-prop, disable-route-auth

enable-services

Syntax

tadm enable-services common_options
(node_host)*

Description

Use this command to create services for all instances on a specified node. The service will not be created if an existing service is found on an instance.

Note:
The enable-services command will fail if the administration server is not running as a privileged user.

Operands

node-host

Specify the name of the node.

Example

tadm enable-services --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-services

enable-stats-xml

Syntax

tadm enable-stats-xml common_options [--uri=uri] --config=config_name --vs=vs_name

Description

Use this command to enable access to virtual-server statistics in XML format through a URI.

Options

For information about common_options, run the help command.

--uri|-r

Specify the URI at which the statistics report in XML format should be available.

--config|-c

Specify the configuration for which you want to enable the server instance statistics.

--vs|-s

Specify the name of the virtual server for which you want to enable the server instance statistics.

Example

tadm enable-stats-xml --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-stats-xml, get-stats-xml-prop, disable-stats-xml

enable-tcp-access-log

Syntax

tadm enable-tcp-access-log common_options --config=config_name (--file=log_file)

Description

Use this command to enable TCP access log for a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to enable TCP access log.

--file|-l

Specify the file name for the access log.

Example

tadm enable-tcp-access-log --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --file=../logs/file1.log

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-tcp-access-log, get-tcp-access-log-prop, get-tcp-access-log

enable-webapp-firewall

Syntax

tadm enable-webapp-firewall common_options --config=config_name --vs=vs_name

Description

Use this command to enable the web application firewall for a specific virtual server.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to enable the web application firewall.

--vs|-s

Specify the name of the virtual server for which you want to enable the web application firewall.

Example

tadm enable-webapp-firewall --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-webapp-firewall get-webapp-firewall-prop

forward-proxy-info

Syntax

tadm forward-proxy-info common_options [--header=header] --config=config_name --vs=vs_name --route=route_name (param)

Description

Use this command to forward the proxy information.

Options

For information about common_options, run the help command.

Specify the name of the proxy parameter you want to forward.

--header|-H

Specify the name of the header.

--config|-c

Specify the configuration for which you want to forward the proxy header.

--vs|-s

Specify the name of the virtual server.

--route|-r

Specify the route name to forward the proxy header.

Operands

jroute

via

ip

cipher

proxy-agent

proxy-auth

keysize

secret-keysize

ssl-id

issuer-dn

user-dn

auth-cert

xforwarded-for

cache-info

ssl

Example

tadm forward-proxy-info --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
--route=forwardproxy1 jroute

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-proxy-info, block-proxy-info

get-access-log

Syntax

tadm get-access-log common_options [--start-date=MM/dd/yyyy:HH:mm:ss] [--end-date=MM/dd/yyyy:HH:mm:ss]
[--status-code=status_code] [--num-records=number_of_records][--vs=vs_name] --config=config_name (node_host)

Description

Use this command to view the Oracle Traffic Director access-log entries. The access log records information about requests to and responses from the server. If non-mandatory options are chosen, this command shows the last 100 entries of the default access log file for the selected configuration and node.

Options

For information about common_options, run the help command.

--start-date|-S

Specify the starting date and time from which the log messages must be shown. The start date should be in the dd/MM/yyyy:HH:mm:ss format.

--end-date|-E

Specify the ending date and time until which the log messages must be shown. The end date should be in the dd/MM/yyyy:HH:mm:ss format.

--status-code|-o

Specify the status code of HTTP response code, for example, 200, 300, or 400.

--num-records|-n

Specify the number of log messages to be shown.

--vs|-s

Specify the name of the virtual server. Use this option if you want to view the access file entries of a particular virtual server.

--config|-c

Specify the name of the configuration for which you want to view the access log information.

Operands

node-host

Specify the name of the node.

Example

tadm get-access-log --user=admin --host=admin.example.com
--password-file=./admin.passwd  --port=8989
--no-prompt --config=www.example.org serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-log, get-access-log-buffer-prop, enable-access-log, disable-access-log, get-log, get-log-prop, set-log-prop, rotate-log

get-access-log-buffer-prop

Syntax

tadm get-access-log-buffer-prop common_options --config=config_name (property_name)*

Description

Use this command to view the access-log buffer properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to view the properties of access-log buffer.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following access-log buffer properties:

enabled
buffer-size
direct-io
max-buffers
max-buffers-per-file
max-age

Note:
The property max-buffers-per-file can return auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

Example

tadm get-access-log-buffer-prop --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org buffer-size

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-access-log-buffer-prop, enable-access-log, disable-access-log, get-access-log, get-log, get-log-prop, set-log-prop, rotate-log

get-access-log-prop

Syntax

tadm get-access-log-prop common_options --config=config_name
[--vs=vs_name] (property_name)*

Description

Use this command to view access-log properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the access-log properties.

--vs|-s

Specify the name of virtual server.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following access-log properties:

enabled
file
format
mode

Example

tadm get-access-log-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org file

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-access-log, disable-access-log, get-access-log, get-log, get-log-prop, set-log-prop, rotate-log

get-admin-ldap-auth-prop

Syntax

tadm get-admin-ldap-auth-prop common_options (property_name)*

Description

Use this command to view the properties of Lightweight Directory Access Protocol (LDAP) authentication database, which is configured as the authentication database of the administration server.

Options

For information about common_options, run the help command.

Operands

property-name

Specify the name of the property that you want to view (Optional).

An LDAP authentication database property that you can view:

enabled

Example

tadm get-admin-ldap-auth-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt enabled

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-admin-ldap-auth, disable-admin-ldap-auth

get-admin-prop

Syntax

tadm get-admin-prop common_options [--node=node_name] (property_name)*

Description

Use this command to view the administration node properties.

Options

For information about common_options, run the help command.

--node|-n

Specify the name of the node.

You can view the following administration properties:

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following administration properties:

install-root
instance-home
java-home
admin-node
server-version
admin-user
server-user
ssl-port
non-ssl-port
log-file
log-level
access-log-file
host
description
admin-password
bind-ip
service-enabled
service-name

Example

tadm get-admin-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt server-user

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-nodes, set-admin-prop, restart-admin, stop-admin, remove-node

get-cache-prop

Syntax

tadm get-cache-prop common_options --config=config_name (property_name)*

Description

Use this command to view the cache properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for viewing the cache properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following cache properties:

enabled
max-entries
replacement
max-heap-object-size
max-heap-space

Example

tadm get-cache-prop --user=admin --host=admin.example.com --password-file=certdb.newpasswd --port=8989
--prompt=false --config=www.example.org max-entries

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-cache-prop

get-cache-rule-prop

Syntax

tadm get-cache-rule-prop common_options --config=config_name --vs=vs_name --rule=cache_rule_name (property_name)*

Description

Use this command to view the cache rule properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to view cache rule properties.

--vs|-s

Specify the virtual server.

--rule|-r

Specify the cache rule name.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following cache rule properties:

enabled
max-reload-interval
min-reload-interval
last-modified-factor
min-object-size
max-object-size
cache-auth
query-maxlen
compression
cache-https-response
condition

Example

tadm get-cache-rule-prop --config=www.example.org --vs=www.example.org --rule=cache-rule-1 query-maxlen

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-cache-prop, set-cache-rule-prop

get-cert-prop

Syntax

tadm get-cert-prop common_options [--token=name] --config=config_name --nickname=nick_name (property_name)*

Description

Use this command to view the certificate properties. The get-cert-prop command prompts for a token password if the token is password protected.

Options

For information about common_options, run the help command.

--token|-t

Specify the token or cryptographic device, which contains the encrypted public key.

--config|-c

Specify the name of the configuration for which the certificate properties are displayed.

--nickname|-n

Specify the short name or nickname of the certificate.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following certificate properties:

Nickname
Subject
Issuer
Valid From
Valid Till
Fingerprint
Serial Number
Trusted to sign Client Certificates
Trusted to sign Server Certificates

Example

tadm get-cert-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --token=internal
--nickname=OTD Trusted to sign client certificates

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-cert, delete-cert, list-certs, set-cert-trust-prop, create-selfsigned-cert, create-cert-request

get-compression-rule-prop

Syntax

get-compression-rule-prop --config=config_name --vs=vs_name --rule=compression_rule_name (property_name)*

Description

Use this command to view compression rule properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration name for which you want to view compression rule properties.

--vs|-s

Specify the name of the virtual server.

--rule|-r

Specify the compression rule name.

Operand

property-name

Specify the property name that you want to view (Optional).

You can view the following compression rule properties:

insert-vary-header
compression-level
fragment-size
condition

Note:
The property compression-level can return auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

Example

tadm get-compression-rule-prop --config=www.example.org
--vs=soa.example.org --rule=compression2
compression-level

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-compression-rule, delete-compression-rule, list-compression-rules, set-compression-rule-prop

get-config-file

Syntax

tadm get-config-file common_options --config=config_name (file_name)

Description

Use this command to view any configuration file present in the config directory under server-root.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the configuration file.

Operands

file-name

Specify the name of the configuration file that you want to view.

Example

tadm get-config-file --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org obj.conf

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, list-configs, deploy-config, copy-config, pull-config, set-config-file, delete-config, list-backups, restore-config

get-config-prop

Syntax

tadm get-config-prop common_options --config=config_name
(property_name)*

Description

Use this command to view the configuration properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for viewing the configuration file properties.

Operands

property-name: Specifies the name of the property that you want to view (Optional).

You can view the following configuration properties:

user
temp-path

max-fd: Specifies a configurable upper limit on the file descriptor usage of the Oracle Traffic Director server process. This means that Oracle Traffic Director does not assume more than configured max-fd number of available file descriptors even if the actual file descriptor availability is higher.
Values: 64 to 2147483647 or -1 for no limit. Default: 2097152.

Example

tadm get-config-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org temp-path

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-config-prop

get-config-stats

Syntax

tadm get-config-stats common_options [--node=node_name]
--config=config_name

Description

Use this command to view the configuration statistics at the instance or configuration level.

Options

For information about common_options, run the help command.

--node|-n

Specify the node name.

--config|-c

Specify the configuration for which you want to view the configuration statistics.

Example

tadm get-config-stats --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-nodes

get-crl-prop

Syntax

tadm get-crl-prop common_options --config=config_name
--issuer-name=ca_name (property_name)*

Description

Use this command to display the Certificate Revocation List (CRL) properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the CRL properties.

--issuer-name|-r

Specify the name of the Certificate Authority (CA) issuer. The value can be the name of a company, organization, or department.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following CRL properties:

crl-name
issuer
last-update
next-update

Example

tadm get-crl-prop --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt --config=www.example.org --issuer-name="GlobalSign ServerSign CA" next-update

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-crl, delete-crl, list-crls

get-dns-cache-prop

Syntax

tadm get-dns-cache-prop common_options --config=config_name
(property_name)*

Description

Use this command to view the Domain Name Server (DNS) cache properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the DNS cache properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following DNS cache properties:

enabled
max-age
max-entries

Example

tadm get-dns-cache-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org max-age

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-dns-cache-prop

get-dns-prop

Syntax

tadm get-dns-prop common_options --config=config_name (property_name)*

Description

Use this command to view the Domain Name Server (DNS) properties. DNS associates a standard IP address such as, 192.0.3.11, with host names such as, www.example.com.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the DNS properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following DNS properties:

enabled
async
timeout

Example

tadm get-dns-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org timeout

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-dns-prop

get-failover-group-prop

Syntax

tadm get-failover-group-prop common_options --config=config_name --virtual-ip=VIP (property_name)*

Description

Use this command to view the properties of a failover group.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to view the failover group properties.

--virtual-ip|-i

Specify the IP address of the failover group for which you want to view properties.

Operand

property-name

Specify the name of the property that you want to view (Optional).

You can view the following failover group properties:

virtual-ip
backup-node
network-prefix-length
active-node
router-id
primary-node
primary-nic
backup-nic

Example

tadm get-failover-group-prop --config=soa --virtual-ip=10.229.231.254

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-failover-group, create-failover-group, list-failover-groups, set-failover-group-primary

get-health-check-prop

Syntax

tadm get-health-check-prop common_options --config=config_name --origin-server-pool=origin_server_pool_name (property_name)*

Description

Use this command to view the health-check properties.

Health check monitors include the built-in health check monitors, including HTTP/HTTPS and TCP Connect Health Check, as well as a generic health check hookup mechanism, so that customers can write their own programs/scripts to monitor the health of specific origin servers. This mechanism is especially useful when you want to have a protocol-level health check monitor for the origin servers, which provide different services.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the health-check properties.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to view the health- check properties.

Operand

property-name

Specify the name of the property that you want to view (Optional).

You can view the following health check properties:

protocol
interval
timeout
command
failover-threshold
request-method
request-uri
response-code-match
response-body-match
response-body-match-size
dynamic-server-discovery

Example

tadm get-health-check-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --origin-server-pool=test-pool
interval

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-health-check-prop

get-http-listener-prop

Syntax

tadm get-http-listener-prop common_options --config=config_name --http-listener=name (property_name)*

Description

Use this command to view the HTTP listener socket properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for viewing the HTTP listener properties.

--http-listener|-r

Specify the name of the HTTP listener.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following HTTP listener properties:

enabled
ip
port
acceptor-threads
server-name
blocking-io
handle-protocol-mismatch
family
listen-queue-size
receive-buffer-size
send-buffer-size
default-virtual-server-name
description

Note:
The properties family and acceptor-threads can return default as a value. Default implies that the server will compute the value of these properties at runtime.

Example

tadm get-http-listener-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --http-listener=listener1
blocking-io

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-http-listener, set-http-listener-prop, list-http-listeners, delete-http-listener

get-http-prop

Syntax

tadm get-http-prop common_options --config=config_name (property_name)*

Description

Use this command to view the HTTP properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for viewing the HTTP properties.

Operands

property-name: Specifies the name of the property that you want to view (Optional).

You can view the following HTTP properties:

version
server-header
etag
request-header-buffer-size
strict-request-headers
discard-misquoted-cookies
max-request-headers
output-buffer-size
max-unchunk-size
unchunk-timeout
io-timeout
request-body-timeout
request-header-timeout

case-sensitive-headers: Indicates whether the server should preserve the case of the HTTP request/response headers.
Values: true, false. Default: false.

Example

tadm get-http-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org io-timeout

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-http-prop

get-keep-alive-prop

Syntax

tadm get-keep-alive-prop common_options --config=config_name
(property_name)*

Description

Use this command to view the keep-alive properties. The keep-alive or HTTP/1.1 persistent connection handling subsystem in Oracle Traffic Director is designed to be scalable. If the configuration does not conform as required, the performance can be less than optimal if the workload is not persistent (that is, HTTP/1.0 without the KeepAlive header), or for a lightly loaded system that is primarily servicing keep-alive connections.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for viewing the keep-alive properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following keep-alive properties:

enabled
threads
max-connections
timeout
poll-interval

Note:
The properties threads and max-connections can return auto-tuned as a value. Auto-tuned implies that the server will compute the value of these properties at runtime.

Example

tadm get-keep-alive-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
poll-interval

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-keep-alive-prop

get-localization-prop

Syntax

tadm get-localization-prop common_options [--vs=vs_name]
--config=config_name (property_name)*

Description

Use this command to view the localization properties. You can configure your browsers to send an Accept-language header that describes the language preference for the content that you are accessing. All end-user error messages are also based on the Accept-language header.

Options

For information about common_options, run the help command.

--vs|-s

Specify the name of the virtual server.

--config|-c

Specify the configuration for which you want to view the localization properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following localization properties:

default-language
negotiate-client-language

Example

tadm get-localization-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
default-language

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-localization-prop

get-log

Syntax

tadm get-log common_options [--start-date=MM/dd/yyyy:HH:mm:ss] [--end-date=MM/dd/yyyy:HH:mm:ss]
[--log-level=all|incident_error:1|error:1|error:16|error:32|warning:1|notification:1|trace:1|trace:16|trace:32][--num-records=number_of_records]
--vs=vs_name --config=config_name node_host

Description

Use this command to get the information about error logs. The error log lists all the errors that the server has encountered since the log file was created. It also contains other server information, such as when the server was started, and a list of unsuccessful login attempts made to the server.

Options

For information about common_options, run the help command.

--start-date|-S

Specify the starting date and time from which the log messages must be shown. The format of the date must be dd/MM/yyyy:HH:mm:ss.

--end-date|-E

Specify the ending date and time until which the log messages must be shown. The format of the date must be dd/MM/yyyy:HH:mm:ss.

--log-level|-l

Specify the severity of the log messages that must be shown. The value can be all, INCIDENT_ERROR:1, ERROR:1, ERROR:16, ERROR:32, WARNING:1, TRACE:1, TRACE:16, TRACE:32. Default: NOTIFICATION:1.

--num-records|-n

Specify the number of log messages to be shown from the end of the error log file.

--vs|-s

Specify the name of the virtual server.

--config|-c

Specify the configuration for which you want to view error log information.

Operands

node-host

Specify the name of the node

Example

tadm get-log --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt --vs=soa.example.org --config=www.example.org serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-access-log-prop, rotate-log, get-access-log, enable-access-log, disable-access-log

get-log-prop

Syntax

tadm get-log-prop common_options --config=config_name (property_name)*

Description

Use this command to view the log properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for viewing the log properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following log properties:

log-stdout
log-stderr
log-virtual-server-name
create-console
log-to-console
log-to-syslog
archive-command
log-level
log-file

Example

tadm get-log-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org log-file

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-log-prop

get-maintenance-prop

Syntax

tadm get-maintenance-prop common_options --config=config_name --origin-server-pool=origin_server_pool_name (property_name)*

Description

Use this command to return the maintenance properties for an origin-server-pool.

Options

For information about common_options, run the help command.

--config|-c

Specify the origin-server-pool for which you want to return properties.

--origin-server-pool|-o

Specify the name of an origin-server-pool.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following maintenance properties:

enabled
response-file
response-code

Example

tadm get-maintenance-prop --config=test --origin-server-pool=http-pool-1 response-code

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-maintenance, enable-maintenance

get-origin-server-pool-prop

Syntax

tadm get-origin-server-pool-prop common_options --config=config_name  --origin-server-pool=origin_server_pool_name (property_name)*

Description

Use this command to view origin-server pool properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration to view the origin-server pool properties.

--origin-serve-pool|-o

Specify the name of the origin-server pool.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following origin-server pool properties:

name
type
family
load-distribution
proxy-server

Example

tadm get-origin-server-pool-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --origin-server-pool=test-pool family

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-origin-server-pool, delete-origin-server-pool, list-origin-server-pools, set-origin-server-pool-prop

get-origin-server-prop

Syntax

tadm get-origin-server-prop common_options --config=config_name --origin-server-pool=origin_server_pool_name
--origin-server=host:port (property_name)*

Description

Use this command to view origin server properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the origin server properties.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to view the origin server properties.

--origin-server|-O

Specify the origin server of the format host:port

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following origin server properties:

enabled
host
port
weight
backup
max-connections
ramp-up-time

Example

tadm get-origin-server-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--origin-server-pool=test-pool --origin-server=www.mail2.com:8080
weight

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-origin-server, delete-origin-server, list-origin-servers, set-origin-server-prop

get-origin-server-stats

Syntax

tadm get-origin-server-stats common_options --config=config_name --node=node_name --origin-server-pool=origin_server_pool_name

Description

Use this command to view the origin-server statistics for a given configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the origin server properties.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to view the origin server properties.

--node|-n

Specify the name of the node.

Example

tadm get-origin-server-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--origin-server-pool=test-pool --node=www.mail2.com:8080

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-origin-server, delete-origin-server, list-origin-servers, set-origin-server-prop

get-perfdump

Syntax

tadm get-perfdump common_options --config=config_name --node=node_name

Description

Use this command to view the perfdump statistics. The perfdump utility is a Server Application Function (SAF) built into Oracle Traffic Director. The utility collects the Oracle Traffic Director performance data and displays it in ASCII format.

This utility allows you to monitor a greater variety of statistics. With perfdump, the statistics are unified. Rather than monitoring a single process, statistics are multiplied by the number of processes. This gives you a more accurate view of the server performance.

Options

For information about common_options, run the help command.

--node|-n

Specify the name of the node.

--config|-c

Specify the name of the configuration to view the perfdump statistics.

Example

tadm get-perfdump --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt --config=www.example.org --node=node1.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-perfdump-prop, enable-perfdump, disable-perfdump, list-nodes

get-perfdump-prop

Syntax

tadm get-perfdump-prop common_options --config=config_name --vs=vs_name
(property_name)*

Description

Use this command to get the perfdump properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the perfdump properties.

--vs|-s

Specify the name of the virtual server

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following perfdump properties:

enabled
uri

Example

tadm get-perfdump-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org uri

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-perfdump, enable-perfdump, disable-perfdump

get-pkcs11-prop

Syntax

tadm get-pkcs11-prop common_options --config=config_name
(property_name)*

Description

Use this command to view the Public Key Cryptography Standard (PKCS#11) properties. PKCS#11 defines the interface used for communication between the Secure Sockets Layer (SSL) and PKCS#11 modules. PKCS#11 modules are used for standards-based connectivity to SSL hardware accelerators.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the PKCS#11 properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following PKCS#11 properties:

enabled
allow-bypass
crl-path

Example

tadm get-pkcs11-prop --user=admin --host=admin.example.com --port=8989
--password-file=./admin.passwd --no-prompt
--config=www.example.org allow-bypass

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-pkcs11-prop, list-tokens, set-token-prop, set-token-pin

get-qos-limits-prop

Syntax

tadm get-qos-limits-prop common_options --config=config_name
[--vs=vs_name] (property_name)*

Description

Use this command to view the Quality of Service (QoS) limit properties. QoS is the performance limits you set for a server instance or virtual server.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the QoS limits properties.

--vs|-s

Specify the name of the virtual server.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following QoS limits properties:

enabled
max-bps
max-connections

Example

tadm get-qos-limits-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
max-bps

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-qos-limits-prop, get-qos-prop, set-qos-prop

get-qos-prop

Syntax

tadm get-qos-prop common_options --config=config_name (property_name)*

Description

Use this command to view the Quality of Service (QoS) properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the QoS properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following QoS properties:

enabled
interval

Example

tadm get-qos-prop --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org interval

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-qos-prop, get-qos-limits-prop, set-qos-limits-prop

get-request-limit-prop

Syntax

tadm get-request-limit-prop common_options --config=config_name
--vs=vs_name --request-limit=request_limit_name (property_name)*

Description

Use this command to view request-limit properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the request-limit properties.

--vs|-s

Specify the name of the virtual server.

--request-limit|-l

Specify the request limit name.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following request limit properties:

max-rps
max-connections
rps-compute-interval
condition
continue-condition
error-code
monitor-attribute

Example

tadm get-request-limit-prop --config=www.example.org
--vs=soa.example.org --request-limit=request234  error-code

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-request-limits, delete-request-limit, create-request-limit, set-request-limit-prop

get-route-auth-prop

Syntax

tadm get-route-auth-prop common_options --config=config_name --vs=vs_name --route=route_name

Description

Use this command to view the route authentication properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to view the route authentication properties.

--vs|-s

Specify the virtual server.

--route|-r

Specify the route name.

Example

tadm get-route-auth-prop --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org --route=Rule-1-auth

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, disable-route-auth, enable-route-auth, disable-route-auth

get-route-prop

Syntax

tadm get-route-prop common_options --config=config_name --vs=vs_name --route=route_name (property_name)*

Description

Use this command to view route properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the route properties.

--vs|-s

Specify the name of the virtual server.

--route|-r

Specify the route name that you want to view.

Operands

property-name

Specify the name of the property name that you want to view (Optional).

You can view the following route properties:

server
sticky-cookie
sticky-param
route-header
route-cookie
rewrite-headers
validate-server-cert
use-keep-alive
keep-alive-timeout
timeout
always-use-keep-alive
protocol
proxy-agent
origin-server-pool
from
to
websocket-upgrade-enabled
condition
log-headers
buffer-size

Example

tadm get-route-prop --config=www.example.org --vs=soa.example.org --route=Route323 route-header

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-route, list-routes, set-route-prop, delete-route

get-snmp-prop

Syntax

tadm get-snmp-prop common_options --config=config_name (property_name)*

Description

Use this command to view the Simple Network Management Protocol (SNMP) properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the SNMP properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following SNMP properties:

enabled
description
organization
location
contact

Example

tadm get-snmp-prop --config=www.example.org description

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, stop-snmp-subagent, start-snmp-subagent, set-snmp-prop

get-ssl-prop

Syntax

tadm get-ssl-prop common_options --config=config_name (--http-listener=name|tcp-listenener=name) (property_name)*

Description

Use this command to view the Secure Sockets Layer (SSL) properties for an HTTP and TCP listener. SSL is a software library establishing a secure connection between the client and server. SSL is used to implement HTTPS, the secure version of HTTP.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the SSL properties.

--http-listener|-r

Specify the name of the configuration to view the SSL properties.

--tcp-listener|-t

Specify the name of the TCP listener.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following SSL properties:

enabled
strict-sni-vs-host-match
tls-session-tickets-enabled
server-cert-nickname
ssl3
tls
client-auth
client-auth-timeout
max-client-auth-data
tls-rollback-detection

Example

tadm get-ssl-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --http-listener=config1_ls client-auth-timeout

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-ssl-prop

get-ssl-session-cache-prop

Syntax

tadm get-ssl-session-cache-prop common_options --config=config_name (property_name)*

Description

Use this command to view the properties that are currently defined for caching SSL session data.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the SSL session cache properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following SSL session cache properties:

enabled
max-entries
max-ssl3-tls-session-age

Example

tadm get-ssl-session-cache-prop --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org max-entries

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-ssl-session-cache-prop

get-stats-prop

Syntax

tadm get-stats-prop common_options --config=config_name (property_name)*

Description

Use this command to view properties of the statistics collection subsystem.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to view the statistics collection subsystem properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following statistics collection subsystem properties:

enabled
interval
profiling

Example

tadm get-stats-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org interval

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-stats-prop

get-stats-xml

Syntax

tadm get-stats-xml common_options --config=config_name --node=node_name

Description

Use this command to view the statistics pertaining to an instance of a configuration, in XML format.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the XML statistics.

--node|-n

Specify the name of the node.

Example

tadm get-stats-xml --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --node=node1.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-stats-xml-prop, enable-stats-xml, disable-stats-xml, list-nodes

get-stats-xml-prop

Syntax

tadm get-stats-xml-prop common_options --config=config_name --vs=vs_name
(property_name)*

Description

Use this command to view the properties defined for gathering and reporting statistical data in XML format.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the XML statistics properties.

--vs|-s

Specify the name of the virtual server.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following statistical data properties:

enabled
uri

Example

tadm get-stats-xml-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org enabled

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-stats-xml, disable-stats-xml

get-tcp-access-log

Syntax

tadm get-tcp-access-log common_options [--start-date=MM/dd/yyyy:HH:mm:ss] [--end-date=MM/dd/yyyy:HH:mm:ss] [--num-records=number_of_records]  --config=config_name node_host

Description

Use this command to view the TCP access log entries. The access log records information about requests to and responses from the server. If non-mandatory options are chosen, this command shows the last 100 entries of the default TCP access log file for the selected configuration and node.

Options

For information about common_options, run the help command.

--start-date|-S

Specify the starting date and time from which the log messages must be shown. The start date should be in the dd/MM/yyyy:HH:mm:ss format.

--end-date|-E

Specify the ending date and time until which the log messages must be shown. The end date should be in the d/MM/yyyy:HH:mm:ss format.

--num-records|-n

Specify the number of log messages to be shown.

--config|-c

Specify the name of the configuration for which you want to view the access log information.

Operands

node-host

Specify the name of the host.

Example

tadm get-tcp-access-log-prop --user=admin --port=8989
--password-file=./admin.passwd --host=admin.example.com
--no-prompt --config=www.example.org node1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-tcp-access-log, disable-tcp-access-log, get-tcp-access-log-prop

get-tcp-access-log-prop

Syntax

tadm get-tcp-access-log-prop common_options --config=config_name (property_name)*

Description

Use this command to view the properties of the TCP access log. The tcp-access element defines global level access logging settings.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you would like to view the properties of the TCP access log.

Operands

property-name

Specify the name of the property that you want to view (optional).

You can view the following access-log buffer properties:

enabled
file

Example

tadm get-tcp-access-log-prop --user=admin --port=8989
--password-file=./admin.passwd --host=admin.example.com
--no-prompt --config=www.example.org enabled

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-tcp-access-log, disable-tcp-access-log, get-tcp-access-log-prop

get-tcp-listener-prop

Syntax

tadm get-tcp-listener-prop common_options --config=config_name --tcp-listener=name (property_name)*

Description

Use this command to view the properties of the TCP listener.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you would like to view the properties of the TCP listener.

--tcp-listener|-t

Specify the name of the TCP listener.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following properties for the TCP listener:

enabled
name
ip
port
family
acceptor-threads
tcp-proxy-name
listen-queue-size
receive-buffer-size
send-buffer-size
description

Note:
The properties family and acceptor-threads can return auto-tuned as a value. Auto-tuned implies that the server will compute the value of these properties at runtime.

Example

tadm get-tcp-listener-prop --user=admin --port=8989
--password-file=./admin.passwd --host=admin.example.com
--no-prompt --config=www.example.org --tcp-listener=TCP_Listener1 listen-queue-size

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-listener, delete-tcp-listener, list-tcp-listeners, set-tcp-listener-prop

get-tcp-proxy-prop

Syntax

tadm get-tcp-proxy-prop common_options --config=config_name --tcp-proxy=tcp-proxy-name (property_name)*

Description

Use this command to view the properties of the TCP proxy.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the tcp-proxy properties.

--tcp-proxy|-r

Specify the name of the TCP proxy.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following properties for the TCP proxy:

enabled
name
session-idle-timeout
origin-server-pool-name

Example

tadm get-tcp-proxy-prop --user=admin --port=8989
--password-file=./admin.passwd
--no-prompt --config=www.example.org --tcp-proxy=proxy1 enabled

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-proxy, delete-tcp-proxy, list-tcp-proxies, set-tcp-proxy-prop

get-tcp-proxy-stats

Syntax

tadm get-tcp-proxy-stats common_options --config=config_name --tcp-proxy=tcp-proxy-name (property_name)*

Description

Use this command to view the statistics for a given TCP proxy.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the tcp-proxy properties.

--tcp-proxy|-r

Specify the name of the TCP proxy.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following properties for the TCP proxy:

countActiveConnections
countRequests
countRequestsAborted
countRequestsTimeout
countBytesReceived
countBytesTransmitted
milliSecondsConnectionActiveAverage
name

Example

tadm get-tcp-proxy-stats --user=admin --port=8989
--password-file=./admin.passwd
--no-prompt --config=www.example.org --tcp-proxy=proxy1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-proxy, delete-tcp-proxy, list-tcp-proxies, set-tcp-proxy-prop

get-tcp-thread-pool-prop

Syntax

tadm get-tcp-thread-pool-prop common_options --config=config_name (property_name)*

Description

Use this command to view the properties of the TCP thread pool. The tcp-thread-pool element configures the threads that are used to proxy data for upgraded websocket connections and generic TCP connections.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the TCP thread pool properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

enabled
threads
max-conections
timeout
stack-size
poll-interval
buffer-size

Note:
The properties max-connections and threads can return auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

Example

tadm get-tcp-proxy-prop --config=www.example.org enabled

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-tcp-thread-pool-prop

get-thread-pool-prop

Syntax

tadm get-thread-pool-prop common_options --config=config_name (property_name)*

Description

Use this command to view the thread-pool properties. The thread-pool element configures the threads used to process HTTP requests. You can use thread pools to allocate a certain number of threads to a specific service. By defining a pool with the maximum number of threads as 1, only one request is allowed to the specified service function.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to view the thread-pool properties.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following thread-pool properties:

enabled
queue-size
min-threads
max-threads
stack-size

Note:
The properties max-threads, queue-size and min-threads can return auto-tuned as a value. Auto-tuned implies that the server will compute the value of these properties at runtime.

Example

tadm get-thread-pool-prop --user=admin --port=8989
--password-file=./admin.passwd --host=admin.example.com
--no-prompt --config=www.example.org queue-size

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-thread-pool-prop

get-virtual-server-prop

Syntax

tadm get-virtual-server-prop common_options --config=config_name --vs=vs_name (property_name)*

Description

Use this command to view the properties of a virtual-server.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for viewing the virtual-server properties.

--vs|-s

Specify the name of the virtual server.

Operands

property-name

Specify the name of the property that you want to view (Optional).

You can view the following virtual-server properties:

enabled
host
default-object-name
http-listener-name
object-file
canonical-server-name
log-file
server-cert-nickname

Note:
The property default-object-name can return auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

Example

tadm get-virtual-server-prop --user=admin --port=8989
--password-file=./admin.passwd --host=admin.example.com
--no-prompt --config=www.example.org --vs=soa.example.org
object-file

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-virtual-server, set-virtual-server-prop, list-virtual-servers, copy-virtual-server, delete-virtual-server

get-virtual-server-stats

Syntax

tadm get-virtual-server-stats common_options [--node=node_name] --config=config_name --vs=vs_name

Description

Use this command to view the virtual-server statistics for a given configuration.

Options

For information about common_options, run the help command.

--node|-n

Specify the name of the node. If this option is not specified, a collated statistics of the virtual server across all the instances of the configuration is displayed.

--config|-c

Specify the configuration to view the virtual-server statistics.

--vs|-s

Specify the name of virtual server.

Example

tadm get-virtual-server-stats --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-virtual-server, set-virtual-server-prop, list-virtual-servers, copy-virtual-server, delete-virtual-server, get-virtual-server-prop

get-webapp-firewall-prop

Syntax

tadm get-webapp-firewall-prop common_options --config=config_name --vs=vs_name (property_name)*

Description

Use this command to view the properties of a web application firewall.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration to view the virtual-server statistics.

--vs|-s

Specify the name of virtual server.

Operands

property-name

Specify the name of the property that you want to view (Optional).

Example

tadm get-webapp-firewall-prop --user=admin --host=admin.example.comhost=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-virtual-server, set-virtual-server-prop, list-virtual-servers, copy-virtual-server, delete-virtual-server, get-virtual-server-prop

help

Describes the command-line interface.

Syntax

The usage of the tadm command-line utility is as follows:

- tadm --version|-V
Displays the version of the CLI.

- tadm --help|-?
Displays this page in text format.

- tadm help|-?
Displays this page in text format.

- tadm --user|-u admin-user [--password-file|-w] [admin-passwd-file] [--host|-h admin-host] [--port|-p admin-port] [[--rcfile|-R rcfile] launches tadm in shell mode.

- tadm subcommand --help
Displays help for the specified subcommand.

tadm subcommand options

Displays the usage syntax for the specified subcommand.

Syntax Notations

The following conventions are used in this document to show the syntax for command-line options:

- Plain text: Type the text as is.
Example: option

- Italicized text: Placeholder for the value of an option or operand. When running CLI commands, you should substitute such placeholders with appropriate values.
Example: parameter

- Text in square brackets: Optional argument.
Example: [argument]

- Asterisk (*) after text in square brackets: Optional argument; you can specify multiple instances.
Example: [argument]*

- Plus symbol (+) after text: Mandatory argument; you can specify multiple instances.
Example: [argument]+

- Vertical bar symbol (|) between text: Optional values: specify one of them.
Example: opt1|opt2

Description

The command-line interface (CLI) enables you to configure and administer Oracle Traffic Director. Use the command-line tool tadm to execute the administration commands.

You can invoke tadm in standalone mode, shell mode, or file mode.

- Standalone mode – In standalone mode, you can directly invoke the CLI specifying the desired command, options, and operands. On completion of a command, the CLI returns to the shell.
---------------------------------------------------------

- Shell mode — In the shell mode, you can invoke the CLI from a shell that is embedded within tadm. On completion of the command, the CLI returns to the shell. You can exit the shell by typing exit or quit. To enter the Shell mode, user, password, and port options are mandatory. If the port details are not specified, the default port is used. The default port number is 8989.
Example:

---------------------------------------------------------

$ tadm --user=admin --port=8081 --password-file=./admin.passwd

tadm> list-configs

www.example.org

--------------------------------------------------------

- File mode — In the file mode, you can create a plain text containing a list of valid commands. The file mode accepts user and password-file when you invoke tadm.
Example:

---------------------------------------------------------

$ cat sample.tcl

set tadm::command false

set x [list-configs]

puts $x

$ tadm --user=admin --password-file=./admin.passwd --commands-file=sample.tcl

--------------------------------------------------------

tadm Variables

You can also set the following tadm variables to modify the overall behavior of tadm:

- tadm::command: (Applicable only in file mode.) Enables you to output all commands to stdout and stderr. If this variable is set to true, exceptions do not stop the execution of commands, rather, they are printed in the stdout and the next command is executed. You can set this variable in the commands-file.
-------------------------------------------------------

$ cat commands.tcl

set tadm::command true

set x [list-configs]

puts $x

In this example, commands.tcl is the name of the file which contains a list of valid commands.

--------------------------------------------------------

- tadm::savehist: (Applicable only in the shell mode.) If set to true, all tadm commands that you execute are saved in the tadm::histfile file. The tadm::histfile is saved in your home directory. You can set this variable in the tadm environment using the tadm set tadm::savehist true command.

- tadm::file: This is set to true if you are executing the tadm commands in file mode.

- tadm::tokenize: If set to true, tadm parses the log files in a TCL friendly format.

- tadm::log_date_format: Use this variable to define the date format in the log files. The default format is MM/dd/yyyy:HH:mm:ss.

- tadm::date_format: Use this variable to define a date format in which a user can enter a date. The default value is the date format of the current locale.

- tadm::property_separator: Use this variable to define the property separators. The default value is the equal sign (=). (for example, tadm> set tadm::property_separator :).

- tadm::field_separator: Use this variable to define the field or column separator. The default value is a blank space ( ). (for example, tadm> set tadm::field_separator |).

- tadm::field_format: Use this variable to define the display format of a field or column. Default value: %-15s. (for example, tadm> set tadm::field_format %-15s|).

Common Options

The term Common Options is used in this document, and in the CLI man pages, to represent the following options:

- Options such as --user, --port, and --host, which are required to connect to the administration server. These options need not be specified in the shell mode.

- Options such as --echo and --verbose, which are common across several commands.

The following is the full list of common options.

--user|-u

Specify the user name of the authorized Oracle Traffic Director administrator.

Note:
The --user|-u option is not mandatory for the following CLI commands:

- configure-server

- unconfigure-server

- start-snmp-subagent

- stop-snmp-subagent

The --user|-u option is not required while executing the reset-admin-password command.

- When you use the configure-server command to create the administration server, --user|-u option specifies the log-in name for the administration server. It defaults to admin while configuring the administration server.

- When you use the configure-server command to create an administration node, --user|-u option specifies the log-in name that should be used to connect to the administration server. This is a mandatory option while configuring the administration node.

--password-file|-w

Specify the name and the location of the password file. The password file contains the password to authenticate administrators to the administration server. Apart from the administration password, you can also specify other passwords such as bind-password, user-password, and token-pin. If you do not specify this option, you will be prompted for a password when you execute the command. You will also be prompted for password(s) if the required password(s) are not mentioned in the password file you specified.

A sample password file is as follows:

tadm_password=tadm-password
tadm_bind_password=bind-password
tadm_user_password=user-password
tadm_token_pin=token-pin
tadm_new_token_pin=new-token-password
tadm_admin_password=admin-password
tadm_<token_name>=token-pin

Note:
tadm_<token_name> is applicable only for the start-instance command. You can use tadm_<token_name> to set multiple token pins to start instances on multiple nodes.
For example, a default token named internal is configured for any instance. The entry for the default token in the password-file will be tadm_internal=88888888.

--host|-h

Specify the name of the computer on which the administration server is running. The default host is localhost.

Note:
This option is required only if you are connecting to the administration server remotely. The --host|-h option is not required while executing the reset-admin-password command.

--port|-p

Specify the SSL port number of the administration server. The default port is 8989.

Note:
The --port|-p option is not required while executing the reset-admin-password command.

- If you are creating the administration server using the configure-server command, --port|-p option specifies the SSL port on which the administration server should listen.

- If you are creating an administration node using the configure-server command, --port|-p option specifies the SSL port of the remote administration server with which the administration node should be registered.

--no-ssl|-N

Specify this option to use a plain text connection to communicate with the administration server. The default connection is SSL.

--rcfile|-R

Specify the name of the rcfile that must be loaded when you start tadm. The default file is ~/.tadmrc. The .tadmrc file is a TCL file that is loaded before any command is executed. You can use the long options as variables by changing the hyphen (-) in the option name to underscore (_) and prefixing it with tadm. For example:

- --config can be set as set tadm_config config1

- --key-type can be set as set tadm_key_type ecc

A sample rcfile is as follows:

set tadm_config sampleconfig
set tadm_password mypassword
set tadm_nodehost sample.mail.com

--echo|-e

Specify this option to print this command on the standard output before executing. This option also prints the default value for all the non-mandatory options that you do not provide in the command.

--no-prompt|-Q

If you specify this option, tadm will not prompt you for passwords while executing this command. Use this option if you have defined all passwords in a password file and specified the file using the --password-file option.

--verbose|-v

Specify this option to display a verbose output.

--command|-C

Specify the name of the commands file which contains the list of tadm commands. For more information about commands file, see the description of the file mode.

Exit Codes

The following exit codes are returned:

- 0 – command executed successfully

- 1 to 4 – connection failure errors

- 10 to 22 – parsing errors

- 33 to 43 – input/output errors

- 44 to 56 – general errors; for example, invalid configuration value

- 76 to 96 – generic back-end errors

- 110 to 123 – errors that are specific to Mbeans

- 125 and above – unknown errors

install-cert

Syntax

tadm install-cert common_options [--token=name] [--file-on-server] --config=config_name --cert-type=server|chain|ca [--nickname=nick_name] cert_file

Description

Use this command to install a certificate. You should have the server certificate text (ASCII) in a file issued by the certificate authority (CA).

Options

For information about common_options, run the help command.

--token|-t

Specify the token (cryptographic device) on which the certificate should be installed.

--file-on-server|-f

If you specify this option, the server certificate is available on the administrator server. If you do not specify this option, the file is assumed to be available on the client machine and will be uploaded to the server.

--config|-c

Specify the name of the configuration for which you are installing the certificate.

--cert-type|-y

Specify the type of certificate. The values can be server, chain, or ca.

- server — Type of certificate that is installed is a server certificate. This certificate should be requested from the same configuration and token which is being installed.

- chain — Type of certificate that is installed is a CA chain certificate. This certificate chain contains one or more intermediate CAs.

- ca — Type of certificate that is installed is a CA certificate.

--nickname|-n

Specify the nickname (short name) of the certificate. This option is required only for the server type certificate.

Operands

cert-file

Specify the name of the file that stores the certificate on the server.

Example

tadm install-cert --user=admin --host=admin.example.com --port=8989
--prompt=false --password-file=./admin.pwd --config=www.example.org --cert-type=server --nickname=cert1 certbin.req

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-cert-request, list-certs, delete-cert, get-cert-prop, set-cert-trust-prop, create-selfsigned-cert

install-crl

Syntax

tadm install-crl common_options [--file-on-server] --config=config_name crl_file

Description

Use this command to install a Certificate Revocation List (CRL). A CRL is a revocation list provided by a certificate authority (CA). A CRL lists all certificates that either client or server users should no longer trust. When the data in a certificate changes, the certificate is revoked.

Options

For information about common_options, run the help command.

--file-on-server|-f

If you specify this option, the CRL file is available on the administration server computer. If you do not specify this option, the CRL file is assumed to be available on the client machine and will be uploaded to the server.

--config|-c

Specify the name of the configuration where you want to install the CRL.

Operands

crl-file

Specify the full path of the CRL file that you want to install.

Example

tadm install-crl --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org ServerSign.crl

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-crls, get-crl-prop, delete-crl

install-webapp-firewall-ruleset

Syntax

tadm install-webapp-firewall-ruleset common_options [--file-on-server] --config=config_name --vs=vs_name ruleset_file

Description

Use this command to install a web application firewall ruleset. The webapp-firewall-ruleset element configures the path to a WAF configuration file.

Options

For information about common_options, run the help command.

--file-on-server|-f

If you specify this option, the ruleset file is available on the administration server host. If you do not specify this option, the file is assumed to be available on the client machine and will be uploaded to the server.

--config|-c

Specify the name of the configuration where you want to install the web application firewall ruleset.

--vs|-s

Specify the name of the virtual server.

Operands

ruleset-file

Specify the full path of the ruleset file. This file must be placed in a ruleset subdirectory within the config directory of an instance. In addition, the server.xml must be updated to include this directory.

Example

tadm install-webapp-firewall-ruleset --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--config=www.example.org /tmp/waf-rule.conf

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-webapp-firewall-ruleset, list-webapp-firewall-rulesets

list-backups

Syntax

tadm list-backups common_options [--all] --config=config_name

Description

Use this command to list the backups of the specified configuration.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the backup date for each backup configuration.

--config|-c

Specify the configuration for which you want to list backups.

Example

tadm list-backups --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, restore-config

list-cache-rules

Syntax

tadm list-cache-rules common_options [--all] --config=config_name --vs=vs_name

Description

Use this command to view a list of caching rules defined for the specified virtual server.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the condition for each caching rule defined for the specified virtual server.

--config|-c

Specify the configuration for which you want to list cache rules.

--vs|-s

Specify the name of the virtual server.

Example

tadm list-cache-rules --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-cache-rule, delete-cache-rule

list-certs

Syntax

tadm list-certs common_options [--all] [--token=name] [--cert-type=(server|ca; default is 'server')] --config=config_name

Description

Use this command to list all certificates for a configuration. The list-certs command prompts for a token password if the token is password protected.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the issue name and expiry date for each certificate in the configuration.

--token|-t

Specify the token (cryptographic device), that contains the encrypted public key.

--cert-type|-y

Specify the value as server to list the server certificates, or ca to list the certificate authority (CA) certificates.

--config|-c

Specify the name of the configuration for which you want to list the certificates.

Example

tadm list-certs --user=admin --host=admin.example.com --port=8989
--prompt=false --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-cert-request, delete-cert, install-cert, get-cert-prop, set-cert-trust-prop, create-selfsigned-cert

list-ciphers

Syntax

tadm list-ciphers common_options [--all] --config=config_name (--http-listener=name|--tcp-listener=name)

Description

Use this command to list the SSL ciphers that Oracle Traffic Director supports.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays whether the SSL ciphers are enabled in a configuration.

--config|-c

Specify the name of the configuration for which you want to list the ciphers.

--http-listener|-r

Specify the name of the HTTP listener.

--tcp-listener|-t

Specify the name of the TCP listener.

Example

tadm list-ciphers --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --http-listener=http-listener-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, enable-ciphers, disable-ciphers

list-compression-rules

Syntax

tadm list-compression-rules common_options [--all] --config=config_name
--vs=vs_name

Description

Use this command to list compression rules defined for the specified virtual server.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the condition for each compression rule configuration.

--config|-c

Specify the configuration name for which you want to list compression rules.

--vs|-s

Specify the name of the virtual server.

Example

tadm list-compression-rules --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-compression-rule, delete-compression-rule, set-compression-rule-prop, get-compression-rule-prop

list-configs

Syntax

tadm list-configs common_options [--all]

Description

Use this command to list all existing configurations.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the deployment status for each configuration.

Example

tadm list-configs --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, deploy-config, copy-config, pull-config, set-config-file, delete-config, restore-config, get-config-file, list-config-files

list-config-files

Syntax

tadm list-config-files common_options --config=config_name

Description

Use this command to list configuration files pertaining to the specified configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for listing all the configuration files.

Example

tadm list-config-files --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, deploy-config, copy-config, pull-config, set-config-file, delete-config, restore-config, get-config-file, list-configs

list-crls

Syntax

tadm list-crls common_options [--all] --config=config_name

Description

Use this command to list the CRLs for a specified configuration.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the next update information for each CRL configuration.

--config|-c

Specify the name of the configuration for which you want to view the CRLs.

Example

tadm list-crls --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-crl, delete-crl, get-crl-prop

list-error-pages

Syntax

tadm list-error-pages common_options [--all] --config=config_name
--vs=vs_name

Description

Use this command to list the error codes for which error pages are defined.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the error page for each error code configuration.

--config|-c

Specify the name of the configuration for which you want to list the error pages.

--vs|-s

Specify the name of the virtual server.

Example

tadm list-error-pages --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-error-page, delete-error-page

list-events

Syntax

tadm list-events common_options [--all] --config=config_name

Description

Use this command to list all scheduled events for a configuration.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays enabled, day of the month, month, day of week, time, and interval for each scheduled event in a configuration.

--config|-c

Specify the name of the configuration for which you want to list the events.

Example

tadm list-events --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-event, delete-event, disable-event, enable-event

list-failover-groups

Syntax

tadm list-failover-groups common_options --config=config_name [--all]

Description

Use this command to view a list of the failover groups defined for a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to list the failover groups.

--all|-l

If you specify this option, the command displays the primary and the backup nodes of the failover groups.

Example

tadm list-failover-groups --config=soa --verbose --all

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-failover-group, delete-failover-group, set-failover-group-primary, get-failover-group-prop

list-http-listeners

Syntax

tadm list-http-listeners common_options [--all] --config=config_name

Description

Use this command to list the names of the HTTP listeners defined for the configuration, and (optionally) the IP address and port number for each listener.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the IP and port for each HTTP listener configuration.

--config|-c

Specify the name of the configuration for which you want to list the HTTP listeners.

Example

tadm list-http-listeners --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-http-listener, set-http-listener-prop, set-http-listener-prop, delete-http-listener

list-instances

Syntax

tadm list-instances common_options [--all] ( --config=name | --node=name )

Description

Use this command to list all instances.

- If you specify the configuration name, the command lists all nodes on which the configuration is deployed.

- If you specify the node, the command lists all configurations deployed on that node.

Note:
If a node is service-enabled, then list-instances will list service-name of the service corresponding to the instance of that node. Note that for service-name to appear, you must run list-instances with the --all option.

Options

For information about common_options, run the help command.

--node|-n

Specify the host name of the node for which you want to list the configurations.

--all|-l

If you specify this option, the command displays instance status and if the instance has service for each instance in the configuration.

--config|-c

Specify the name of the configuration for which you want to list the nodes.

Example

tadm list-instances --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-instance, delete-instance, start-instance, stop-instance, restart-instance, reconfig-instance, list-nodes, remove-node

list-nodes

Syntax

tadm list-nodes common_options [--all]

Description

Use this command to list all the nodes that are registered with the administration server. This command also lists the node status.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the node port, node online, and node description for each node that is registered with the administration server.

Example

tadm list-nodes --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, remove-node

list-origin-servers

Syntax

tadm list-origin-servers common_options [--all] --config=config_name --origin-server-pool=origin_server_pool_name

Description

Use this command to view a list of origin-servers defined in a pool.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays weight, enabled, and backup for each origin server defined in a pool.

--config|-c

Specify the configuration for which you want to list the origin-servers.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to view the origin servers.

Example

tadm list-origin-servers --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--origin-server-pool=test-pool

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-origin-server, delete-origin-server, get-origin-server-prop, set-origin-server-prop

list-origin-server-pools

Syntax

tadm list-origin-server-pools common_options [--all] [--type=http|https|tcp] --config=config_name

Description

Use this command to list origin-server pools defined for a configuration.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the origin-server pool type and load distribution for each origin-server pool configuration.

--type|-t

Specify the protocol for which requests are handled by the servers in the pool. If you do not specify the type, all the available origin servers are listed.

--config|-c

Specify the configuration for which you want to list origin-server pools.

Example

tadm list-origin-server-pools --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --type=tcp --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-origin-server-pool-prop, set-origin-server-pool-prop, delete-origin-server-pool, create-origin-server-pool

list-proxy-info

Syntax

tadm list-proxy-info common_options [--all] --config=config_name
--vs=vs_name --route=route_name

Description

Use this command to view information about the proxy parameters configured for a route.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays header and status for each proxy configuration.

--config|-c

Specify the name of the configuration for which you want to list the proxy parameters.

--vs|-s

Specify the name of the virtual server.

--route|-r

Specify the route name for listing the proxy parameters.

Example

tadm list-proxy-info --config=www.example.org --vs=soa.example.org --route=Route-1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, block-proxy-info, forward-proxy-info

list-request-limits

Syntax

tadm list-request-limits common_options [--all] --config=config_name
--vs=vs_name

Description

Use this command to list the request limit conditions defined for a virtual server.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the condition for each request limits configuration.

--config|-c

Specify the name of the configuration to list request limits.

--vs|-s

Specify the name of the virtual server.

Example

tadm list-request-limits --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989 --no-prompt --config=www.example.org --vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-request-limit-prop, set-request-limit-prop, delete-request-limit, create-request-limit

list-routes

Syntax

tadm list-routes common_options [--all] --config=config_name
--vs=vs_name

Description

Use this command to list the rules defined for a virtual server.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the condition for each route rule configuration.

--config|-c

Specify the name of the configuration for which you want to list routes.

--vs|-s

Specify the name of the virtual server.

Example

tadm list-routes --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989 --no-prompt --config=www.example.org
--vs=soa.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-route, delete-route, get-route-prop, set-route-prop

list-tcp-listeners

Syntax

tadm list-tcp-listeners common_options [--all] --config=config_name

Description

Use this command to list all TCP listeners.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the IP and port for each TCP listener configuration.

--config|-c

Specify the name of the configuration to list all the TCP listeners.

Example

tadm list-tcp-listeners --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-listener, delete-tcp-listener, get-tcp-listener-prop, set-tcp-listener-prop

list-tcp-proxies

Syntax

tadm list-tcp-proxies common_options [--all] --config=config_name

Description

Use this command to list all TCP proxies.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays all the TCP proxies along with information about the respective server pools.

--config|-c

Specify the name of the configuration to list all the TCP proxies.

Example

tadm list-tcp-proxies --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt --all
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-proxy, delete-tcp-proxy, get-tcp-proxy-prop, set-tcp-proxy-prop

list-tokens

Syntax

tadm list-tokens common_options [--all] --config=config_name

Description

Use this command to list all PKCS#11 tokens.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays information whether the tokens are enabled and if the token PIN is saved in the server.xml file for each PKCS#11 token.

--config|-c

Specify the name of the configuration to list all the tokens.

Example

tadm list-tokens --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-pkcs11-prop, set-pkcs11-prop, set-token-prop, set-token-pin

list-variables

Syntax

tadm list-variables common_options [-all] [--vs=vs_name]
--config=config_name

Description

Use this command to list the variables defined for the configuration or for a specific virtual server.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the description for each variable defined in the configuration.

--vs|-s

Specify the name of the virtual server.

--config|-c

Specify the name of the configuration for listing variables.

Example

tadm list-variables --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --vs=soa.example.org --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-variable, delete-variable

list-virtual-servers

Syntax

tadm list-virtual-servers common_options [--all] --config=config_name

Description

Use this command to list all virtual-servers defined for a configuration.

Options

For information about common_options, run the help command.

--all|-l

If you specify this option, the command displays the HTTP listener name for each virtual server configuration.

--config|-c

Specify the name of the configuration for which you want to view the virtual servers.

Example

tadm list-virtual-servers --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-virtual-server, set-virtual-server-prop, get-virtual-server-prop, delete-virtual-server, copy-virtual-server

list-webapp-firewall-rulesets

Syntax

tadm list-webapp-firewall-rulesets common_options --config=config_name (--vs=vs_name)

Description

Use this command to list all web application firewall rulesets defined for a configuration or for a specific virtual server.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you wish to view the list of web application firewall rulesets.

--vs|-s

Specify the name of the virtual server.

Example

tadm list-webapp-firewll-rulesets --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, install-webapp-firewall-ruleset, delete-webapp-firewall-ruleset

pull-config

Syntax

tadm pull-config common_options --config=config_name node_host

Description

Use this command to pull a configuration from any instance of the configuration and overwrite all undeployed configuration changes. You can use this command when an instance is modified manually, so that the manual modification can be reflected in the config-store directory.

Caution:
Do not edit any file under the config-store directory. The files under this directory are created by Oracle Traffic Director for internal use.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the server configuration for pulling configurations.

Operands

node-host

Specify the name of the node that hosts the manually modified instance.

Example

tadm pull-config --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--config=www.example.org serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, list-configs, delete-config, copy-config, deploy-config, restore-config, list-config-files, get-config-file, set-config-file

reconfig-instance

Syntax

tadm reconfig-instance common_options --config=config_name (node_host)*

Description

Use this command to reconfigure server instances. Configuration changes are reflected on instances without a server restart. Only dynamically reconfigurable changes in the configuration take effect.

Changes in the user, temp-path, log, thread-pool, pkcs11, stats, dns, dns-cache, ssl-session-cache, and access-log-buffer settings remain the same after a reconfiguration procedure is completed. Any such changes that require restart will be logged when a reconfiguration is done.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to reconfigure server instances.

Operands

node-host

Specify the name of the node.

Example

tadm reconfig-instance --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=www.example.org serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-instance, list-instances, start-instance, stop-instance, restart-instance, create-instance, list-nodes

remove-node

Syntax

tadm remove-node common_options [--force] --node=node_name

Description

Use this command to remove a registered node from the administration server. This node does not show up in the list of nodes, as it is no longer managed by the administration server.

Options

For information about common_options, run the help command.

--force|-f

Specify this option to remove a node. It will try to delete instances that are deployed on the node. Also, if the node is down, the force option would remove the node.

--node|-n

Specify the name of the node that you want to remove.

Example

tadm remove-node --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt
--node=node1.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-nodes

renew-admin-certs

Syntax

tadm renew-admin-certs common_options [--instance-home=instance_home]

Description

Use this command to renew the administration certificates with the nicknames Admin-CA-Cert, Admin-Server-Cert, and Admin-Client-Cert. This command also updates the nodes that are currently running and are accessible with the renewed certificates. This command can be executed using either --user or --instance-home. The --instance-home option is optional. For information about using --instance-home, see Options.

After the renew-admin-certs command has been executed, the administration server and nodes must be restarted for the new certificates to take effect.

Options

For information about common_options, run the help command.

--instance-home|-i

Indicates the location where the server instances can be found. Use this option if the SSL certificates on the administration server have already expired. Note that when this option is used, only the certificates on the administration server are renewed. To renew the certificates on the administration nodes, the renew-node-certs command must be executed on each of the administration nodes.

Example

Using the --user option:

tadm renew-admin-certs --user=admin
--password-file=./admin.passwd --port=8989

Using the --instance-home option:

tadm renew-admin-certs --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, reset-admin-password, renew-node-certs

renew-node-certs

Syntax

tadm renew-node-certs common_options --instance-home=instance_home

Description

This command must be invoked on an administration node. Use this command to renew the authentication certificates from the administration server and install them on the administration node. This is required for securely communicating with the administration server. You must use this command when the node was not running at the time of renewing the authentication certificates for the administration server. You must restart the administration node for the changes to take effect.

Options

For information about common_options, run the help command.

--instance-home|-i

Indicates the location where the server instances can be found.

Example

tadm renew-node-certs --instance-home=/documents/nodes

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, renew-admin-certs, reset-admin-password, restart-admin

reset-admin-password

Syntax

tadm reset-admin-password common_options --instance-home=instance_home

Description

Use this command to reset the administrator server password. This command should be used locally where the administrator server is installed. This command does not prompt for the old password. This command requires the administration server to be restarted for the changes to take effect.

Note:
This command can be executed only when the authentication database is a keyfile, which is the default setting.

Options

For information about common_options, run the help command.

--instance-home|-i

Indicates the location where the server instances can be found.

Example

tadm reset-admin-password --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, renew-admin-certs

restart-admin

Syntax

tadm restart-admin common_options node_host

Description

Use this command to restart the administration server or node.

Note:
To restart an instance, use the restart-instance command.

Options

For information about common_options, run the help command.

Operands

node-host

Specify the host name of the administration server or node.

Example

tadm restart-admin --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-nodes

restart-instance

Syntax

tadm restart-instance common_options --config=config_name (node_host)*

Description

Use this command to restart one or more instances of a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to restart instances.

Operands

node-host

Specify the host name of the node (or nodes) on which the instance that you want to restart is running. When specifying multiple nodes, separate the host names by spaces. If no nodes are specified, all instances running on the specified configuration are restarted. If the instance on any node is not running, this command will display an error.

Example

tadm restart-instance --user=admin
--password-file=./admin.passwd --host=admin.example.com
--port=8989 --no-prompt --config=www.example.org serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-instance, delete-instance, list-instances, start-instance, stop-instance, list-nodes

restore-config

Syntax

tadm restore-config common_options --from-backup=backup_id config_name

Description

Use this command to restore a configuration to a specific earlier state by using a backup.

Options

For information about common_options, run the help command.

--from-backup|-b

Specify the ID of the backup configuration. You can view a list of the available backups by running the list-configs command.

Operand

config-name

Specify the configuration that you want to restore to an earlier state.

Example

tadm restore-config --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --from-backup=20110813_084722 www.example.org

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, deploy-config, copy-config, pull-config, set-config-file, delete-config, list-configs, get-config-file, list-config-files

rotate-log

Syntax

tadm rotate-log common_options --config=config_name (node_host)*

Description

Use this command to rotate the log files. The server saves the old log files and marks the saved files with a name that includes the date and time when they were saved.

Note:
You can set up the log files to be automatically archived. At a certain time, or after a specified interval, the server rotates the logs. Use create-event command to generate new log files for the events that are created.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to rotate logs.

Operands

node-host

Specify the host names of one or more nodes for which you want to rotate the log files.

Example

tadm rotate-log --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt --config=www.example.org
serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, list-nodes

set-access-log-buffer-prop

Syntax

tadm set-access-log-buffer-prop common_options --config=config_name  (property_name=property_value)+

Description

Use this command to set the properties of the access-log buffer.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to set the properties of the access-log buffer.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following set-access-log buffer properties:

enabled: Specifies whether the server should buffer the access log entries.
Values: true, false. Default: true

buffer-size: The size (in bytes) of individual access log buffers.
Values: 4096 to 1048576.

direct-io: Indicates whether the file system should cache access-log writes. The default value, false, indicates that the file system should cache access log writes. Setting the value to true indicates that the file system should not cache access log writes. The setting is purely advisory; either the server or the operating system may choose to ignore it.
Values: true, false. Default: false

max-buffers: Specifies the maximum number of access log buffers per server.
Values: 1 to 65536.

max-buffers-per-file: Specifies the maximum number of access log buffers per access-log file.
Values: 1 to 128.

Note:
The property max-buffers-per-file can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

max-age: The maximum time (in seconds) to buffer a given access-log entry.
Values: 0.001 to 3600.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-access-log-buffer-prop --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=www.example.org max-age=1000

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-access-log-buffer-prop, enable-access-log, disable-access-log, get-access-log, get-log, get-log-prop, set-log-prop, rotate-log

set-admin-prop

Syntax

tadm set-admin-prop common_options [--set-password] [--node=node_name] (property_name=property_value)+

Description

Use this command to set the properties of the administration server or a node.

Options

For information about common_options, run the help command.

--set-password|-r

Specify this option to change the administration server password.

--node|-n

Specify the name of the node. To change properties of an administration node, specify the node. To change properties of the administration server, it not mandatory to specify the node.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following administration properties:

java-home: Specifies the home directory where the Oracle Traffic Director application is installed.
Values: Must be a text string. Default: ORACLE_HOME/jdk directory.

admin-user: Specifies the administration server user which will be used to log into the administration server
Values: Must be a text string.

server-user: Specifies the Unix user ID with which administration server/node is running.
Values: Must be a text string.

Note:
If a node is service-enabled, the server-user property of the node cannot be changed to a non-root user.

ssl-port: Specifies the SSL port for the administration server/node.
Values: 1 to 65535. Default: 8989.

log-file: Specifies the name and location of the log file.
Values: User defined name and location. Default: ../log/errors.

log-level: Specifies the log verbosity for the server as a whole.
Values: INCIDENT_ERROR:1, ERROR:1, ERROR:16, ERROR:32, WARNING:1, TRACE:1, TRACE:16, TRACE:32. Default: NOTIFICATION:1.

server-log-file: Specifies the name and location of the server log file.
Values: User defined name and location. Default: ../logs/server.log

access-log-file: Specifies the name and location of the access log file.
Values: User defined name and location. Default: ../logs/access.log

description: Specifies the description of the administration server.
Values: Must be a text string.

bind-ip: Specifies the IP address of the administration server's default listener.
Values: Must be a text string.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-admin-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt "--node=node1.example.com
access-log-file=../logs/www_example_com_access.log

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-admin-prop, restart-admin, stop-admin, list-nodes

set-cache-prop

Syntax

tadm set-cache-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to define or change caching properties for a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the cache properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following cache properties:

enabled: Specifies whether the server should change caching properties.
Values: true, false. Default: true.

max-entries: Specifies the maximum number of objects for which the content should be cached.
Values: 1 to 1073741824. Default: 1024.

replacement: Specifies the algorithm for cache replacement.
Values: lru, lfu, and false. Default: lru.

max-heap-object-size: Specifies the maximum size of objects that should be cached. Objects larger than the specified size are not cached.
Values: 0 to 214783647. Default: 512 KB.

max-heap-space: Specifies the maximum number (in bytes) of heap that is used for caching response objects. Values: 0 to 1099511627776. Default: 10 MB.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-cache-prop --user=admin --host=admin.example.com --password-file=./admin.pwd --port=8989
--prompt=false --config=www.example.org max-heap-object-size=1237 max-entries=1293

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-cache-prop

set-cache-rule-prop

Syntax

tadm set-cache-rule-prop common_options --config=config_name --vs=vs_name --cache-rule=cache_rule_name (property_name=property_value)+

Description

Use this command to set up the cache rule properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to set cache rule properties.

--vs|-s

Specify the virtual server.

--cache-rule|-r

Specify the cache rule name.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following cache rule properties:

enabled: Specifies whether the caching rule is enabled.
Values: true, false. Default: false.

max-reload-interval: Specifies the maximum time (in seconds) allowed between consecutive up-to-date checks.
Values: Positive integer. Default: 3600.

min-reload-interval: Specifies the minimum time (in seconds) allowed between consecutive up-to-date checks of a cached document.
Values: Positive integer. Default: 0.

last-modified-factor: Represents the factor used in estimating the expiry time, which defines how long a document will be up-to-date based on time it was last modified. This property is used only when the explicit age of the document is not available
Values: Floating. Positive floating value from 0 to any large value.

min-object-size: Specifies the minimum size (in bytes) of any document to be cached.
Values: Positive integer. Must be less than max-object-size.

max-object-size: The maximum size, in bytes, of any document to be cached. This setting enables users to limit the maximum size of cached documents, so that no single document can take too much space. This value cannot exceed the value of max-heap-object-size.
Values: Positive integer.

query-maxlen: Specifies the number of characters in the query string. If this property is set to 0, URIs with query strings are not cached.
Values: Positive integer. Default: 0

compression: If this property value is set to true, the document is compressed before storing in the cache.
Values: true, false. Default: false.

cache-https-response: If this property value is set to true, responses from the HTTPS servers are also cached.
Values: true, false. Default: false.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-cache-rule-prop --config=www.example.org
--vs=soa.example.org --cache-rule=cache-rule-1 max-reload-interval=2 min-object-size=150

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, set-cache-prop, get-cache-rule-prop

set-cert-trust-prop

Syntax

tadm set-cert-trust-prop common_options [--token=name]
--config=config_name --nickname=nick_name (property_name=property_value)+

Description

Use this command to set the certificate trust properties. A certificate is issued and digitally signed by a certificate authority (CA). You decide which CAs you trust enough to serve as verifiers of other users' identity. The set-cert-trust-prop command prompts for a token password if the token is password protected.

Options

For information about common_options, run the help command.

--token|-t

Specify the token (cryptographic device), which contains the encrypted public key.

--config|-c

Specify the name of the configuration to set certificate trust properties.

--nickname|-n

Specify the short name (nickname) of the certificate for which you want to set trust properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following certificate trust properties:

Nickname: Specify the nickname for the certificate trust.
Value: Must be a text string.

Subject: Specify the subject for the certificate trust.
Value: Must be a text string.

Issuer: Specify the issuer information for the certificate trust.
Value: Must be a text string.

Valid From: Specify the certificate validity start date.
Value: Must be a text string.

Valid Till: Specify the certificate validity end date.
Value: Must be a text string.

Fingerprint: Specify the fingerprint information for the certificate trust.
Value: Must be a text string.

Serial Number: Specify the serial number information for the certificate trust.
Value: Must be a text string.

Trusted to sign Client Certificates: Specify whether the CA is trusted to sign client certificates.
Values: true, false. Default: true

Trusted to sign Server Certificates: Specify whether the CA is trusted to sign server certificates.
Values: true, false. Default: true

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-cert-trust-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--prompt=false --config=www.example.org Trusted to sign client certificates=true

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-cert-prop, create-cert-request, list-certs, install-cert, delete-cert, create-selfsigned-cert

set-compression-rule-prop

Syntax

set-compression-rule-prop common_options --config=config_name --vs=vs_name --rule=compression_rule_name (property_name=property_value)+

Description

Use this command to set or change properties of a compression rule for a virtual server.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration name for which you want to set compression rule properties.

--vs|-s

Specify the name of the virtual server.

--rule|-r

Specify the compression rule name.

Operand

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following compression rule properties:

insert-vary-header: Select to insert a vary:Accept-encoding header.
Values: true, false. Default: true.

compression-level: Specifies the compression level for the virtual server.
Values: 1 to 9. Specifying 1 yields better speed and specifying 9 yields best compression.

Note:
The property compression-level can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

fragment-size: Specifies the memory fragment size (in bytes) that is used by the compression library to control the compression rate.
Values: Any integer.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-compression-rule-prop --config=www.example.org
--vs=soa.example.org --rule=Compression34 compression-level=9

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-compression-rule, delete-compression-rule, list-compression-rules, get-compression-rule-prop

set-config-file

Syntax

tadm set-config-file common_options --config=config_name --upload-file=local_file_to_upload file_name

Description

Use this command to change one of the files of a configuration or to add a file to the configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to add or replace a configuration file.

--upload-file|-o

Specify the name of the local file to be uploaded to the configuration directory.

Operands

file-name

Specify the name of the configuration file.

Example

tadm set-config-file --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989 --no-prompt --config=www.example.org --upload-file=obj.conf obj.conf

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-config, list-configs, delete-config, copy-config, pull-config, restore-config, list-config-files, get-config-file, deploy-config

set-config-prop

Syntax

set-config-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the configuration file properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to change properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following configuration file properties:

user: Specifies the user ID with which the server runs.
Values: User ID

temp-path: Specifies the location where the server stores its temporary files.
Values: Any valid directory.

max-fd: Specifies a configurable upper limit on the file descriptor usage of the Oracle Traffic Director server process. This means that Oracle Traffic Director does not assume more than configured max-fd number of available file descriptors even if the actual file descriptor availability is higher.
Values: 64 to 2147483647 or -1 for no limit. Default: 2097152.

webapp-firewall-ruleset: Specifies the location where the Web Application Firewall (WAF) ruleset files are stored.
Values: Any valid directory where the WAF ruleset files are stored.

Note:
The property webapp-firewall-ruleset enables you to specify multiple values, with each value enclosed in quotes and separated by commas. For example: webapp-firewall-ruleset="ruleset/vschola/*.conf","/scratch/sababu/waf rules/rule2.conf"

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-config-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org user=otd_user

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-config-prop

set-dns-cache-prop

Syntax

tadm set-dns-cache-prop common_options --config=config_name (property_name=property_alue)+

Description

Use this command to set the Domain Name Server (DNS) cache properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the DNS cache properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following DNS cache properties:

enabled: Specifies whether the server should set DNS cache properties.
Values: true, false. Default: true.

max-age: Specifies the duration (in seconds) for which the entries must be kept in the cache.
Values: 1 to 31536000.

max-entries: Specifies the maximum number of DNS lookup results to write to the cache.
Values: 32 to 32768.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-dns-cache-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org max-age=3848
max-entries=45

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-dns-cache-prop

set-dns-prop

Syntax

tadm set-dns-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the Domain Name Server (DNS) lookup properties for a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the DNS properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following DNS properties:

enabled: Specifies whether the server should perform DNS lookups.
Values: true, false. Default: false.

async: Specifies whether the server uses its own asynchronous DNS resolver, instead of the Operating System's synchronous resolver.
Values: true, false. Default: true.

timeout: Specifies the duration (in seconds) after which the asynchronous DNS lookups should time out.
Values: 0.001 to 3600.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-dns-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org timeout=34

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-dns-prop, set-dns-cache-prop, get-dns-cache-prop

set-failover-group-primary

Syntax

tadm set-failover-group-primary common_options --config=config_name --virtual-ip=ip --primary-node=node

Description

Use this command to toggle the primary and backup nodes in a failover group. If the administration node process is running as non-root on the node where the instances are located, then you must run start-failover on those nodes as a root user. This is to manually toggle the nodes. If this command is not executed, the nodes will not be toggled. And, when you execute get-failover-group-prop , the result will show the configured primary and the backup nodes, which will not be the same as the runtime primary and backup nodes.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to toggle the primary and backup nodes of a failover group.

--virtual-ip|-i

Specify the virtual IP address of the failover group for which you want to toggle the primary and backup nodes.

--primary-node|-n

Specify the primary node for the failover group. This is the existing backup node of the failover group.

Example

tadm set-failover-group-primary --config=soa --virtual-ip=10.228.12.250 --primary-node=app2.example.com

tadm start-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=soa --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-failover-group, create-failover-group, list-failover-groups, get-failover-group-prop, start-failover, stop-failover

set-health-check-prop

Syntax

tadm set-health-check-prop common_options --config=config_name --origin-server-pool=origin_server_pool_name (property_name=property_value)+

Description

Use this command to set the health-check properties for an origin server pool.

Health check monitors include the built-in health check monitors, including HTTP/HTTPS and TCP Connect Health Check, as well as a generic health check hookup mechanism, so that customers can write their own programs/scripts to monitor the health of specific origin servers. This mechanism is especially useful when you want to have a protocol-level health check monitor for the origin servers, which provide different services.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to set the health-check properties.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to set the health-check properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following health-check properties:

protocol: Specifies the protocol for the health check requests. If COMMAND is configured, Oracle Traffic Director invokes the executable specified in command for the health check.
Values: HTTP, TCP, or COMMAND.

interval: Specifies the time interval (seconds) between two health check pings.
Values: Takes a positive integer. Default: 30.

timeout: Specifies the timeout value (seconds) for a ping connection or a request.
Values: Takes a positive integer. Default: 5.

command: The full path of the external health check executable. This parameter must be configured if the protocol is COMMAND.

Note:
In case of HTTP type of origin server pool, the COMMAND health check protocol will not be considered if:

- the origin server type is UNDETECTED or,

- the origin server type is WLS and dynamic discovery is set.

failover-threshold: Specifies the number of consecutive failures for all requests sent to an origin server, after which the origin server should be marked as unavailable.
Values: Takes a positive integer. Maximum allowable value is 256. Default: 3.

request-method: Specifies the method that should be used for HTTP ping requests.
Values: GET or OPTIONS. Default: OPTIONS.

request-uri: Specifies the URI that should be used for HTTP health-check requests.
Values: URI String. Default: "/".

response-code-match: The response status codes that indicate a healthy origin server.
Values: A pipe-separated list of status codes. The status codes can be represented as modified regular expressions containing 3-character patterns. The first character can be either "x" or a number from 1 to 4. The second and third characters can be either "x" or a number from 0 to 9. For example, 200, 2xx|304, 1xx|2xx|3xx|4xx. This is applicable only when protocol is HTTP. For example, any 200 plus response code from the origin servers will be matched against 2xx (200=OK, 201=Created, 202=Accepted, 203=Non-Authoritative Information, 204=No Content, 205=Reset Content, and 206=Partial Content).

response-body-match: A regular expression that is used to match the HTTP response body to determine the origin server's health. This is applicable only when protocol is HTTP.
Values: Regular expression.

response-body-match-size: Specifies the maximum length of the response body that should match.
Values: Takes a positive integer. Default: 2048.

dynamic-server-discovery: Specifies if the server should dynamically discover Oracle WebLogic Server cluster nodes and add them to the pool.
Values: true, false. Default: false.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-health-check-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989 --no-prompt --config=www.example.org --origin-server-pool=test-pool
failover-threshold=150 timeout=4

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-health-check-prop

set-http-listener-prop

Syntax

tadm set-http-listener-prop common_options --config=config_name --http-listener=name (property_name=property_alue)+

Description

Use this command to set the HTTP listener properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the HTTP listener properties.

--http-listener|-r

Specify the name of the HTTP listener.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following HTTP listener properties:

enabled: Specifies whether the HTTP listener is enabled.
Values: true, false. Default: true.

ip: Specifies an IP address to listen.
Values: A valid IP address or an asterisk (*) to listen on all IP addresses.

port: Specifies the port to listen.
Values: A valid port number.

acceptor-threads: Specifies the number of threads dedicated for accepting connections received by this listener.
Values: 1 to 128.

Note:
The property acceptor-threads can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

server-name: Specifies the default server name. Tells the server what to put in the host name section of any URLs it sends to the client. This affects URLs the server automatically generates; it doesn't affect the URLs for directories and files stored in the server. This name should be the alias name if your server uses an alias. If a colon and port number are appended, that port will be used in URLs that the server sends to the client.
Values: The value can include a scheme (for example, prefix http://) and port suffix (for example, :80).

blocking-io: Indicates whether the server uses the blocking I/O. If you specify this option, the HTTP listener socket is in the blocking mode.
Values: true, false. Default: false.

handle-protocol-mismatch: Indicates whether the server responds to SSL or non-SSL protocol mismatches in client requests. The default value is true, meaning the server will attempt to detect SSL or non-SSL protocol mismatches and send an HTTP redirect or SSL alert when a mismatch is detected.
Values: true, false. Default: true.

family: Specifies the socket family that is used to connect to the origin-server.
Values: inet, inet6, and inet-sdp. The values inet and inet6 represent IPV4 and IPV6 protocols respectively. The inet-sdp value is used for Sockets Direct Protocol (SDP). Default: inet.

Note:
The property family can accept default as a value. Default implies that the server will compute the value of this property at runtime.

listen-queue-size: Specifies the size (in bytes) of the listen queue.
Values: 1 to 1048576.

receive-buffer-size: Specifies the size (in bytes) of the operating system socket receive buffer.
Values: 0 to 2147483647.

send-buffer-size: Specifies the size (in bytes) of the operating system socket send buffer.
Values: 0 to 2147483647.

default-virtual-server-name: Specifies the name of the virtual server that processes request that do not match a host.
Values: Takes a name value from the virtual server element.

description: Specifies the description of the HTTP listener.
Values: A text string.

max-requests-per-connection: Maximum number of keep-alive requests that will be handled per HTTP connection after which the keep-alive connection is closed. 0 indicates no limit.

Values: any positive integer. Default: 0.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-http-listener-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --http-listener=http_listen1
IP=192.19.1.10 port=1895

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-http-listener, get-http-listener-prop, list-http-listeners, delete-http-listener

set-http-prop

Syntax

tadm set-http-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the HTTP properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the HTTP properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following HTTP properties:

version: Specifies the highest HTTP protocol version the server supports.
Values: The default HTTP version string is HTTP/1.1

server-header: Specifies the server header information such as server software and version.

etag: Indicates if the server includes an Etag header field in its responses.
Values: true, false. Default: true.

request-header-buffer-size: Specifies the size (in bytes) of the buffer used to read HTTP request headers.
Values: 0 to 2147483647

strict-request-headers: Indicates whether the server rejects certain malformed HTTP request headers.
Values: true, false. Default: false.

case-sensitive-headers: Indicates whether the server should preserve the case of the HTTP request/response headers.
Values: true, false. Default: false.

max-request-headers: Specifies the maximum number of header fields in an HTTP request header.
Values: 1 to 512

output-buffer-size: Specifies the size (in bytes) of the buffer for HTTP responses.
Values: 0 to 2147483647

max-unchunk-size: Specifies the maximum size (in bytes) of a chunked HTTP request body that the server will unchunk.
Values: 0 to 2147483647

unchunk-timeout: Specifies the maximum time (in seconds) that the server waits for a chunked HTTP request body to arrive.
Values: 0 to 3600, or -1 for no timeout. Default: 60

io-timeout: Specifies the maximum time (in seconds) that the server waits for an individual packet.
Values: 0 to 3600, or -1 for no timeout.

request-body-timeout: Specifies the maximum time (in seconds) that the server waits for a complete HTTP request body.
Values: 0 to 604800, or -1 for no timeout.

request-header-timeout: Specifies the maximum time (in seconds) that the server waits for a complete HTTP request header.
Values: 0 to 604800, or -1 for no timeout. Default: 30.

ecid: Specifies whether the server generates, propagates, and logs the execution context. The value of the ECID is a unique identifier that can be used to correlate individual events as being part of the same request execution flow.

For example, events that are identified as being related to a particular request typically have the same ECID value. However, the format of the ECID string itself is determined by an internal mechanism that is subject to change; therefore, you should not have or place any dependencies on that format.
Values: true, false. Default: true

websocket-strict-upgrade: Enables/disables strict adherence to RFC 6455 during a websocket upgrade request. When websocket-strict-upgrade is true, additional rules are checked, as prescribed by the RFC 6455, to ensure that only clients that adhere strictly to RFC 6455 are allowed.
Values: true, false. Default: false.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-http-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
server-header=OTD-server-header request-header-buffer-size=278

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-http-prop

set-keep-alive-prop

Syntax

tadm set-keep-alive-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set keep-alive subsystem properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set keep-alive properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following keep-alive properties:

enabled: Specifies whether the keep-alive subsystem is enabled.
Values: true, false. Default: true.

threads: Specifies the number of keep-alive subsystem threads.
Values: 1 to 128. Default: 1.

Note:
The property threads can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

max-connections: Specifies the maximum number of concurrent keep-alive connections that the server supports.
Values: 1 to 1048576. Default: 200.

Note:
The property max-connections can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

timeout: Specifies the timeout (in seconds) after which an inactive keep-alive connection can be used.
Values: 0.001 to 3600. Default: 30 seconds.

poll-interval: Specifies the interval (in seconds) between polls.
Values: 0.001 to 1. Default: .001 seconds.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-keep-alive-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org poll-interval=1 timeout=25

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-keep-alive-prop

set-localization-prop

Syntax

tadm set-localization-prop common_options [--vs=vs_name] --config=config_name (property_name=property_value)+

Description

Use this command to set the localization properties.

Options

For information about common_options, run the help command.

--vs|-s

Specify the name of the virtual server.

--config|-c

Specify the name of the configuration to set the localization properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following localization properties:

default-language: The default language with which the messages and content are displayed.
Values: User specified language codes. Default: en.

negotiate-client-language: Specifies whether the server uses the accept-language HTTP header to negotiate the content language with clients.
Values: true, false. Default: false.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-localization-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989 --no-prompt --config=www.example.org negotiate-client-language=false

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-localization-prop

set-log-prop

Syntax

tadm set-log-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the log properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the log properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following log properties:

log-stdout: Specifies whether the server logs data that applications write to stdout.
Values: true, false. Default: true.

log-stderr: Specifies whether the server logs data that applications write to stderr.
Values: true, false. Default: true.

log-virtual-server-name: Specifies whether the server includes the virtual server name in log messages.
Values: true, false. Default: true.

log-to-console: Specifies whether the server writes log messages to the console.
Values: true, false. Default: true.

log-to-syslog: Specifies whether the server writes log messages to syslog.
Values: true, false. Default: false.

date-format: Specifies the date format for the log message time stamps.
Values: Default value: %d/%b/%Y:%H:%M:%S

archive-suffix: Specifies the suffix appended to the log file names.
Values: Default value: %Y%m%d%H%M

archive-command: This is executed after the server rotates a log file.
Values: A program command line, for example: gzip

log-level: Specifies the log verbosity for the server as a whole.
Values: INCIDENT_ERROR:1, ERROR:1, ERROR:16, ERROR:32, WARNING:1, TRACE:1, TRACE:16, TRACE:32. Default: NOTIFICATION:1.

log-file: Specifies the name and location of the log file.
Values: User defined name and location. Default: ../logs/server.log

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-log-prop --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt --config=www.example.org log-level=error:1

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-log-prop, get-log

set-origin-server-pool-prop

Syntax

tadm set-origin-server-pool-prop common_options --config=config_name --origin-server-pool=origin_server_pool_name (property_name=property_value)+

Description

Use this command to set the origin-server pool properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to set the origin-server pool properties.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to set the properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following origin-server pool properties:

family: Specifies the socket family that is used to connect to the origin-server.
Values: inet, inet6, and inet-sdp. The values inet and inet6 represent IPV4 and IPV6 protocols respectively. The inet-sdp value is used for Sockets Direct Protocol (SDP). Default: inet.

load-distribution: The load-balancing method that should be used for distributing requests to the origin-server pool.
Values: least-connection-count, least response time, round-robin, and ip-hash. Default: least-connection-count.

proxy-server: Specifies an HTTP forward proxy server of the format host:port that you can associate with an origin server pool, so that all member origin servers of the pool are communicated with through the configured HTTP forward proxy server. Values: String. Default: 80.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-origin-server-pool-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--origin-server-pool=test-pool proxy-server=proxy.example.com:8081 family=inet
load-distribution=round-robin

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-origin-server-pool-prop, list-origin-server-pools, delete-origin-server-pool, create-origin-server-pool

set-origin-server-prop

Syntax

tadm set-origin-server-prop common_options --config=config_name --origin-server-pool=origin_server_pool_name --origin-server=host:port (property_name=property_value)+

Description

Use this command to set the properties of an origin-server.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to set origin-server properties.

--origin-server-pool|-o

Specify the name of the origin-server pool for which you want to set the origin-server properties.

--origin-server|-O

Specify an origin server in the format host:port

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following origin server properties:

enabled: Specifies whether the requests can be routed to this origin server.
Values: true, false. Default: true.

host: Specifies the host name or the IP address of the origin server.
Values: String.

port: Specifies the port number of the origin server.
Values: Integer. 80 is the default port if the origin server pool type is HTTP. 443 is the default port if the origin server pool type is HTTPS.

weight: Specifies the load distribution weight for the origin server.
Values: 0 to 1000. Default: 1.

backup: Specifies whether the origin sever is a backup server. Requests will be sent to the backup origin server only when none of the primary (non-backup) origin servers is available.
Values: true, false. Default: false.

max-connections: Specifies the maximum number of concurrent connections to the server.
Values: 0 or a positive integer. Maximum allowable value is 20480. Default: 0.

ramp-up-time: The time (in seconds) that Oracle Traffic Director should take to ramp up the request sending rate to the full capacity of this origin server.
Values: Positive integer. If max-connections is set to 0, ramp-up-time is ignored.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-origin-server-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --origin-server-pool=test-pool --origin-server=www.email.com:8080 weight=998 max-connections=234

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-origin-server-prop, list-origin-servers, delete-origin-server, create-origin-server

set-pkcs11-prop

Syntax

tadm set-pkcs11-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the PKCS#11 properties. Oracle Traffic Director introduces an option to instruct Network Security Services (NSS) to bypass the PKCS#11 layer during parts of the SSL/TLS processing. Bypassing the PKCS#11 layer improves performance.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the PKCS#11 properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following PKCS#11 properties:

enabled: Specifies whether the server initializes PKCS#11 tokens, prompting for personal identification numbers (PINs) as necessary.
Values: Default is true if SSL is enabled and false if SSL is disabled.

crl-path: Specifies the directory that contains dynamically updated CRL files.
Values: Name of the directory. If a relative path is used, it is relative to the server's config directory.

allow-bypass: If enabled, the PKCS#11 layer is bypassed during parts of the SSL/TLS processing. Bypassing the PKCS#11 layer enhances performance.
Values: true, false. Default: true.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-pkcs11-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org enabled=false

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-pkcs11-prop, list-tokens, set-token-prop, set-token-pin

set-qos-limits-prop

Syntax

tadm set-qos-limits-prop common_options --config=config_name --vs=vs_name (property_name=property_value)+

Description

Use this command to set the quality of service (QoS) limit properties for a virtual server. Quality of Service refers to the performance limits that you set for a server instance or virtual server. You can limit two areas: the amount of bandwidth and the number of connections.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the QoS limits properties.

--vs|-s

Specify the name of the virtual server.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following qos limits properties:

enabled: Specifies whether the qos limits is enforced during the runtime.
Values: true, false. Default: true.

max-bps: Specifies the maximum transfer rate (bytes/second).
Values: 1 to 2147483647. No default value.

max-connections: Specifies the maximum number of concurrent connections.
Values: 1 to 1048576

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-qos-limits-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--vs=soa.example.org max-bps=3373 max-connections=44838

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-qos-limits-prop, get-qos-prop, set-qos-prop

set-qos-prop

Syntax

tadm set-qos-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the quality of service (QoS) settings for a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set QoS properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following qos properties:

enabled: Specifies whether the QoS settings are enabled.
Values: true, false. Default: true.

interval: Specifies the interval (in seconds), over which QoS information is averaged.
Values: 0.001 to 3600.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-qos-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org interval=0.005

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-qos-prop, get-qos-limits-prop, set-qos-limits-prop

set-request-limit-prop

Syntax

tadm set-request-limit-prop common_options --config=config_name
--vs=vs_name --request-limit=request_limit_name (property_name=property_value)+

Description

Use this command to set the request limit properties for a virtual-server.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the request-limit properties.

--vs|-s

Specify the name of the virtual server.

--request-limit|-l

Specify the name for request limit properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following request-limit properties:

max-rps: Specifies the maximum number of requests that the virtual server can receive per second.
Values: 0 to 999999999.

max-connections: Specifies the maximum number of concurrent matching connections.
Values: 0 to 999999999.

continue-condition: Determines the condition for a blocked request type to become available again.
Values: silence and threshold. Default: threshold.

error-code: Specifies the HTTP status code to return for blocked requests.
Values: Default value: 503

monitor-attribute: Specifies a request attribute to monitor.
Values: Any valid string. For example, jpeg: $ip.

rps-compute-interval: Specifies the time interval (in seconds) in which the average RPS (request per second) is computed.
Values: Default value: 30

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-request-limit-prop --user=admin --host=admin.example.com --password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org
--request-limit=rule-request-limit-1 max-rps=2999 max-connections=333999

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-request-limit-prop, list-request-limits, delete-request-limit, create-request-limit

set-route-prop

Syntax

tadm set-route-prop common_options --config=config-name --vs=vs_name --route=route_name (property_name=property_value)+

Description

Use this command to set the route properties for a virtual server.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the route properties.

--vs|-s

Specify the name of the virtual server.

--route|-r

Specify the name for route properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following route properties:

server: Specifies the server name.
Values: Must be a text string.

sticky-cookie: Specify the name of the cookie that causes subsequent requests to stick to a particular origin server.
Values: Must be a text string.

sticky-uri-param: Specify the name of a URI parameter to inspect for route information. When the URI parameter is present in a request URI and its value contains a colon (:), followed by a route ID, the request will 'stick' to the origin server identified by that route ID.
Values: Must be a text string.

route-header: Specify the name of the HTTP request header that is used to communicate route IDs to the origin servers.
Values: Must be a text string.

route-cookie: Specify the name of the cookie generated by the server when it encounters a sticky-cookie cookie in a response. The route-cookie parameter stores the route ID that enables the server to direct subsequent requests back to the same origin server.
Values: Must be a text string.

rewrite-headers: Specify a list of HTTP request headers separated by commas.
Values: Must be a text string.

Note:
The property rewrite-headers enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

validate-server-cert: Specify whether the server validates the certificate presented by the origin servers.
Values: true, false. Default: true.

use-keep-alive: Specifies whether the HTTP client can use existing persistent connections for all types of requests.
Values: true, false. Default: true.

keep-alive-timeout: Specifies the maximum number (in seconds) to retain persistent connectivity.
Values: Integer. Default: 29

timeout: Specifies the maximum number (in seconds) that a connection can be in a idle state.
Values: Integer. Default: 300

always-use-keep-alive: Specifies whether the HTTP client can reuse existing connections for all types of requests. Values: true, false, auto-tuned. Default: auto-tuned. Note that the value of auto-tuned implies that the server will compute the value of this property at runtime.

protocol: Specifies the HTTP protocol version string.
Values: Must be in a text string.

proxy-agent: Specify whether the proxy server product name and version has to be forwarded to the origin servers.
Values: true, false. Default: true.

origin-server-pool: Specify the pool of origin servers of the type HTTP for this route.
Values: HTTP.

websocket-upgrade-enabled: Specify whether standard HTTP(S) connections should be upgraded to bi-directional, full-duplex WebSocket connections.
Values: true, false. Default: true.

websocket-idle-timeout: The maximum number of seconds a connection can be idle.
Values: Integer (If no value is specified, then the timeout from the TCP connection thread pool (300 seconds) is used).

from: Specify the URI prefix to map. The prefix must not contain trailing slashes.

to: Specify the URL prefix to which the request should be mapped. The prefix must not contain trailing slashes.

buffer-size: Specifies the size (in bytes) of the buffer that is used by Oracle Traffic Director to store data before it is sent to the client. Higher the value of this buffer size, the lower the number of write system calls.
Default: 16384

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-route-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org
--vs=soa.example.org --route=route-1 keep-alive-timeout=29 from=/ to=/docs

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-route-prop, list-proxy-info, forward-proxy-info, block-proxy-info, list-routes, delete-route, create-route

set-snmp-prop

Syntax

tadm set-snmp-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to enable and define settings for the SNMP subagents.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the SNMP properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following SNMP properties:

enabled: Specifies whether the SNMP agent is enabled. If enabled, the SNMP subagent gathers information about the server and passes the information to the master agent.
Values: true, false. Default: true.

description: Specifies the description of the server.
Values: Must be in a text string.

organization: Specifies the name of the organization responsible for the server.
Values: Must be in a text string.

location: Specifies the location of the server.
Values: Must be in a text string.

contact: Specifies the contact information of the person responsible for the server.
Values: Must be in a text string.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-snmp-prop --config=www.example.org description=This is snmp test

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-snmp-prop, start-snmp-subagent, stop-snmp-subagent

set-ssl-prop

Syntax

tadm set-ssl-prop common_options --config=config_name (--http-listener=name|--tcp-listener=name) (property_name=property_value)+

Description

Use this command to set the SSL properties for a listener. SSL is a software library establishing a secure connection between the client and server. SSL is used to implement HTTPS, the secure version of HTTP.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set SSL properties.

--http-listener|-r

Specify the name of the HTTP listener.

--tcp-listener|-t

Specify the name of the TCP listener.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following HTTP properties:

enabled: Specifies whether SSL support is enabled for the listener.
Values: true, false. Default: true.

strict-sni-vs-host-match: Specifies that if the value is false, the default certificate is sent to clients which do not support SNI (Server Name Indication) extension.
Values: true, false. Default: false.

tls-session-tickets-enabled: Specifies whether TLS session Ticket Extension feature is enabled.
Values: true, false. Default: true.

server-cert-nickname: Specifies the nickname of the certificate that the server presents to the clients.
Values: zero or one for RSA and zero or one for ECC.

Note:
The property server-cert-nickname enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

ssl3: Specifies whether SSL3 connections are accepted.
Values: true, false. Default: true.

tls: Specifies whether TLS connections are accepted.
Values: true, false. Default: true.

client-auth: Specifies the method of client certificate authentication.
Values: required, optional, or false. When you choose required option, the server requests the client for a certificate; if the client does not provide a certificate, the connection is closed. When you choose optional option, the server requests the client for a certificate, but does not require it. The connection is established even if the client does not provide a certificate. Default: false. The client authentication is disabled by default.

client-auth-timeout: Indicates the duration (in seconds) after which a client authentication handshake fails.
Values: 0.001 to 3600.

max-client-auth-data: Specifies the number of characters of authentication data that the server can buffer.
Values: 0 to 2147483647.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-ssl-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org --http-listener=config1_ls max-client-auth-data=18976 client-auth-timeout=200

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-ssl-prop

set-ssl-session-cache-prop

Syntax

tadm set-ssl-session-cache-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the SSL session cache properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the SSL session cache properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following SSL session cache properties:

enabled: Specifies whether the server writes SSL/TLS sessions to the cache.
Values: true, false. Default: true.

max-entries: Specifies the maximum number of SSL/TLS sessions that are written to the cache by the server.
Values: 1 to 524288.

max-ssl3-tls-session-age: Specifies the maximum amount of time (in seconds) a SSL/TLS session is written to the cache.
Values: 5 to 86400.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-ssl-session-cache-prop --user=admin
--password-file=./admin.passwd --host=admin.example.com
--port=8989 --no-prompt --config=www.example.org max-entries=12876 max-ssl3-tls-session-age=789

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-ssl-session-cache-prop

set-stats-prop

Syntax

tadm set-stats-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the properties of the statistics collection subsystem.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to set properties of the statistics collection subsystem.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following statistics properties:

enabled: Specifies whether the server collects the statistics.
Values: true, false. Default: true.

interval: Specifies the interval (in seconds) at which the statistics are updated.
Values: 0.001 to 3600.

profiling: Specifies whether the performance buckets used to track NSAPI function execution time are enabled at runtime.
Values: true, false. Default: true.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-stats-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org interval=0.005

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-stats-prop

set-tcp-listener-prop

Syntax

tadm set-tcp-listener-prop common_options --config=config_name --tcp-listener=name (property_name=property_value)+

Description

Use this command to set the TCP listener properties.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to set properties of the TCP listener.

--tcp-listener|-t

Specify the name of the TCP listener.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following tcp-listener properties:

enabled: Specifies whether the instance is enabled.
Values: true, false. Default: true.

name: Specifies the name of the TCP listener.
Values: Must be in a text string.

ip: Specify the Internet Protocol (IP) address for the TCP listener.
Values: A valid IP address or an asterisk (*) to listen on all IP addresses.

family: Specify the internet protocol family, for example: IPV4, and IPV6. The default is IPv4(family=inet). To use the IPv6 address, specify family=inet6.

Note:
The property family can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

acceptor-threads: Specifies the number of threads dedicated to accept connections received by this listener.
Values: 1 to 128. Default: 1 per CPU.

Note:
The property acceptor-threads can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

tcp-proxy-name: Specifies the name of the TCP proxy.
Values: Must be in a text string.

listen-queue-size: Specifies the size (in bytes) of the listen queue.
Values: 0 to 65536.

receive-buffer-size: Specifies the size (in bytes) of the operating system socket receive buffer.
Values: 1 to 1048576.

send-buffer-size: Specifies the size (in bytes) of the operating system socket send buffer.
Values: 1 to 1048576.

description: Specifies the description of the TCP listener.
Values: Must be in a text string.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-tcp-listeners-prop --user=admin
--password-file=./admin.passwd --port=8989
--config=www.example.org --tcp-listener=TCP_Listener1 listen-queue-size=238 max-threads=789

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-listener, delete-tcp-listener, list-tcp-listeners, get-tcp-listener-prop

set-tcp-proxy-prop

Syntax

tadm set-tcp-proxy-prop common_options --config=config_name --tcp-proxy=tcp_proxy_name (property_name=property_value)+

Description

Use this command to set the properties of the TCP proxy for a configuration.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to set the properties of the TCP proxy.

--tcp-proxy|-r

Specify the name of the TCP proxy.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following tcp-proxy properties:

enabled: Specifies whether the TCP listener instance is enabled.
Values: true, false. Default: true.

name: Specifies the name of the TCP listener.
Values:

session-idle-timeout: Specifies the maximum timeout (in seconds) for load balancer to wait for receiving/sending data for a session.
Values: Number. Default: 300 seconds.

origin-server-pool-name: Specifies the name of the origin-server pool.
Values: Text.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-tcp-proxy-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --tcp-proxy=proxy1 --config=www.example.org access-log-file=../logs/www_example_com_access.log

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-tcp-proxy, delete-tcp-proxy, list-tcp-proxies, get-tcp-proxy-prop

set-tcp-thread-pool-prop

Syntax

tadm set-tcp-thread-pool-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the thread-pool properties of a configuration. The tcp-thread-pool element configures the threads used to proxy data for upgraded websocket connections and generic TCP connections. You can use TCP thread pools to allocate a certain number of threads to a specific service. By defining a pool with the maximum number of threads as 1, only one request is allowed to the specified service function.

Options

For information about common_options, run the help command.

Operands

property-name=property-value

Specify the name of the property that you want to view (Optional).

You can view the following tcp-thread-pool properties:

enabled: Specifies whether the virtual server is enabled.
Values: true, false. Default: true.

threads: Specifies the number of threads in the proxy thread pool.
Values: 1 to 512.

Note:
The property threads can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

max-connections: Specifies the number of concurrent connections to the server.
Values: 1 to 1048576.

Note:
The property max-connections can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

timeout: Specifies the maximum number (in seconds) that a connection can be in a idle state. This value will be overridden by TCP or websocket subsystem.
Values: .001 to 3600. Default: 300 seconds.

stack-size: Specifies the stack size (in bytes) for TCP request processing threads.
Values: 8192 to 67108864 or 0. Default 32768.

poll-interval: Specifies the interval (in seconds) between polls.
Values: 0.001 to 1. Default 0.010 seconds.

buffer-size: Specifies the buffer size (in bytes) for TCP request processing threads.
Values: 0 to 1048576 or 0. Default 16384.

Example

tadm set-tcp-thread-pool-prop
--config=www.example.org enabled buffer-size=100

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-tcp-thread-pool-prop

set-thread-pool-prop

Syntax

tadm set-thread-pool-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to set the thread-pool properties for a configuration. The thread-pool element configures the threads used to process HTTP requests. You can use thread pools to allocate a certain number of threads to a specific service. By defining a pool with the maximum number of threads as 1, only one request is allowed to the specified service function.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to set thread-pool properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following thread-pool properties:

queue-size: Specifies the maximum number of concurrent HTTP connections that can be queued for processing.
Values: 1 to 1048576.

Note:
The property queue-size can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

min-threads: Specifies the minimum number of HTTP request processing threads.
Values: 1 to 4096.

Note:
The property min-threads can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

max-threads: Specifies the maximum number of HTTP request processing threads.
Values: 1 to 4096.

Note:
The property max-threads can accept auto-tuned as a value. Auto-tuned implies that the server will compute the value of this property at runtime.

stack-size: Specifies the stack size (in bytes) for HTTP request processing threads.
Values: 8192 to 67108864.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-thread-pool-prop --user=admin --host=admin.example.com
--password-file=./admin.passwd --port=8989
--no-prompt --config=www.example.org queue-size=238 max-threads=789

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-thread-pool-prop

set-token-pin

Syntax

tadm set-token-pin common_options [--save-pin=true|false] --token=name --config=config_name

Description

Use this command to set or reset the SSL token pin for the server.

Options

For information about common_options, run the help command.

--save-pin|-a

If you specify this option, the SSL token PIN gets saved in server.xml file.

--token|-t

Specify the name of the PKCS #11 token.

--config|-c

Specify the name of the configuration to set the token pin.

Example

tadm set-token-pin --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--token=internal --config=www.example.org
<tadm Enter token-pin:
<tadm Enter new token-pin:
<tadm Enter new-token-pin again:

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-pkcs11-prop, set-pkcs11-prop, list-tokens, set-token-prop

set-token-prop

Syntax

tadm set-token-prop common_options --config=config_name --token=name ([--set-password] | (property_name=property_value)*)

Description

Use this command to enable or disable the SSL tokens for the server. You can also use this command to save the token pin in the server.xml file, which will facilitate unsupervised server startup.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the token properties.

--token|-t

Specify the name of the PKCS #11 token that contains the certificates.

--set-password|-r

If you specify this option, it can only be saved in server.xml file if there is already a (Personal Identification Number) PIN set on the token.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following token property:

enabled: Specifies whether the server initializes this token, prompting for a personal identification number (PIN) if necessary.
Values: true, false. Default: true.

Example

tadm set-token-prop --user=admin --password-file=../admin.pwd
--host=admin.example.com --port=8989 --config=www.example.org --token=internal  enabled=true

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, get-pkcs11-prop, set-pkcs11-prop, list-tokens, set-token-pin

set-virtual-server-prop

Syntax

tadm set-virtual-server-prop common_options --config=config_name
--vs=vs_name (property_name=property_value)+

Description

Use this command to set the properties of a virtual-server.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration to set the virtual-server properties.

--vs|-s

Specify the name of the virtual server.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following virtual-server properties:

enabled: Specifies whether the virtual server is enabled.
Values: true, false. Default: true.

host: Indicates the host name of the virtual-server services.
Values: The value can be a host name or a wild card.

Note:
The property host enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

default-object-name: Specifies the name of the root (obj.conf) object.
Values: Default value: default.

Note:
The property default-object-name can accept default as a value. Default implies that the server will compute the value of this property at runtime.

http-listener-name: The name of a HTTP listener associated with one or more of the virtual server's host name.
Values: One of the names from http-listener element.

Note:
The property http-listener-name enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

object-file: Specifies the obj.conf file that controls request processing for virtual-servers.
Values: Default value: config_name-obj.conf, and the user can specify any valid file.

canonical-server-name: The canonical name of the virtual server.
Values: The value could be a host name or a URL prefix

log-file: Specifies the log file for the virtual server.
Values: The value is the log file name, for example ../logs/errors.log

server-cert-nickname: Specifies the nickname of the certificate that the server presents to the clients.
Values: zero or one for RSA and zero or one for ECC.

Note:
The property server-cert-nickname enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

webapp-firewall-ruleset: Specifies the location where the Web Application Firewall (WAF) ruleset files are stored.
Values: Any valid directory where WAF ruleset files are stored.

Note:
The property webapp-firewall-ruleset enables you to specify multiple values, with each value enclosed in quotes and separated by commas.

To reset a property to its default value, do not provide a property value.
For example, property=<empty_string>

Example

tadm set-virtual-server-prop --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=www.example.org --vs=soa.example.org log-file=../logs/errors host=www.example.com

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-virtual-server, get-virtual-server-prop, list-virtual-servers, copy-virtual-server

start-failover

Syntax

start-failover common_options --config=config_name --instance-home=instance_home

Description

If the administration node process is running as non-root on the node where the instances are located, then you must run start-failover on those nodes as a root user. This is to manually start or restart a failover in the following cases:

- While creating a failover group and if the instances for that failover group were running.

- While deleting a failover group and if the instances for that failover group were running.

- After toggling the primary and backup nodes in a failover group.

Note:
start-failover must be executed on the node as a root user.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to start failover.

--instance-home|-i

Indicates the location where the server instances can be found.

Example

tadm start-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=www.example.org --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-failover-group, delete-failover-group, set-failover-group-primary, stop-failover

start-instance

Syntax

tadm start-instance common_options --config=config_name (node_host)*

Description

Use this command to start one or more instances of a configuration. When you execute start-instance, if the administration node process is running as non-root on the node where the instances are located, then it will start the instance, but it will not start the failover. In order to manually start the failover, you must run start-failover on those nodes as a root user.

Options

For information about common_options, run the help command.

--config|-c

Specify the configuration for which you want to start instances.

Operands

node-host

Specify the name of the node running on the configuration. If you do not specify any node, all instances of the configuration are started. If you run this command when one or more instances are already running, an error is displayed.

Example

tadm start-instance --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=soa serverhost

tadm start-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=soa --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, delete-instance, list-instances, create-instance, stop-instance, restart-instance, reconfig-instance, list-nodes

start-snmp-subagent

Syntax

tadm start-snmp-subagent common_options [--instance-home=instance_home] [--agentx] (node_host)*

Description

Use this command to start the Simple Network Management Protocol (SNMP) subagent.

Note:
The SNMP subagent does not require the administration server to be in the running mode.

Options

For information about common_options, run the help command.

--instance-home|-i

Indicates the location where the server instances can be found. You must specify a valid installation location. When an --instance-home is specified, the command starts the SNMP subagent locally. When an --instance-home is not specified, the command does not start the SNMP subagent locally, but tries to connect to the administration server.

--agentx|-x

Specifies whether the SNMP subagent to run as subagent using the agentx protocol. If the SNMP subagent runs as agentx, the SNMP master agent must be up and running.

Note:
While running as an agentx protocol, the master agent (snmpd) needs to be configured to listen to the agentx protocol and must open the path mentioned in admin-server/config/snmpagt.conf. Make sure that the OTD SNMP has the required permissions to the agentx protocol.

Operands

node-host

Specify the name of the node running on the configuration.

Example

To start the SNMP subagent on one or more nodes:

tadm start-snmp-subagent --user=admin node1.example.com

To start the SNMP subagent locally on a node:

tadm start-snmp-subagent --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, stop-snmp-subagent, set-snmp-prop, get-snmp-prop

stop-admin

Syntax

tadm stop-admin common_options node_host

Description

Use this command to stop the administration server or a node. After running stop-admin, to start the admin server, run $INSTANCE_HOME/admin-server/bin/startserv.

Options

For information about common_options, run the help command.

Operands

node-host

Specify the name of the node running on the configuration.

Example

tadm stop-admin --user=admin --password-file=./admin.passwd
--host=admin.example.com --port=8989 --no-prompt serverhost

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, restart-admin, set-admin-prop, get-admin-prop

stop-failover

Syntax

stop-failover common_options --config=config_name --instance-home=instance_home

Description

If the administration node process is running as non-root on the node where the instances are located, then in some cases stop-failover must be run on those nodes as a root user. Use this command in the following cases:

- After deleting failover groups if no other failover groups are available for the corresponding instances.

- When you need to manually stop an instance.

Note:
stop-failover must be executed on the node as a root user.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to stop failover.

--instance-home|-i

Indicates the location where the server instances can be found.

Example

tadm stop-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=www.example.org --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-failover-group, delete-failover-group, set-failover-group-primary, start-failover

stop-instance

Syntax

tadm stop-instance common_options --config=config_name (node_host)*

Description

Use this command to stop one or more instances of a configuration. When you execute stop-instance, if the administration node process is running as non-root on the node where the instances are located, and if the failover for that instance is running, then the instance will not be stopped. In order to stop the failover and the instance, you must execute the stop-failover command on the node as a root user.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to stop instances.

Operands

node-host

Specify the name of the node running on the configuration . If you do not specify any nodes, all instances running on the specified configuration are stopped. If an instance on any node is not running, this command will result in an error.

Example

tadm stop-instance --user=admin --password-file=./admin.passwd --host=admin.example.com --port=8989 --no-prompt
--config=soa serverhost

tadm stop-failover --user=admin
--password-file=./admin.passwd --host=admin.example.com --port=8989
--no-prompt --config=soa --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, create-instance, list-instances, start-instance, delete-instance, restart-instance, reconfig-instance, list-nodes

stop-snmp-subagent

Syntax

tadm stop-snmp-subagent common_options [--instance-home=instance_home] (node_host)*

Description

Use this command to stop the Simple Network Management Protocol (SNMP) subagent running on a node.

Note:
The SNMP subagent does not require the administration server to be in the running mode.

Options

For information about common_options, run the help command.

--instance-home|-i

Indicates the location where the server instances can be found. When an --instance-home is specified, the command stops the SNMP subagent locally.
When an --instance-home is not specified, the command does not stop the SNMP subagent locally, but tries to connect to the administration server.

Operands

node-host

Specify the name of the node.

Example

When you stop the SNMP subagent locally:

tadm stop-snmp-subagent --instance-home=/home/otd

When you stop the SNMP subagent by connecting to the administration server:

tadm stop-snmp-subagent --user=admin
Enter admin-user-password>

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, start-snmp-subagent, set-snmp-prop, get-snmp-prop

unconfigure-server

Syntax

tadm unconfigure-server common_options --instance-home=instance_home

Description

Use this command to remove the administration server and all instances of Oracle Traffic Director on the specified INSTANCE_HOME directory. To create the administration server, run the configure-server command.

Options

For information about common_options, run the help command.

--instance-home|-i

Indicates the location where the server instances can be found.

Example

tadm unconfigure-server --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.

See Also

help, configure-server

Index
A  B  C  D  E  F  G  H  I  K  L  M  N  O  P  Q  R  S  T  U  V  X

A

access-log, 2

enable, 2

get, 2

access-log-buffer-prop

get, 2

set, 2

access-log-prop

get, 2

admin

restart, 2

stop, 2

admin-certs

renew, 2

admin-ldap-auth, 2

enable, 2

admin-ldap-auth-prop

get, 2

admin-password

reset, 2

admin-prop

get, 2

set, 2

B

backups

list, 2

block

proxy-info, 2

C

cache-prop

get, 2

set, 2

cache-rule

create, 2

delete, 2

cache-rule-prop

get, 2

set, 2

cache-rules

list, 2

cert

delete, 2

cert-install, 2 cert-prop

get, 2

cert-request

create, 2

certs

list, 2

cert-trust-prop

set, 2

ciphers

disable, 2

enable, 2

compression-rule

create, 2

delete, 2

compression-rule-prop

get, 2

set, 2

compression-rules

list, 2

config

copy, 2

create, 2

delete, 2

pull, 2

restore, 2

config-file

get, 2

set, 2

config-files

list, 2

config-prop

get, 2

set, 2

configs

list, 2

config-stats

get, 2

configuration

deploy, 2

configure

server, 2

copy

config, 2

virtual-server, 2

create

cache-rule, 2

cert-request, 2

compression-rule, 2

config, 2

error-page, 2

event, 2

failover-group, 2

http-listener, 2

instance, 2

origin-server, 2

origin-server-pool, 2

request-limit, 2

route, 2

selfsigned-certificate, 2

variable, 2, 2, 2

virtual-server, 2

create-origin-server, 2 create-origin-server-pool, 2 crl

delete, 2

crl-install, 2, 2 crl-prop

get, 2

crls

list, 2

D

delete

cache-rule, 2

cert, 2

compression-rule, 2

config, 2

crl, 2

error-page, 2

event, 2

failover-group, 2

http listener, 2

instance, 2

limit-request, 2

origin-server, 2

origin-server-pool, 2

route, 2

variable, 2, 2, 2

virtual-server, 2, 2

deploy

configuration, 2

disable, 2

access-log, 2

admin-ldap-auth, 2

ciphers, 2

event, 2

maintenance, 2

perf-dump, 2

route-authentication, 2, 2

stats-xml, 2, 2, 2

dns-cache-prop

get, 2

set, 2

dns-prop

get, 2

set, 2

E

enable

access-log, 2

admin-ldap-auth, 2

ciphers, 2

event, 2

maintenance, 2

perfdump, 2

route-auth, 2, 2

stats-xml, 2, 2, 2

error-page

create, 2

delete, 2

error-pages

list, 2

event

create, 2

delete, 2

disable, 2

enable, 2

events

list, 2

F

failover-group

create, 2

delete, 2

get, 2

failover-groups

list, 2

forward

proxy-info, 2

G

get

access-log, 2

access-log-buffer-prop, 2

access-log-prop, 2

admin-ldap-auth-prop, 2

admin-prop, 2

cache-prop, 2

cache-rule-prop, 2

cert-prop, 2

compression-rule-prop, 2

config-file, 2

config-prop, 2

config-stats, 2

crl-prop, 2

dns-cache-prop, 2

dns-prop, 2

failover-group, 2

health-check-prop, 2

http-listener-prop, 2

http-prop, 2

keep-alive-prop, 2

localization-prop, 2

log, 2

log-prop, 2

origin-server-pool-prop, 2

origin-server-prop, 2, 2

perfdump, 2

perfdump-prop, 2

pkcs11-prop, 2

qos-limits-prop, 2

qos-prop, 2

request-limit-prop, 2

route-auth-prop, 2

route-prop, 2

snmp-prop, 2

ssl-prop, 2

ssl-session-cache-prop, 2

stats-prop, 2

stats-xml, 2

stats-xml-prop, 2

thread-pool-prop, 2, 2, 2, 2, 2, 2, 2

virtual-server-prop, 2

virtual-server-stats, 2, 2

H

healtch-check-prop

get, 2

health-check-prop

set, 2

help, 2 http listener

delete, 2

http-listener

create, 2

http-listener-prop

get, 2

set, 2

http-listeners

list, 2

http-prop

get, 2

set, 2

I

install-cert, 2

install-crl, 2, 2

instance

create, 2

delete, 2

reconfig, 2

restart, 2

start, 2

stop, 2

instances

list, 2

K

keep-alive-prop

get, 2

set, 2

L

limit-request

delete, 2

list

backups, 2

cache-rules, 2

certs, 2

compression-rules, 2

config-files, 2

configs, 2

crls, 2

error-pages, 2

events, 2

failover-groups, 2

http-listeners, 2

instances, 2

nodes, 2

origin-server-pools, 2

origin-servers, 2

proxy-info, 2

request-limits, 2

routes, 2

tokens, 2, 2, 2

virtual-servers, 2, 2

list-ciphers, 2 lists

variables, 2

localization-prop

get, 2

set, 2

log

get, 2

rotate, 2

log-prop

get, 2

set, 2

M

maintenance

disable, 2

enable, 2

get properties, 2

N

node

remove, 2

node-certs

renew, 2

nodes

list, 2

O

origin-server

create, 2

delete, 2

origin-server-pool

create, 2

delete, 2

origin-server-pool-prop

get, 2

set, 2

origin-server-pools

list, 2

origin-server-prop

get, 2, 2

set, 2

origin-servers

list, 2

overview, 1

P

perf-dump

disable, 2

enable, 2

get, 2

perfdump-prop

get, 2

pkcs11-prop

get, 2

set, 2

primary

group

set failover, 2

proxy-info

block, 2

forward, 2

list, 2

pull

config, 2

Q

qos-limits-prop

get, 2

qos-prop

get, 2

set, 2

R

reconfig

instance, 2

remove

node, 2

renew

admin-certs, 2

node-certs, 2

request-limit

create, 2

request-limit-prop

get, 2

request-limits

list, 2

reset

admin-password, 2

restart

admin, 2

instance, 2

restore

config, 2

rotate

log, 2

route

create, 2

delete, 2

route-auth

enable, 2, 2

route-authentication

disable, 2, 2

route-auth-prop

get, 2

route-prop

get, 2

set, 2

routes

list, 2

S

selfsigned-certificate

create, 2

server

configure, 2

unconfigure, 2

set

access-log-buffer-prop, 2

admin-prop, 2

cache-prop, 2

cache-rule-prop, 2

cert-trust-prop, 2

compression-rule-prop, 2

config-file, 2

config-prop, 2

dns-cache-prop, 2

dns-prop, 2

failover-group

primary, 2

health-check-prop, 2 http-listener-prop, 2 http-prop, 2 keep-alive-prop, 2 localization-prop, 2 log-prop, 2 origin-server-pool-prop, 2 origin-server-prop, 2 pkcs11-prop, 2 qos-prop, 2 request-limit-rule-prop

set, 2

route-prop, 2 snmp-prop, 2 ssl-prop, 2 ssl-session-cache-prop, 2 stats-prop, 2 thread-pool-prop, 2, 2, 2 token-pin, 2 token-prop, 2 virtual-server-prop, 2, 2, 2 set-qos-limits-prop, 2 snmp-prop

get, 2

set, 2

snmp-subagent

start, 2

stop, 2, 2

ssl-prop

get, 2

set, 2

ssl-session-cache-prop

get, 2

set, 2

start

instance, 2

snmp-subagent, 2

start-snmp-subagent, 2 stats-prop

get, 2

set, 2

stats-xml

get, 2

stats-xml-prop

get, 2

stop

admin, 2

instance, 2

snmp-subagent, 2, 2

T

thread-pool-prop

get, 2, 2, 2, 2, 2, 2, 2

set, 2, 2, 2

token-pin

set, 2

token-prop

set, 2

tokens

list, 2, 2, 2

U

unconfigure

server, 2

usage modes, 1.2

V

variable

create, 2, 2, 2

delete, 2, 2, 2

variables

list, 2

virtual-server

copy, 2

create, 2

delete, 2, 2

virtual-server-prop

get, 2

set, 2, 2, 2

virtual-servers

list, 2, 2

virtual-server-stats

get, 2, 2

X

xml-stats

disable, 2, 2, 2

enable, 2, 2, 2

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2018, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Pre-General Availability Draft Documentation Notice

If this document is in public or private pre-General Availability status:

This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Pre-General Availability Draft Documentation Notice

If this document is in private pre-General Availability status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your pre-General Availability trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.