Installer 10.15 | Complete Installation and Upgrade Information for Software AG Products | Command Central | Using the Command Line Interface | Inventory Commands | sagcc list inventory components
 
sagcc list inventory components
Lists information about run-time components. Information about a run-time component can include:
*Display name
*ID for the run-time component
*ID of the product to which this run-time component belongs
*Run-time component category, which can be one of the following:
*PROCESS for run-time components that functions on its own. These are referred to as instances in the Web user interface.
*ENGINE for run-time components that cannot function on their own, but rather run within a PROCESS run-time component. These are referred to as components in the Web user interface.
Syntax
*Command Central syntax:
*To list components for a specified installation:
sagcc list inventory components  [node_alias] [componentid]                
[options]
*To list components that match specified search criteria:
sagcc list inventory components  [criteria] [start=number]                
[size=number] [options]
*Platform Manager syntax:
sagcc list inventory components  [componentid]  [options]
                 
 options:                  
[{--accept | -a} content_type]                  
[{--debug | -d}]                  
[{--error | -r} file]                  
[{--format | -f} {tsv args | xml | csv args | json}]                  
[{--log | -l} file]                  
[{--output | -o} file]                  
[{--password | -p} password]                  
[{--quiet | -q}]                  
[{--server | -s} url]                  
[{--username | -u} user_name]
Arguments and Options
Argument or Option
Description
[node_alias]
Command Central only.
Optional. Specifies the alias name of the installation for which you want to retrieve component information.
You can view a list of installations and their aliases using sagcc list landscape nodes.
If you do not specify an alias name nor search criteria, the command lists information for all run-time components for all installations that Command Central manages.
[componentid]
Optional. Specifies the ID of the run-time component for which you want to retrieve information.
You can determine the IDs for run-time components using sagcc list inventory components.
[criteria]
Command Central only.
Optional. Narrows down the list of returned run-time components to only those that match the search criteria you specify. For more information, see Specifying Search Criteria for Inventory Commands.
[start=number]
Command Central only.
Optional. Limits the results the command returns those starting at specified number in the results.
For example, if you want to return information for the 5th through the 8th run-time components in the results, use start=5 size=4.
[size=number]
Command Central only.
Optional. Limits the number of results you want returned.
For example, if you specify size=1, the command returns information for only one run-time component.
[options]
Optional. Refer to the command syntax for a list of the options the command supports. For a description of the options, see Common Options.
Examples When Executing on Command Central
*To list all run-time components that the Command Central with host name “rubicon” and port “8090” manages, using the authorization of the user with user name “Administrator” and password “manage”, and have the information returned to the output file “components” in XML format:
sagcc list inventory components --format xml --output components                
--server http://rubicon:8090/cce --username Administrator                
--password manage
*To list the same run-time components as the first example above, but restrict the number of returned run-time components to only 5:
sagcc list inventory components size=5 --format xml --output components                
--server http://rubicon:8090/cce --username Administrator                
--password manage
*To list the 10th through the 15th run-time components in the results and return the output to the console in XML format:
sagcc list inventory components start=10 size=6 --format xml                
--password secret
Because the {--server | -s} and {--username | -u} options are not specified, the command uses the default server and user name. For more information, see server and username. The command specifies “secret” for the user’s password.
*To list run-time components and use search criteria to narrow the results to only those that are installed in the installation with alias name “sag01” and that have the component ID “OSGI-CCE” and return the output to the console in JavaScript Object Notation format:
sagcc list inventory components nodeAlias=sag01                
runtimeComponentId=OSGI-CCE --format json --password secret
Because the {--server | -s} and {--username | -u} options are not specified, the command uses the default server and user name. For more information, see server and username. The command specifies “secret” for the user’s password.
*To list run-time components and use search criteria to narrow the results to only those that are installed in the installation with alias names “sag01” or “sag03” and return the output to the console in xml format:
sagcc list inventory components logicalOperator=OR nodeAlias=sag01                 
nodeAlias=sag03 --format xml --password secret
Because the {--server | -s} and {--username | -u} options are not specified, the command uses the default server and user name. For more information, see server and username. The command specifies “secret” for the user’s password.
Example When Executing on Platform Manager
To list all run-time components managed by the Platform Manager with host name “rubicon2” and port “8092”, using the authorization of the user with user name “Administrator” and password “manage”, and have the information returned to the console in XML format:
sagcc list inventory components --format xml                
--server http://rubicon2:8092/spm --username Administrator                
--password manage