streamtool mkhosttag

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

The streamtool mkhosttag command creates a tag in a domain. You can also provide a description and a resource definition.

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

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

Tags are a mechanism for differentiating and identifying resources that have different physical characteristics or logical uses. Resources can have any number of tags. Tags are case-sensitive strings with a letter optionally followed by alphanumeric or underscore characters.

Streams defines the following tags:

application

Specifies that the resource can run Streams applications.

audit

Specifies that the resource can run the logging service.

authentication

Specifies that the resource can run the authentication and authorization service.

jmx

Specifies that the resource can run the management API service.

management

Specifies that the resource can run any of the Streams domain and instance management services.

sws

Specifies that the resource can run the web management service.

view

Specifies that the resource can run the view service.

You can define extra tags that meet your needs.

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.

Tags can affect the selection of static and dynamic resources at instance creation time and when resources are added to an instance.

The Streams scheduler uses tags when it matches resources to the resource pool requirements that are expressed in stream processing applications.

The domain maintains a registry of the tags that are defined in the domain.

For more information, see the streamtool lstag, gettag, chtag, and rmtag, rmtagproperty, and settagproperty commands.

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

--deffile <definition-file>

Specifies the absolute path and name of the file from which to import the resource definition. If you do not specify a path, the file must be in the directory where you run the command. The contents and format of the file are specific to the resource manager. Streams passes this information to the resource manager when it requests resources.

--description <description>

Specifies a description for the tag. The description can be 1024 characters in length. If the description contains blank characters, it must be enclosed in single or double quotation marks. Quotation marks within the description must be preceded by a backslash (\).

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

--property <name=value>

Specifies a property name and value pair to add to the resource definition. This option can be specified multiple times and has an additive effect.

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

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.

The following example creates a tag that is called "ingest" in the domain "StreamsDomain":

[streamtool <bsmith@StreamsDomain.StreamsInstance>] mkhosttag --description 'Hosts for ingesting from external internet environment' ingest
CDISC0102I The ingest host tag was defined for the StreamsDomain domain.