webMethods Product Suite  | Complete Installation and Upgrade Information for Software AG Products | Command Central | Command Central Developer Reference | Using the Command Line Interface | Configuration Commands | sagcc get configuration data
 
sagcc get configuration data
Retrieves data for a specified configuration instance that belongs to a specified run-time component. For example, you might want to retrieve the data for an instance of a configured port. The retrieved data for an instance of a port might include whether the port is enabled, the port number, and the port’s protocol.
Syntax
*Command Central syntax:
sagcc get configuration data  node_alias componentid instanceid   
[sharedsecret=text_string] [options]
*Platform Manager syntax:
sagcc get configuration data componentid instanceid   
[sharedsecret=text_string] [options]
             
 options:               
[{--accept | -a} content_type]               
[{--debug | -d}]               
[{--error | -r} file]               
[{--format | -f} {text | xml | 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.
You can view a list of installations and their aliases using sagcc list landscape nodes.
componentid
Required. Specifies the ID of the run-time component for which you want to retrieve instance data.
You can determine the IDs for run-time components using sagcc list inventory components.
instanceid
Required. Specifies the ID of the instance for which you want to retrieve data.
You can determine the IDs for configuration instances using sagcc list configuration instances.
[sharedsecret=text_string]
Optional. Specify a shared secret password that Platform Manager uses to secure any passwords in the configuration data that you want to retrieve.
If you omit this parameter, Platform Manager retrieves the configuration data using the shared secret defined for the environment or for the whole landscape. For more information, see sagcc add security credentials sharedsecret. If Platform Manager cannot find a shared secret that matches the shared secret specified when creating the configuration instance, Platform Manager does not include the passwords that the configuration contains in the output.
When you omit this parameter:
*If the command is executed on Command Central, Platform Manager retrieves the configuration data using the shared secret defined for the environment or for the whole landscape. For more information, see sagcc add security credentials sharedsecret.
*If the command is executed on Platform Manager, Platform Manager does not include the passwords that the configuration contains in the output.
[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
*Use sagcc get configuration instances or sagcc list configuration instances if you want information about an instance, such as the instance ID, the display name for an instance, and the description for an instance, rather than the data for an instance.
*If you do not specify the {--format | -f} option, the default output format is based on from where you execute the command:
*If you execute the command from the command line, a batch script, or a shell script, the default format is plain text format.
*If you execute the command from an Ant script, the default format is XML format.
Example When Executing on Command Central
*To execute a command on the Command Central server with host name “rubicon” and port “8090” to retrieve instance data for the configuration instance with ID “COMMON-PORTS-com.softwareag.sshd.pid.properties” that belongs to the run-time component that has the ID “OSGI-SPM” and runs in the installation with alias name “sag01”, using the authorization of the user with user name “Administrator” and password “manage”, and have the information displayed on the console in XML format:
sagcc get configuration data sag01 OSGI-SPM COMMON-PORTS-              
com.softwareag.sshd.pid.properties --format xml            
--server http://rubicon:8090/cce --username Administrator            
--password manage
*To retrieve instance data for the configuration instance with ID “COMMON-PROXY” that belongs to the run-time component with ID “OSGI-SPM” and runs in the installation with alias name “sag01”, using “mysecret123” as the shared secret to secure the proxy configuration password, and save the configuration data with the encrypted password in the “configWithEncryptedData.xml” file:
sagcc get configuration data sag01 OSGI-SPM COMMON-PROXY   
sharedsecret=mysecret123  --output     
configWithEncryptedData.xml
Example When Executing on Platform Manager
To retrieve instance data for the configuration instance with ID “COMMON-PORTS-com.softwareag.sshd.pid.properties” that belongs to the run-time component that has the ID “OSGI-SPM” and is managed by the Platform Manager with host name “rubicon2” and port “8092”, and have the information returned to the output file “port_data” in XML format:
sagcc get configuration data OSGI-SPM COMMON-PORTS-              
com.softwareag.sshd.pid.properties --output port_data --format xml            
--server http://rubicon2:8092/spm
Because the {--username | -u} and {--password | -p} options are not specified, the command uses the default user name and password. For more information, see username and password.
Copyright © 2007-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.