streamtool settagproperty

Usage

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

The streamtool settagproperty command updates the resource definition that is associated with a tag.

Authority

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

Description

If you use an external resource manager, you might need to declare system-related attributes such as memory and processor cores. These attributes make up a resource definition. You can associate a resource definition with a tag by using either the --property or --deffile options when you create a tag.

To add or replace the properties in a resource definition, use the streamtool settagproperty command.

To add or replace the resource definition file that is associated with a tag, use the streamtool chtag command. If the file contains properties that are defined with the following format, you can change or remove the properties by using streamtool settagproperty and rmtagproperty commands: name=value. Otherwise, you must update the definition file and change the tag to use the updated file.

The external resource manager uses default values for any properties that you do not include in the resource definition.

For more information, see the streamtool lstag, gettag, chtag, mktag, rmtag, and rmtagproperty 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.
--tag <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.

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

property-name=property-value
Specifies a property value.