sagcc exec configuration validation create

Edit online

Validates the configuration instance data in the supplied input file. If the input data is valid, you can then use sagcc create configuration data to create a configuration instance.

Syntax

  • Command Central syntax: 
    sagcc exec configuration validation  node_alias componentid create typeid             
{--input | -i} filename{.xml|.json|.properties}  [options]
  • Platform Manager syntax: 
    sagcc exec configuration validation  componentid create typeid             
{--input | -i} filename{.xml|.json|.properties}  [options]
              
 options:                
[{--debug | -d}]                
[{--error | -r} file]                
[{--log | -l} 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 validate instance data that you might want to use to create a new 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 data you want to validate.

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.


                              {--input | -i}
                              
                                
                                     filename{.xml| .json|.properties}
                          
Required. Identifies an input file that contains the configuration data to validate. For more information, see input.
Note: Based on the type of configuration data you are attempting to validate, all file types (.xml, .json, and .properties) might not be supported. Although not specifically supported, if you use plain text, the server attempts to convert the data into a supported format.
Tip: 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 want to validate. For example, if you want to use an XML file for configuration data for 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.
[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 exec configuration validation create command. For information about whether a run-time component supports a command, see information in this reference for the product with which the run-time component is associated.
  • Use this command to determine whether data for a new configuration instance is valid. This command does not create a new configuration instance. If the data in the input file is valid, you create a new configuration instance using the data by executing sagcc create configuration data command and supplying the validated input file.
  • The sagcc exec configuration validation create command outputs either no messages or informational, warning, and/or error messages.
    • When the command outputs no messages or only informational and warning messages, the input data is valid. You can use the data with the sagcc create configuration data command to create a configuration instance.
    • When the command outputs error messages, the input data is not valid. The sagcc create configuration data command will fail if you use the data to attempt to create a configuration instance.

Example When Executing on Command Central

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

sagcc exec configuration validation sag01 OSGI-SPM create COMMON-PORTS             
--input c:\inputs\port_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 for a COMMON-PORTS configuration type instance is in the c:\inputs\port_data.xml file. To validate the instance data for the run-time component with the ID “OSGI-SPM” and is managed by the Platform Manager with host name “rubicon2” and port “8092”: 

sagcc exec configuration validation OSGI-SPM create 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.