Skip to main content

vserver object-store-server audit show

Contributors
Suggest changes
PDFs

Display the audit configuration

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver object-store-server audit show command displays object store audit configuration information about Vservers. The command output depends on the parameter or parameters specified with the command. If you do not specify any parameters, the command displays the following information about all the Vservers:

  • Vserver name

  • Audit state

  • Target directory

You can specify the -fields parameter to specify which audit configuration information to display about Vservers. + You can specify additional parameters to display only information that matches those parameters. For instance, to display information about the log file rotation size of a Vserver whose value matches 10 MB, run the command with the -rotate-size 10MB parameter.

You can specify the -instance parameter to display audit configuration information for all Vservers in list form.

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command only displays the fields that you specify.

| [-log-save-details ]

You can specify the -log-save-details parameter to display the following information about all the Vservers:

  • Vserver name

  • Rotation file size

  • Rotation schedules

  • Rotation limit

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all entries.

[-vserver <vserver name>] - Vserver

If you specify this parameter, the command displays information about the specified Vserver.

[-state {true|false}] - Auditing State

If you specify this parameter, the command displays information about the Vservers that use the specified audit state value.

[-destination <text>] - Log Destination Path

If you specify this parameter, the command displays information about the Vservers that use the specified destination path.

[-events {data|management}] - Categories of Events to Audit

If you specify this parameter, the command displays information about the Vservers that use the specified category of events that are audited. Valid values are file-ops , cifs-logon-logoff , cap-staging , file-share , audit-policy-change , user-account , security-group and authorization-policy-change . audit-policy-change will appear only in diag mode.

[-format <json>] - Log Format

If you specify this parameter, the command displays information about the Vservers that use the specified log format.

[-rotate-size {<size>|-}] - Log File Size Limit

If you specify this parameter, the command displays information about the Vservers that use the specified log file rotation size.

[-rotate-schedule-month <cron_month>,…​] - Log Rotation Schedule: Month

If you specify this parameter, the command displays information about the Vservers that use the specified month of the time-based log rotation scheme. Valid values are January, February, March, April, May, June, July, August, September, October, November, and December.

[-rotate-schedule-dayofweek <cron_dayofweek>,…​] - Log Rotation Schedule: Day of Week

If you specify this parameter, the command displays information about the Vservers that use the specified day of the week of the time-based log rotation scheme. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

[-rotate-schedule-day <cron_dayofmonth>,…​] - Log Rotation Schedule: Day

If you specify this parameter, the command displays information about the Vservers that use the specified day of the month of the time-based log rotation scheme. Valid values range from 1 to 31.

[-rotate-schedule-hour <cron_hour>,…​] - Log Rotation Schedule: Hour

If you specify this parameter, the command displays information about the Vservers that use the specified hour of the time-based log rotation scheme. Valid values range from 0 (midnight) to 23 (11:00 p.m.).

[-rotate-schedule-minute <cron_minute>,…​] - Log Rotation Schedule: Minute

If you specify this parameter, the command displays information about the Vservers that use the specified minute of the time-based log rotation scheme. Valid values range from 0 to 59.

[-rotate-schedule-description <text>] - Rotation Schedules

If you specify this parameter, the command displays information about the Vservers that use the specified rotation schedules. This field is derived from the rotate-time fields.

[-rotate-limit <integer>] - Log Files Rotation Limit

If you specify this parameter, the command displays information about the Vservers that use the specified rotation limit value.

[-retention-duration <[<integer>d][<integer>h][<integer>m][<integer>s]>] - Log Retention Duration

If you specify this parameter, the command displays information about the Vservers audit logs retention duration.

Examples

The following example displays the name, audit state, event types, log format, and target directory for all Vservers.

cluster1::> vserver object-store-server audit show
Vserver     State  Event Types Log Format Target Directory
 ----------- ------ ----------- ---------- --------------------
 vs1         false  data        json       /audit_log

The following example displays the Vserver names and details about the audit log for all Vservers.

cluster1::> vserver object-store-server audit show -log-save-details
Rotation                           Rotation
 Vserver     File Size Rotation Schedule        Limit
 ----------- --------- ------------------------ --------
 vs1         100MB     -                        0

The following example displays in list form all audit configuration information about all Vservers.

cluster1::> vserver object-store-server audit show -instance
Vserver: vs1
                      Auditing state: true
                Log Destination Path: /audit_log
       Categories of Events to Audit: data
                          Log Format: json
                 Log File Size Limit: 100MB
        Log Rotation Schedule: Month: -
  Log Rotation Schedule: Day of Week: -
          Log Rotation Schedule: Day: -
         Log Rotation Schedule: Hour: -
       Log Rotation Schedule: Minute: -
                  Rotation Schedules: -
            Log Files Rotation Limit: 0
                  Log Retention Time: 0s