HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
SET_LOG_FILE
Name of the new log file.
To create the file in the default directory for diagnostics files, /var/opt/sna, specify the file name with
no path. To create the file in a different directory, specify either a full path or the path relative to the default
directory. If you include the path, ensure that it is a valid path (either relative to the application’s working
directory or a full path) on any computer to which this verb is issued.
This parameter is an ASCII string of 1–80 characters, followed by a NULL character (binary zero). To
continue logging to the file specified on a previous SET_LOG_FILE verb, specify a null string.
backup_file_name
Name of the backup log file. When the log file reaches the size specified by file_size below, SNAplus2 copies
the current contents to the backup file and then clears the log file. You can also request a backup at any time
using the action parameter above.
To create the file in the default directory for diagnostics files, /var/opt/sna, specify the file name with
no path. To create the file in a different directory, specify either a full path or the path relative to the default
directory. If you include the path, ensure that it is a valid path (either relative to the application’s working
directory or a full path) on any computer to which this verb is issued.
This parameter is an ASCII string of 1–80 characters, followed by a NULL character (binary zero). To
continue using the backup file specified on a previous SET_LOG_FILE verb, specify a null string.
file_size
The maximum size of the log file specified by log_file_type. When a message written to the file causes the
file size to exceed this limit, SNAplus2 copies the current contents of the log file to the backup log file and
clears the log file. This means that the maximum amount of disk space taken up by log files is approximately
twice file_size.
To continue using the file size specified on a previous SET_LOG_FILE verb, set this parameter to zero. The
initial default value, before any SET_LOG_FILE verb has been issued, is 1,000,000 bytes. A value of zero
indicates “continue using the existing file size” and not “no limit”.
You may need to increase the size of the audit and error log files according to the size of the SNAplus2
client-server network, to allow for the volume of log information generated in larger systems. In particular,
consider increasing the log file size to allow for the following:
• Large numbers of clients or users (since a single communications link failure may result in large numbers
of logs on the server relating to session failures)
• Activating audit logging as well as exception logging
• Using central logging instead of distributed logging
• Using full logging instead of succinct logging.
3.179.3 Returned Parameters: Successful Execution
If the verb executes successfully, SNAplus2 returns the following parameters:
primary_rc
AP_OK
secondary_rc
Not used.
3.179.4 Returned Parameters: Parameter Check
If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters:
primary_rc
719