IBM InfoSphere Streams Version 4.1.0

streamtool getdomainacl

The streamtool getdomainacl command lists the access control lists (ACLs) that are associated with a specific security object in an InfoSphere® Streams domain.

Usage


getdomainacl

>>-+-----------------------+--+---------+----------------------->
   '-+- -d----------+--did-'  +- -h-----+   
     '- --domain-id-'         '- --help-'   

>--+-----------------+--+---------------------+----------------->
   '- --trace--level-'  '-+- -U-----+--userid-'   
                          '- --User-'             

>--+-----------------------+------------------------------------>
   '-+- -v--------+--level-'   
     '- --verbose-'            

>--| Non-interactive tool options |--object--------------------><

Non-interactive tool options

    (1)                                    
|--------+-----------------------------+------------------------|
         +- --embeddedzk---------------+   
         |               .-,---------. |   
         |               V           | |   
         '- --zkconnect----host:port-+-'

Notes:

The non-interactive tool options are not supported in the interactive streamtool interface.

Authority

You must have write authority for the config domain object. By default, the DomainAdministrator role has this authority.

Description

InfoSphere Streams uses ACLs to enforce security. An ACL is composed of the type of object to secure and the actions that a group or user is authorized to perform against the object. InfoSphere Streams objects are hierarchical in nature, in that some objects are included by other objects. These relationships are sometimes referred to as parent and child relationships between the objects.

The streamtool getdomainacl command returns information about the parent, owner, persistence, and access permissions for the security object. If the command output indicates that the security object is persistent, it means that changes to this object, for example changes to its permissions, are recorded in the domain security configuration and thus persist even after the domain is stopped and restarted.

For more information, see Security objects and access permissions for InfoSphere Streams domains and instances.

Options and arguments

-d, --domain-id did

Specifies the domain identifier.
If you do not specify this option, InfoSphere 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, InfoSphere Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. InfoSphere 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 InfoSphere Streams configuration cache, the command fails.

-h, --help

Specifies to show the command syntax.

object

Specifies an InfoSphere Streams object, which must be one of the following values:
config

domain

hosts

instances

system-log

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

Specifies an InfoSphere Streams user ID that has authority to run the command.

-v,--verbose level

Specifies to provide more detailed command output. The vebosity level can be from 0 to 3 where 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, InfoSphere Streams tries to use:
The --embeddedzk option

The value from the STREAMS_ZKCONNECT environment variable

A ZooKeeper connection string that is derived from cached information about the current domain.

Examples

In the following example, the command returns the access control information for hosts in a domain:

[streamtool <bsmith@StreamsDomain.StreamsInstance>] getdomainacl hosts
# object: hosts
# parent: domain
# owner: nobody
# persistent: yes
user:bsmith:rwsado
user:sjones:r-----
group:grp1:---ad-
role:DomainUser:r-s---
role:DomainAdministrator:rwsado

The command output lists the users, groups, and roles that have access control permissions for the hosts domain object. For example, the command indicates that the bsmith user has read, write, search, add, delete, and own permissions for the hosts domain object.