sagcc list configuration types
Lists information about configuration types for the specified run-time component. A run-time component can support both common configuration types, such as ports, logs, and licenses, and/or custom configuration types that are specific to the run-time component. Information about a configuration type can include:
Type ID
Display name if one is assigned; otherwise null
Description if one is assigned; otherwise null
Content type of the data
Syntax
Command Central syntax:
sagcc list configuration types node_alias componentid [typeid] [options]
Platform Manager syntax:
sagcc list configuration types componentid [typeid] [options]
options:
[{--accept | -a} content_type]
[{--debug | -d}]
[{--error | -r} file]
[{--format | -f} {tsv args | text | 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. Required. Specifies the alias name of the installation in which the run-time component is installed. |
componentid | Required. Specifies the ID of the run-time component for which you want to list configuration types. |
[typeid] | Optional. Specifies the ID of the configuration type for which you want to retrieve information. If you do not specify a type ID, the command lists information for all configuration types for the run-time component identified by the componentid argument. |
[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. |
Usage Notes
Configuration types that have IDs that start with “COMMON-”, for example COMMON-PORTS, are common configuration types that multiple products share. Common configuration types have normalized schemas that work for all products. However, these schemas still allow product-specific extensions:
Having ExtendedProperties elements in the common schema XML files
Defining common schema elements as optional.
Each product maps a common schema to its specific use. To learn how a product supports common configuration types and how a product’s configuration type is mapped to a common schemas, use
sagcc get configuration data to retrieve the data returned for a specific product’s configuration instance. The structure of the configuration data can vary based on the run-time component, product that owns the run-time product, and in some cases also based on the specific instance of a configuration type.
Example When Executing on Command Central
To execute a command on the Command Central server with host name “rubicon” and port “8090” to list the configuration types for the run-time component that has the ID “OSGI-SPM” and is running in the installation with alias name “sag01”, using the authorization of the user with user name “Administrator” and password “manage”, and have the information returned to the output file “config_types” in XML format:
sagcc list configuration types sag01 OSGI-SPM --format xml
--output config_types --server http://rubicon:8090/cce
--username Administrator --password manage
Example When Executing on Platform Manager
To list the configuration types for the run-time component that has the ID “OSGI-SPM” and is 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 JavaScript Object Notation format:
sagcc list configuration types OSGI-SPM --format json --server
http://rubicon2:8092/spm --username Administrator --password manage