create hypervault_policy general
Function
The create hypervault_policy general command is used to create a HyperVault policy.
Format
create hypervault_policy general hypervault_id=? name=? type=? period=? [ days_of_week=? ] [ days_of_month=? ] [ interval_day=? ] [ frequency_hour=? ] [ frequency_minute=? ] [ start_time=? ] [ policy_status=? | copy_threshold=? ]
Parameters
Parameter |
Description |
Value |
|---|---|---|
hypervault_id=? |
ID of the HyperVault object. |
To obtain the value, run "show hypervault general" without parameters. |
name=? |
Name of the HyperVault policy. |
The value consists of 1 and 127 ASCII characters including digits, letters, underscores (_), hyphens (-), and periods (.). |
type=? |
Type of the HyperVault policy. |
The value is "local" or "remote", where:
|
period=? |
Indicates the policy of a schedule. |
The value can be "daily", "weekly" or "monthly" , where,
|
days_of_week=? |
Days of a week. |
The value can be any day or days from Monday to Sunday. This parameter can be specified when "period" is set to "weekly".
The value is set to all seven days of a week by default. |
days_of_month=? |
Days of a month. |
This parameter can be specified when "period" is set to "monthly". The value can be any day or days in a month. Number 1 to 31 indicates the corresponding 31 days in a month. The value is set to the 31 days of a month by default. |
interval_day=? |
Interval of days. |
This parameter can be specified when "period" is set to "daily". The value is the number of days the interval lasts and ranges between "1" and "7". The default value is "1". |
frequency_hour=? |
Interval of hours. |
The value is an integer between 0 and 23. |
frequency_minute=? |
Interval of five minutes. |
The value is an integer between 0 and 55. |
start_time=? |
Policy execution time. |
The value is a time between "00:00" and 23:59" in the format of "HH:MM". |
copy_threshold=? |
Maximum threshold of copy count. |
The value indicates the maximum number of copies and ranges between "3" and "256". When "type" is set to "local", the default value is "5". When "policy_type" is set to "remote", the default value is "35". |
policy_status=? |
Policy status. |
The value is "on" or "off", where:
The default value is "on". |
Level
Administrator
Usage Guidelines
None
Example
Create a policy for HyperVault "43435345" which will be implemented every Sunday on 22:00.
admin:/> create hypervault_policy general hypervault_id=43435345 name=weekly type=local period=weekly days_of_week=sun start_time=22:00
Command executed successfully.
System Response
None
Previous
