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.