create-snapshot-policy¶

Description¶

Creates a snapshot policy.

Synopsis¶

  create-snapshot-policy
--cluster-crn <value>
--snapshot-policy-definition <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-crn (string)

CRN of the cluster where the snapshot policy will be created.

--snapshot-policy-definition (object)

Details of the snapshot policy to be created.

name -> (string)

The name of the snapshot policy.

type -> (string)

The snapshot type of snapshot policies.

snapshotRetentionCount -> (object)

Defines the number of snapshots to be retained for snapshot policies.

hourlySnapshots -> (integer)

The number of hourly snapshots to be retained.

dailySnapshots -> (integer)

The number of daily snapshots to be retained.

weeklySnapshots -> (integer)

The number of weekly snapshots to be retained.

monthlySnapshots -> (integer)

The number of monthly snapshots to be retained.

yearlySnapshots -> (integer)

The number of yearly snapshots to be retained.

schedule -> (object)

Defines the schedule of a snapshot policy.

minuteOfHour -> (integer)

Minute of the hour that hourly, daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 59.

hourOfDay -> (integer)

Hour of the day that daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 23.

dayOfWeek -> (integer)

Day of the week that weekly snapshots will be created. Valid values are 1 to 7, 1 representing Sunday.

dayOfMonth -> (integer)

Day of the month that monthly and yearly snapshots will be created. Valid values are 1 to 31. Additionally 0 to -30 can be used to specify offsets from the last day of the month.

monthOfYear -> (integer)

Month of the year that yearly snapshots will be created. Valid values are 1 to 12, 1 representing January.

hoursForHourly -> (array)

Hours of the day that hourly snapshots will be created. Valid values are 0 to 23. If this list is null or empty, then hourly snapshots are created for every hour.

item -> (integer)

hdfsArguments -> (object)

Arguments specific to HDFS snapshot policies.

pathPatterns -> (array)

The path patterns specifying the paths. Paths matching any of them will be eligible for snapshot creation. The pattern matching characters that can be specific are those supported by HDFS.

item -> (string)

hbaseArguments -> (object)

Arguments specific to HBase snapshot policies.

tableRegExps -> (array)

The regular expressions specifying the tables. Tables matching any of them will be eligible for snapshot creation.

item -> (string)

storage -> (string)

The location where the HBase shapshot is stored.

alert -> (object)

Alerting behaviour for snapshot policy activities. Defines whether an alert is sent on certain events related to snapshot policies.

onStart -> (boolean)

Whether to alert on start of snapshot creation/deletion activity.

onSuccess -> (boolean)

Whether to alert on successful completion of snapshot creation/deletion activity.

onFail -> (boolean)

Whether to alert on failure of snapshot creation/deletion activity.

onAbort -> (boolean)

Whether to alert on abort of snapshot creation/deletion activity.

paused -> (boolean)

Whether to pause the snapshot policy.

Shorthand Syntax:

name=string,type=string,snapshotRetentionCount={hourlySnapshots=integer,dailySnapshots=integer,weeklySnapshots=integer,monthlySnapshots=integer,yearlySnapshots=integer},schedule={minuteOfHour=integer,hourOfDay=integer,dayOfWeek=integer,dayOfMonth=integer,monthOfYear=integer,hoursForHourly=[integer,integer]},hdfsArguments={pathPatterns=[string,string]},hbaseArguments={tableRegExps=[string,string],storage=string},alert={onStart=boolean,onSuccess=boolean,onFail=boolean,onAbort=boolean},paused=boolean

JSON Syntax:

{
  "name": "string",
  "type": "HDFS"|"HBASE",
  "snapshotRetentionCount": {
    "hourlySnapshots": integer,
    "dailySnapshots": integer,
    "weeklySnapshots": integer,
    "monthlySnapshots": integer,
    "yearlySnapshots": integer
  },
  "schedule": {
    "minuteOfHour": integer,
    "hourOfDay": integer,
    "dayOfWeek": integer,
    "dayOfMonth": integer,
    "monthOfYear": integer,
    "hoursForHourly": [integer, ...]
  },
  "hdfsArguments": {
    "pathPatterns": ["string", ...]
  },
  "hbaseArguments": {
    "tableRegExps": ["string", ...],
    "storage": "LOCAL"|"REMOTE_S3"
  },
  "alert": {
    "onStart": true|false,
    "onSuccess": true|false,
    "onFail": true|false,
    "onAbort": true|false
  },
  "paused": true|false
}

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

clusterCrn -> (string)

The CRN of the cluster from where the snapshot policy has been created.

message -> (string)

The detailed description of the action taken.

status -> (string)

The status of the request.

Form Factors¶

public