From a38ffa18f71e48d0e42c63c8f2af20002e69c9a0 Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Fri, 4 May 2018 11:21:20 -0400 Subject: [PATCH] Auditlog table doc improvement --- .../admin-guides/references/man5/auditlog.5.rst | 4 ++-- .../guides/admin-guides/references/man5/site.5.rst | 5 ++--- .../admin-guides/references/man7/auditlog.7.rst | 4 ++-- perl-xCAT/xCAT/Schema.pm | 12 ++++++------ 4 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man5/auditlog.5.rst b/docs/source/guides/admin-guides/references/man5/auditlog.5.rst index d177660f8..a89b681aa 100644 --- a/docs/source/guides/admin-guides/references/man5/auditlog.5.rst +++ b/docs/source/guides/admin-guides/references/man5/auditlog.5.rst @@ -62,13 +62,13 @@ auditlog Attributes: \ **clienttype**\ - Type of command: cli,java,webui,other. + Type of command: cli, java, webui, other. \ **command**\ - Command executed. + Command executed. See auditskipcmds site table attribute to control which commands get logged. diff --git a/docs/source/guides/admin-guides/references/man5/site.5.rst b/docs/source/guides/admin-guides/references/man5/site.5.rst index ed5180374..b43e6a12f 100644 --- a/docs/source/guides/admin-guides/references/man5/site.5.rst +++ b/docs/source/guides/admin-guides/references/man5/site.5.rst @@ -60,7 +60,7 @@ site Attributes: DATABASE ATTRIBUTES ----------------- auditnosyslog: If set to 1, then commands will only be written to the auditlog table. - This attribute set to 1 and auditskipcmds=ALL means no logging of commands. + If this attribute is set to 1 and auditskipcmds=ALL means no logging of commands. Default is to write to both the auditlog table and syslog. auditskipcmds: List of commands and/or client types that will not be written to the auditlog table and syslog. See auditnosyslog. @@ -68,8 +68,7 @@ site Attributes: commands will be written. clienttype:web would skip all commands from the web client For example: tabdump,nodels,clienttype:web - will not log tabdump,nodels and any web client commands. - + will not log tabdump, nodels or any web client commands. databaseloc: Directory where we create the db instance directory. Default is /var/lib. Only DB2 is currently supported. Do not use the directory in the site.installloc or diff --git a/docs/source/guides/admin-guides/references/man7/auditlog.7.rst b/docs/source/guides/admin-guides/references/man7/auditlog.7.rst index 16d26347f..e6e270384 100644 --- a/docs/source/guides/admin-guides/references/man7/auditlog.7.rst +++ b/docs/source/guides/admin-guides/references/man7/auditlog.7.rst @@ -59,13 +59,13 @@ auditlog Attributes: \ **clienttype**\ (auditlog.clienttype) - Type of command: cli,java,webui,other. + Type of command: cli, java, webui, other. \ **command**\ (auditlog.command) - Command executed. + Command executed. See auditskipcmds site table attribute to control which commands get logged. diff --git a/perl-xCAT/xCAT/Schema.pm b/perl-xCAT/xCAT/Schema.pm index e16dba65b..3c1fe110f 100755 --- a/perl-xCAT/xCAT/Schema.pm +++ b/perl-xCAT/xCAT/Schema.pm @@ -998,15 +998,15 @@ passed as argument rather than by table value', "DATABASE ATTRIBUTES\n" . " -----------------\n" . " auditnosyslog: If set to 1, then commands will only be written to the auditlog table.\n" . -" This attribute set to 1 and auditskipcmds=ALL means no logging of commands.\n" . +" If this attribute is set to 1 and auditskipcmds=ALL means no logging of commands.\n" . " Default is to write to both the auditlog table and syslog.\n" . " auditskipcmds: List of commands and/or client types that will not be\n" . " written to the auditlog table and syslog. See auditnosyslog.\n" . " 'ALL' means all cmds will be skipped. If attribute is null, all\n" . - " commands will be written.\n" . +" commands will be written.\n" . " clienttype:web would skip all commands from the web client\n" . - " For example: tabdump,nodels,clienttype:web \n" . -" will not log tabdump,nodels and any web client commands.\n\n" . +" For example: tabdump,nodels,clienttype:web \n" . +" will not log tabdump, nodels or any web client commands.\n" . " databaseloc: Directory where we create the db instance directory.\n" . " Default is /var/lib. Only DB2 is currently supported.\n" . " Do not use the directory in the site.installloc or\n" . @@ -1450,8 +1450,8 @@ passed as argument rather than by table value', audittime => 'The timestamp for the audit entry.', userid => 'The user running the command.', clientname => 'The client machine, where the command originated.', - clienttype => 'Type of command: cli,java,webui,other.', - command => 'Command executed.', + clienttype => 'Type of command: cli, java, webui, other.', + command => 'Command executed. See auditskipcmds site table attribute to control which commands get logged.', noderange => 'The noderange on which the command was run.', args => 'The command argument list.', status => 'Allowed or Denied.',