streamtool getdomainproperty

Usage

getdomainproperty [-d,--domain-id <did>] [[-s,--short] | [-a,--all]] {[-a,--all] | [<property-name> ...]} [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool getdomainproperty command reports property values for the domain, one per line.

Authority

You must have read authority for the config domain object. By default, the DomainAdministrator and DomainUser roles have this authority. To get information about most security-related domain properties, you must also have 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 the property is not present in the configuration, the string <undef> is returned.

If the property is a write-only property, the command returns an error.

If property changes are made while the domain is started and the properties cannot be updated immediately, the changes are pending until the domain stops. If a property has a pending value, the streamtool getdomainproperty command reports both the current and pending values. If you specify the -s or --short option, the command reports only the current values.

For a description of the various configuration properties, see streamtool man domainproperties.

See also

streamtool setdomainproperty

streamtool getbootproperty

streamtool getproperty

Options

-a,--all
Specifies to list the values for all of the properties. Write-only properties are not included in the list.
-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.
-s,--short
Specifies to return a shortened list of information. In particular, the command returns only the current property values. It does not return the property names or the pending property values.
--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
Specifies the name of a property.

Examples

The following command reports the values for the security.sessionTimeout and sws.port properties in the bsmith domain:

streamtool getdomainproperty -d bsmith domain.locktimeout sws.port
LDAP User:bsmith
LDAP Password:******
security.sessionTimeout=14400 (pending value: 14500)
sws.port=0