streamtool restartdomainservice

Usage

restartdomainservice [-d,--domain-id <did>] [--noprompt] [--resource <resourceId>] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk] <service> ... | <service>,...

The streamtool restartdomainservice command restarts domain services.

Authority

You must have write authority for the domain object. By default, the DomainAdministrator role has this authority. For more information about access control lists, see streamtool getdomainacl.

Description

When you start an Streams domain, services start on the appropriate resources. If a software, hardware, or network interruption occurs and a domain service fails, Streams tries to restart the service. The domain.serviceRetryCount domain property specifies the number of times Streams tries to restart the service. If you configured high availability for the management services in a domain, Streams can switch to using standby services and thus does not wait for the failing service to restart.

If you have resolved the software, hardware, or network problem and want to restart the failed domain services, you can run this command. Alternatively, you can stop and start the domain or quiesce and resume the resource where the service runs.

You might also use this command if you updated a domain property that affected only a specific service and you do not want to restart all of the services in the domain.

If there are one or more standby services for the domain service that you specify in the command, all of the standby services are also restarted.

To restart the domain services only on a specific resource, use the --resource option.

When you specify a service, only that service is restarted; the container process remains running. Use the container option to restart the container process and all of the services that it contains.

If you specify multiple services in the command, they are restarted in the order specified.

Options

-d,--domain-id <did>
Specifies the domain identifier.

If you do not specify this option, Streams uses the domain name that is set in the STREAMS_DOMAIN_ID environment variable. By default, that domain name is StreamsDomain. If you are using the interactive streamtool interface, it uses the name of the active domain for the current streamtool session or else it prompts you for the domain name.

The active domain for the current streamtool session is set every time that you successfully run a streamtool command with a -d or --domain-id option. Alternatively, you can run the streamtool domain command in the interactive interface.

--embeddedzk

Specifies to use the embedded copy of ZooKeeper. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify either this option or the --zkconnect option, Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. Streams determines which connection maps to the domain by using cached information about the domains. In this scenario, if the domain identifier is not unique in the Streams configuration cache, the command fails.

-h,--help
Specifies to show the command syntax.
--noprompt
Specifies to suppress confirmation prompts.
--resource <resourceId>
Specifies a resource identifier, which can be the host name or IP address. The command restarts the specified services on this resource. If you do not use this option, the command restarts the specified services on all of the resources in the instance.
--trace <level>
Specifies the trace setting. The following valid levels are listed in order of increasing verbosity, which is to say that the first level in the list generates the least amount of information:
  • off
  • error
  • warn
  • info
  • debug
  • trace
The default value is off.
-U,--User <user>
Specifies an Streams user ID that has authority to run the command.
-v,--verbose <level>
Specifies to provide more detailed command output. The verbosity level can be 0-3, where 0 disables detailed reporting and each increment provides more detailed output.
--zkconnect <{<host>:<port>},...>

The name of one or more host and port pairs that specify the configured ZooKeeper servers. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify this option, Streams tries to use:

  1. The --embeddedzk option
  2. The value from the STREAMS_ZKCONNECT environment variable
  3. A ZooKeeper connection string that is derived from cached information about the current domain.

Arguments

service
Specifies the name of the domain service. The following service name values are valid: aas; auditlog; controller; jmx; sws; and container. Specifying container restarts the entire container process and all of the services that it contains. If you specify multiple services, the command restarts them in the order specified.