start-node-agent(1)

Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also

Name

start-node-agent– starts a node agent

Synopsis

start-node-agent [--user user]

        

        [--passwordfile passwordfile] [--secure={true|false}] 

        

        [ --terse={true|false} ] [ --echo={true|false} ]

        

        [ --interactive={true|false} ] [ --verbose={true|false} ] 

        

        [ --agentdir  nodeagent_path] [--startinstances={true|false}] 

        

        [ --syncinstances={true|false} ] [nodeagent_name]

Description

---

Note –

This command is available only in domains that are configured to support clusters, such as domains that are created with the cluster profile.

---

Use the start-node-agent command start a node agent. The command will return control to the user before instances are actually started. The list-instances command can be executed to see if they have actually started. This command may take a while to execute since the node agent may need to create and start a number of server instances.

This command is supported in local mode only.

Options

-u --user

The authorized domain administration server administrative username.

--passwordfile

The --passwordfile option specifies the name of a file containing the password entries in a specific format. The entry for the password must have the AS_ADMIN_ prefix followed by the password name in uppercase letters.

For example, to specify the domain administration server password, use an entry with the following format: AS_ADMIN_PASSWORD=password, where password is the actual administrator password. Other passwords that can be specified include AS_ADMIN_MAPPEDPASSWORD, AS_ADMIN_USERPASSWORD, and AS_ADMIN_ALIASPASSWORD.

All remote commands must specify the administration password to authenticate to the domain administration server, either through --passwordfile or asadmin login, or interactively on the command prompt. The asadmin login command can be used only to specify the administration password. For other passwords, that must be specified for remote commands, use the --passwordfile or enter them at the command prompt.

If you have authenticated to a domain using the asadmin login command, then you need not specify the administration password through the --passwordfile option on subsequent operations to this particular domain. However, this is applicable only to AS_ADMIN_PASSWORD option. You will still need to provide the other passwords, for example, AS_ADMIN_USERPASSWORD, as and when required by individual commands, such as update-file-user.

For security reasons, passwords specified as an environment variable will not be read by asadmin.

The default value for AS_ADMIN_MASTERPASSWORD is changeit.

-s --secure

If set to true, uses SSL/TLS to communicate with the domain administration server. Default is true.

-t --terse

Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.

-e --echo

Setting to true will echo the command line statement on the standard output. Default is false.

-I --interactive

If set to true (default), only the required password options are prompted.

-h --help

Displays the help text for the command.

--verbose

By default this flag is set to false. If set to true, a console window is opened for the node agent and for every server instance a node agent manages. On Windows, press Ctrl-Break in the console to print a thread dump. On UNIX, press CTRL-Backslash in the console to print a thread dump. The node agent thread dump goes to its console. The server instance thread dump goes to the instance log file.

--agentdir

Like a Domain Administration Server (DAS), each node agent resides in a top level directory named agentdir/nodeagent_name. If specified, the path must be accessible in the filesystem. If not specified, defaults to the install_dir/nodeagents directory.

--startinstances

If set to true, all server instances that are not currently running are started. If set to false, instances are not started. If the option is omitted, it defaults to the value of the node agent's start-servers-in-startup attribute, located in the domain.xml file.

--syncinstances

If set to true, forcibly synchronizes the cache repositories of all server instances with the central repository of the DAS. The synchronization occurs when the node agent is started. Default is false.

Operands

nodeagent_name

The name of the node agent to be started.

Examples

---

Example 1 Using the start-node-agent command




asadmin> start-node-agent --user admin --passwordfile passwordfile nodeagent1 Nodeagent1 started.

The node agent nodeagent1 is started in the default install_dir/nodeagents directory.

---

Exit Status

0

command executed successfully

1

error in executing the command

See Also

stop-node-agent(1), delete-node-agent(1), list-node-agents(1), create-node-agent(1)

Java EE 5  Last Revised 13 Jul 2007