streamtool getinstancecpu
The streamtool getinstancecpu command reports the total number of CPUs that are used by application resources in an instance.
Usage
getinstancecpu >>-+-----------------------+--+-------------------------+-------> '-+- -d----------+--did-' '-+- -i------------+--iid-' '- --domain-id-' '- --instance-id-' >--+---------------------+--+- -U-----+--+---------+------------> '- --fmt--format-spec-' '- --User-' +- -h-----+ '- --help-' >--+-----------------+--+-----------------------+-------------->< '- --trace--level-' '-+- -v--------+--level-' '- --verbose-'
Authority
You must have read authority for the hosts domain object. By default, the DomainAdministrator and DomainUser roles have this authority. For more information about access control lists, see streamtool getdomainacl.
Description
IBM® Streams uses Resource Value Units (RVUs) to measure license usage. The RVUs are based on the number of Activated Processor Cores (that is, CPUs) that are running applications in production. Activated Processor Cores that are used for Management Services or for ZooKeeper don't require RVU licenses. Use this command to view the number of application CPUs for a specific instance. To view the number of application CPUs for an entire domain, use the streamtool getdomaincpu command.
For more information about tracking license usage, see Tracking license usage for IBM Streams.
Options and arguments
- -d, --domain-id did
Specifies the domain identifier.
If you do not specify this option, IBM 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.
- --fmt format-spec
Specifies the presentation format. The command supports the following values:
- %Mf: Multiline record format. One line per field.
- %Nf: Name prefixed field table format. One line per host.
- %Tf: Standard table format, which is the default. One line per host.
- -h, --help
Specifies to show the command syntax.
- -i, --instance-id iid
Specifies the instance identifier.
If you do not specify this option, IBM Streams uses the instance identifier that is set in the STREAMS_INSTANCE_ID environment variable. By default, that instance identifier is StreamsInstance. If you are using the interactive streamtool interface, it tries to use an instance ID that you specified in a previous command. If no such value is found, the command uses the STREAMS_INSTANCE_ID environment variable. Alternatively, you can run the streamtool instance command in the interactive interface.
- --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
- -U, --User userid
Specifies an IBM 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.
Examples
streamtool getinstancecpu -d myDomain -i myInstance1
Resource CPU
myResource1 16
myResource2 16
Total Application CPU: 32