set_admin

Description

Puts the server that you have connected to into admin mode. The server must be restarted for the change to take effect.

Syntax

Local mode support: No.

Command line:

set_admin connect-args [reason]

Ant build file:

<jag_set_admin [reason=“reason”] />

Option

Description

Required

connect-args

Arguments to specify a connection to the server. See “Using connected mode”.

Yes

reason

The reason the server is being put into admin mode.

No

Returns

Return value

Indicates

0

The command ran successfully; the result is true/success.

1

The command ran successfully; the result is false/failure.

2

The command did not run successfully; an exception was thrown.

Examples

Example 1

This example puts the server into admin mode with the reason “Regularly scheduled maintenance”.

See also

restart, set_ready, “Using Admin mode”