streamtool rmhosttag

Usage

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

The streamtool rmhosttag command removes tags from a domain.

Authority

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

Description

This command is deprecated and might become obsolete. Use the streamtool rmtag command instead.

This command removes the tag from any resources that are using it in the instance. The command then removes the tag from the domain.

The tag is not removed in the following scenarios:

  • The tag has a reserved name, such as management or application.
  • The tag was used by the scheduler to place a processing element (PE) or job that is running.

If you remove a tag from the domain and that tag was used in a resource specification for an instance that is running, the resources are not removed from the instance until it restarts. To update or remove the resource specification that mentions the tag, use the streamtool chresourcespec or streamtool rmresourcespec commands.

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.
--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

tag
Specifies the name of the tag.

Tags are strings such as 'ingest', 'fpga', or 'infiniband'. Tags must be strings with a letter optionally followed by alphanumeric or underscore characters. Tags are case-sensitive.

Examples

The following example removes a tag called "test" from the "StreamsDomain" domain:

[streamtool <bsmith@StreamsDomain.streams>] rmhosttag ingest --noprompt
CDISC0101I The ingest host tag was removed from the StreamsDomain domain.