as-agent Command Parameters
The command line parameters for as-agent allow you to specify configuration parameters that control how the agent functions.
The following table describes the command parameters for as-agent:
| Parameter | Description |
|---|---|
| -metaspace <metaspace_name> | Specifies the name of the metaspace that as-agent is to join. |
| -discovery <url> / <url_list> | Specifies the discovery URL to be used to discover the space. The discovery URL format can have the following formats:
For more information on the -discovery parameter, see the documentation for the discovery parameter that is used with the with the as-admin connect command (see connect). |
| -listen <url> | Specifies a listen URL for the as-agent. The default value is TCP. For more information, see the description of the listen parameter that is used with the with the as-admin connect command (see connect). |
| -remote_listen <url> | Specifies a remote listen URL that is used to contact a remote client and accept incoming remote client connections. The URL format is:
tcp://interface:remote_listen_port |
| -log | (optional) Specifies the path to the log file and the log file name.
If you include the parameter -log <log_file>, then the log filename will be <log_file>-<processid>.log. For example, if you enter -log as, then the log filename is as-<processid>.log. |
| -log_debug | Specifies a debug log level that controls the level of log messages written to the log file, To specify a log level, enter:
-log_debug <LogLevel> The log levels are as follows: 1 = ERROR_LEVEL 2 = WARNING_LEVEL 3 = INFO_LEVEL The default is 3 (INFO_LEVEL). The log information is written to the log. If a log file is not specified, then the debug (log level) value is ignored. |
| -log_limit | Specifies the maximum log file size in bytes before rollover. If log file rollover is configured, a new log file is started when the log file limit is reached. |
| -log_count | Specifies the number of log files that can be created. the default is one log file. If rolling logs are enabled, specifies the maximum number of log files. |
| -log_append | Specifies whether data can be appended to the log file. The default value is true. |
| -debug <log_level> | Specifies a debug log level that controls which level of log messages are written to console. For more details, see -log_debug. |
| -advisory_level <advisory_level> | Not implemented in the current release. |
| -member_name <membername> | Specifies a member name for the member. This helps to identify which member name is associated with which member ID. The show members command displays the member name if one has been assigned; otherwise, a default member name is assigned that is constructed from the member ID. |
| -data_store <directory path> | If you are using shared-nothing persistence, specifies the directory where persistence data is stored. |
| -worker_thread_count <count> | Specifies number of threads that can be used for program invocation. Default is 32, meaning you can have 32 invocations in parallel. |
| -rx_buffer_size <size> | Specifies the TCP buffer size for receiving data. The default value is 2 MB. If an application is using large tuples, this value can be increased accordingly. If the value is smaller than what is needed to receive over the connection, then a dynamic buffer is allocated during the lifetime of the message. It is better to use a large value to avoid a context switch from a dynamic to a static buffer |
| -security_policy <string> | If TIBCO ActiveSpaces security is implemented and you are connecting from a domain security controller node, specify the security_policy parameter and provide the directory path and filename for the policy file. If you specify a policy file, do not specify the security_token parameter. |
| -security_token <string> | Specifies the token file for a security domain requestor that must be authenticated by a security domain controller. If TIBCO ActiveSpaces security is implemented and you are connecting from a requestor node, and the metaspace to which you are connecting requires a token file, specify the security_token parameter and provide the directory path and filename for the token file. If you specify a token file, do not specify the security_policy parameter.
The following example shows how to start as-agent as a requestor node with security enabled: |
| -authentication_domain <string> | The name of the windows domain to log into. If local/ntlm account (as per the controller), “.” can be used. If not windows, it will be ignored |
| -authentication_username <string> | The authentication username of the user account. |
| -authentication_keyfile <string> | The pkcs12 keyfile location of the user to be logged in as (sasl/external x509 ldap auth) |
| -authentication_password <string> | The authentication password of the user account to be logged in as or the password of the pkcs12 key file if x509 auth is used. |
| -identity_password <string> | The policy's security domain's or the token's identity password if the identity is encrypted |
| -monitor_system true |false OR <boolean> | The -monitor_system parameter allows you to enable the system monitor on the specified member to start and advertise its performance statistics in its joined metaspace(s) scope.
To start performance monitoring with as-agent or as-admin, start the utility with the -monitor_system parameter set to true, for example: as-agent -monitor_system true The default value is false. |
| -input <filepath> | The -input parameter allows you to pass a file containing Admin CLI commands as input to as-agent |
| -admin | Runs the as-agent utility and displays a command window which accepts Admin CLI commands. |
| -member_timeout | Specifies the time in milliseconds to wait for a member to reconnect. The default is 30000. |
| -cluster_suspend_threshold | Specifies the lost hosts allowed before membership operations are suspended. By default, it is not suspended. |
| -connect_timeout | Specifies the time to wait to connect to the metaspace. |
| -autojoin.role | When as-agent is run, it first connects to the metaspace and then joins any new or existing spaces in the metaspace as a seeder for each space. The -autojoin.role option allows you to override that behavior and have the as-agent always join spaces as a leech. For example, as-agent -autojoin.role leech. This setting is typically used when starting an as-agent that will only act as a proxy for remote clients. |
Note: The member name that you specify with the -member_name parameter can be the member name; or, if you are implementing host-aware replication, can specify a member name in the form
a.b, where
a specifies the name of a region, for example
region1, and
b specifies the name of a seeder running in that region, in effect, on the same host.
For information on deploying host-aware replication, see
Host-Aware Replication.
For more details about discovery and listen URLs, see TIBCO ActiveSpaces Developer’s Guide.
Related tasks
Copyright © Cloud Software Group, Inc. All rights reserved.