adminagentctl (start or stop Administration Agent)
- Organization of this page
Format
- When starting Administration Agent
-
- For Windows
adminagentctl start [-sync [-timeout synchronous-execution-timeout-time]]
- For UNIX
adminagentctl start [-sync [-timeout synchronous-execution-timeout-time]] [-daemon]
- When stopping Administration Agent
-
- For Windows
adminagentctl stop [-sync [-timeout synchronous-execution-timeout-time]]
- For UNIX
adminagentctl stop [-sync [-timeout synchronous-execution-timeout-time]]
Function
This command starts or stops Administration Agent.
Execute this command with the Administrator privileges (in Windows) or the root permission (in UNIX). However, in UNIX, you can setup the command execution permission for specific users who do not have root permission. For details on settings, see mngenvsetup (setup management group).
Arguments
When no arguments are specified, the command's usage is displayed.
- start
-
Starts Administration Agent.
- stop
-
Stops Administration Agent.
- -sync
-
Enables the synchronous execution of the command process and Administration Agent start or stop process.
- -timeout synchronous-execution-timeout-time
-
Specify the waiting time (unit: seconds) starting from the synchronous execution of the command until the start or stop of Administration Agent, with the integer 0 or 61 through 2147483. This option is enabled when you specify the -sync option.
When you specify 0, a timeout does not occur and the waiting is continued until Administration Agent starts or stops. When you omit this option, the timeout value of the synchronous execution is set as 120 (seconds).
- -daemon
-
Starts Administration Agent as a daemon process. Executes the same operations as executed when starting as the daemon process by using the daemon command. For details on the daemon command, see daemon (start daemon process).
Return values
- 0:
-
The command is terminated normally.
- 1:
-
An execution error is occurred.
- 2:
-
A syntax error is occurred.
- 3:
-
A synchronous execution error occurred.
Input example
-
Input example 1
When starting Administration Agent
adminagentctl start
-
Input example 2
When starting Administration Agent with synchronous execution
adminagentctl start -sync
Precautions
-
Enable the synchronous execution to access Management Server using the management command or Smart Composer, in succession to Administration Agent or Management Server startup.