sagcc create configuration data

Edit online

Creates a new instance of a configuration type for a specified run-time component. For example, if you are configuring a new port for an Integration Server, you can use this command to supply the data for the configuration type COMMON-PORTS and create a new COMMON-PORTS instance.

Syntax

  • Command Central syntax: 
    sagcc create configuration data  node_alias componentid typeid    
[sharedsecret=text_string]            
{--input | -i} file{.xml|.json|.properties}  [options]
  • Platform Manager syntax: 
    sagcc create configuration data  componentid  typeid    
[sharedsecret=text_string]             
{--input | -i} file{.xml|.json|.properties}  [options]
              
 options:                
[{--debug | -d}]                
[{--error | -r} file]                
[{--log | -l} file]                
[{--input-format | -m} content-type]                
[{--password | -p} password]                
[{--quiet | -q}]                
[{--server | -s} url]
[{--sync-job | -j}]               
[{--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 create a new instance of a configuration type.

You can determine the IDs for run-time components using sagcc list inventory components.

typeid Required. Specifies the ID of the configuration type that identifies the type of instance you want to create.

You can determine the IDs for configuration types using sagcc list configuration types.

For information about the supported configuration types for a run-time component, see information in this reference for the product with which the run-time component is associated.

[sharedsecret=text_string] Optional. Specify a shared secret password that Platform Manager uses to secure any passwords in the configuration data.

If you omit this parameter, Platform Manager uses the shared secret defined for the whole landscape. For more information, see sagcc add security credentials sharedsecret.


                              {--input | -i} file{.xml|
                               .json|.properties}
                          
Required. Identifies an input file that contains the configuration data. For more information, see input.
Note: Some of the COMMON-* configuration types do not support all input file types (.xml, .json, or .properties) when creating a configuration instance. Although not specifically supported, if you use plain text, the server attempts to convert the data into a supported format.
[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

  • Not all run-time components support the sagcc create configuration data command. For information about whether a run-time component supports a command, see Administering IBM webMethods Products Using Command Central .
  • To determine how to specify the data in the input file, use sagcc get configuration data to retrieve data for the same type of configuration instance you are creating. For example, if you want to use an XML file to specify the data to create an instance of a COMMON-PORTS configuration type, use sagcc get configuration data with the --format xml option to retrieve the data for an existing COMMON-PORTS instance in XML format.
  • The data in the input file must match the expected schema for the configuration type. You can use sagcc exec configuration validation create to validate input data that you want to use to update the configuration instance.
  • You can retrieve schemas for common configuration types from a Platform Manager server and use the schemas to validate an XML input data file. To access the schemas, navigate to:

    http(s)://hostname:port/spm/configuration/common/

    Where hostname is the host name of the required Platform Manager server and port is the port number of the Platform Manager installation.

    For example, to retrieve the log4j schema from a Platform Manager with host name “rubicon2” and port “8092”, navigate to:

    https://rubicon:8092/spm/configuration/common/log4j.xsd

    You can also use the sagcc get configuration common command to retrieve schemas for common configuration types.

  • You can export a configuration from an installed product instance, managed by Command Central and use the exported configuration data in the input file. For more information, see Adding Configurations Exported from an Installed Product Instance to an Input File.
  • For information about the return statuses of the command, see Return Statuses from Executing Configuration Commands.
  • The output from the sagcc create configuration data command includes:
    • Instance ID of the new configuration instance
    • Display name of the new instance
    • Description of the new configuration instance
    • ID of the associated configuration type
    • ID of the run-time component
    • URL of a physical configuration file if the data for the configuration instance is stored in a configuration file

Example When Executing on Command Central

  • The data to create a new instance of the COMMON-PORTS configuration type is in the c:\inputs\port_data.xml file. To create the new configuration instance for the run-time component with the ID “OSGI-SPM” that is installed in the installation with alias name “sag01”: 

    sagcc create configuration data sag01 OSGI-SPM COMMON-PORTS    
--input  c:\inputs\port_data.xml --password secret

  • The data to create a new instance of the COMMON-PROXY configuration type is in the c:\inputs\proxy_data.xml file. To create the new configuration instance for the run-time component with the ID “OSGI-SPM” that is installed in the installation with alias name “sag01” and use “mysecret123” as the shared secret to secure the proxy configuration password: 

    sagcc create configuration data sag01 OSGI-SPM COMMON-PROXY    
sharedsecret=mysecret123  --input      
c:\inputs\proxy_data.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

The data to create a new instance of the COMMON-PORTS configuration type is in the c:\inputs\port_data.xml file. To create the new configuration instance 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”: 

sagcc create configuration data OSGI-SPM COMMON-PORTS --input               
c:\inputs\port_data.xml --server http://rubicon2:8092/spm             
--password secret

Because the {--username | -u} option is not specified, the command uses the default user name. For more information, see username. The command specifies “secret” for the user’s password.