vserver object-store-server audit modify

Modify 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 modify command modifies an audit configuration for a Vserver.

Parameters

-vserver <vserver name> - Vserver
This parameter specifies the name of the Vserver for which the audit configuration is to be modified. The Vserver audit configuration must already exist.

If you have configured time-based rotation, modifying one parameter of time-based rotation schedule does not affect the other parameters. For example, if the rotation schedule is set to run at Monday 12:30 a.m., and you modify the -rotate-schedule-dayofweek parameter to Monday,Wednesday,Friday, the new rotation-schedule rotates the audit logs on Monday, Wednesday, and Friday at 12:30 a.m. To clear time-based rotation parameters, you must explicitly set that portion to "-". Some time-based parameters can also be set to "all".

[-destination <text>] - Log Destination Path
This parameter specifies the audit log destination path where consolidated audit logs are stored. If the path is not valid, the command fails. The path can be up to 864 characters in length and must have read-write permissions.
[-events {data|management}, ...] - Categories of Events to Audit
This parameter specifies the categories of events to be audited. Supported event categories are: data and management events. The corresponding parameter values are: data, management. By default, data events are enabled
[-format <json>] - Log Format
This parameter specifies the output format of the audit logs. By default, the output format is JSON.
[-rotate-size {<size>|-}] - Log File Size Limit
This parameter specifies the audit log file size limit. By default, the audit log is rotated based on size. The default audit log size is 100 MB.
[-rotate-schedule-month <cron_month>, ...] - Log Rotation Schedule: Month
This parameter specifies the monthly schedule for rotating the audit log. For example, you can specify that the audit log is to be rotated during the months January, March, and August, or during all the months. Valid values are January, February, March, April, May, June, July, August, September, October, November, December, and all. Specify "all" to rotate the audit logs every month.
[-rotate-schedule-dayofweek <cron_dayofweek>, ...] - Log Rotation Schedule: Day of Week
This parameter specifies the daily (day of the week) schedule for rotating the audit log. For example, you can specify that the audit log is to be rotated on Tuesdays and Fridays, or during all the days of a week. Valid values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and all. Specify "all" to rotate the audit logs every day.
[-rotate-schedule-day <cron_dayofmonth>, ...] - Log Rotation Schedule: Day
This parameter specifies the day of the month schedule for rotating the audit log. For example, you can specify that the audit log is to be rotated on the 10th and 20th days of a month, or all days of a month. Valid values range from 1 to 31.
[-rotate-schedule-hour <cron_hour>, ...] - Log Rotation Schedule: Hour
This parameter specifies the hourly schedule for rotating the audit log. For example, you can specify that the audit log is to be rotated at 6 a.m and 10 a.m. Valid values range from 0 (midnight) to 23 (11:00 p.m.). Specify "all" to rotate the audit logs every hour.
[-rotate-schedule-minute <cron_minute>, ...] - Log Rotation Schedule: Minute
This parameter specifies the minute schedule for rotating the audit log. For example, you can specify that the audit log is to be rotated at the 30th minute. Valid values range from 0 to 59.
{ [-rotate-limit <integer>] - Log Files Rotation Limit
This parameter specifies the audit log files rotation limit. A value of 0 indicates that all the log files are retained. The default value is 0.
| [-retention-duration <[<integer>d][<integer>h][<integer>m][<integer>s]>]} - Log Retention Duration
This parameter specifies the audit log files retention duration. A value of 0s indicates that all the log files are retained. For example, if you enter a value of 5d0h0m0s, logs more than 5 days old are deleted.

Examples

The following example modifies the rotate-size and rotate-limit field for Vserver vs1.
cluster1::> vserver object-store-server audit modify -vserver vs1 -rotate-size 10MB -rotate-limit 3

The following example modifies an audit configuration for Vserver vs1 using the time-based rotation method. The audit logs are rotated monthly, all days of the week, at 12:30.

cluster1::> vserver object-store-server audit modify -vserver vs1 -destination /audit_log -rotate-schedule-month all -rotate-schedule-dayofweek all -rotate-schedule-hour 12 -rotate-schedule-minute 30

The following example modifies an audit configuration for Vserver vs1 for auditing object store data events in the output log format Json.

cluster1::> vserver object-store-server audit modify -vserver vs1 -format json -events data