define_domain_config

The define_domain_config_file command specifies an optional comment string to be included in the header of a domain configuration file. If you are creating a domain configuration file using a text editor, this comment string must be the first record in the file.

Supplied Parameters

Parameter name              Type        Length  Default
[define_domain_config_file]
comment                     character   100     (null string)

The supplied parameter is:

comment: An optional comment string containing information about the file. SNAplus2 uses the string for information only. It is stored in the node's configuration file and returned on the query_domain_config_file command.

Returned Parameters

No parameters are returned by SNAplus2 when this command executes successfully.

Error Return Codes

If the command cannot be executed, SNAplus2 returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.

Parameter Check

No parameter errors occur for this command.

State Check

No specific state errors, other than those listed in Appendix A “Common Return Codes from snapadmin Commands” occur for this command.

Other Conditions

Appendix A “Common Return Codes from snapadmin Commands” lists combinations of primary and secondary return codes that are common to all commands.

define_domain_config_file

Technical documentation

» Table of Contents