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.