streamtool quiesceresource

Usage

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

The streamtool quiesceresource command quiesces one or more resources in a domain.

Authority

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

Description

When you want to perform maintenance activities on one or more externally managed resources or Streams resources, you can quiesce them. This command stops all of the Streams services on the specified resources, except for the domain controller service. If management services are running on the resource, you must have standby services on other resources in the domain; otherwise, the resource is not quiesced. For more information about configuring standby services and high availability in Streams, see the product documentation.

If there are jobs running in an instance in the domain and the jobs have processing elements that cannot be relocated to other resources, the specified resources are not quiesced.

If you specify multiple resources in this command, each resource is quiesced sequentially and independently. If one of the resources cannot be quiesced, it does not affect the quiesce operation on other resources.

When you quiesce Streams resources that were part of a --numresources specification, Streams tries to find another resource to satisfy the specifications.

When you quiesce externally managed resources, they are released back to the external resource manager. Streams tries to find another resource to satisfy the specifications.

See also streamtool resumeresource.

Options

--continue
This option is deprecated and no longer has any effect.
-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.

--force
Specifies to force all the domain and instance services that are on the resource to stop. Use this option with caution because the command might make resources unavailable or cause the domain or instance to stop. Even if the domain and instances remain healthy, using this option might cause some jobs to become unhealthy. If you specify multiple resources in the command, this option applies to the quiesce operation on each resource.
-h,--help
Specifies to show the command syntax.
--noprompt
Specifies to suppress confirmation prompts.
--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

resourceId
Specifies a resource identifier, which can be the host name or IP address.