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.