sagcc exec configuration validation update

Edit online

Validates the configuration instance data in the supplied input file to determine whether you can use it to update a specified configuration instance. If the input data is valid, you can then use sagcc delete configuration data to update the configuration instance.

Syntax

  • Command Central syntax: 
    sagcc exec configuration validation  node_alias componentid update instanceid             
{--input | -i} filename{.xml|.json|.properties} [options]
  • Platform Manager syntax: 
    sagcc exec configuration validation  componentid update instanceid             
{--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 update a configuration instance.

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

instanceid Required. Specifies the ID of the instance.

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


                              {--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

  • Use this command to determine whether data to update a configuration instance is valid. This command does not update the configuration instance. If the data in the input file is valid, you update the configuration instance using the data by executing sagcc delete configuration data command and supplying the validated input file.
  • The sagcc exec configuration validation update 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 delete configuration data command to update the configuration instance.
    • When the command outputs error messages, the input data is not valid. The sagcc delete configuration data command will fail if you use the data to attempt to update the configuration instance.

Example When Executing on Command Central

The data to update a COMMON-PORTS configuration type instance is in the c:\inputs\port_data.xml file. To validate the data for the configuration instance with ID “COMMON-PORTS-com.webmethods.sshd.pid.properties” for the run-time component with ID “OSGI-SPM”, which is installed in the installation with alias name “sag01” using the authorization of the user with user name “Administrator” and password “manage”: 

sagcc exec configuration validation sag01 OSGI-SPM update COMMON-PORTS-               
com.webmethods.sshd.pid.properties --input c:\inputs\port_data.xml             
--username Administrator --password manage

Because the {--server | -s} option is not specified, the command uses the default server. For more information, see server.

Example When Executing on Platform Manager

The data to update a COMMON-PORTS instance is in the c:\inputs\port_data.xml file. To validate the data for the configuration instance with ID “COMMON-PORTS-com.webmethods.sshd.pid.properties” 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 exec configuration validation OSGI-SPM update COMMON-PORTS-               
com.webmethods.sshd.pid.properties --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.