list-policies¶

Description¶

Provides a list of all replication policies across all available clusters.

Synopsis¶

  list-policies
[--cluster-crn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-crn (string)

CRN of the cluster where the policies are stored.

--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¶

unreachableClusters -> (array)

List of errors for unreachable clusters.

item -> (object)

API error.

code -> (integer)

Error code.

message -> (string)

Error message.

status -> (string)

Error status.

clusterUrl -> (string)

Cluster URL.

requestId -> (string)

Request ID.

policyErrors -> (array)

List of policy errors.

item -> (object)

API error.

code -> (integer)

Error code.

message -> (string)

Error message.

status -> (string)

Error status.

clusterUrl -> (string)

Cluster URL.

requestId -> (string)

Request ID.

policies -> (array)

List of policies.

item -> (object)

Replication policy definition.

policyId -> (string)

Policy id.

name -> (string)

Policy name.

type -> (string)

Policy type.

status -> (string)

Current status of the policy.

frequency -> (integer)

Frequency in seconds when the policy runs.

endTime -> (datetime)

End time of policy run or when it repeats.

jobs -> (array)

List of policy runs.

item -> (object)

Policy execution details.

id -> (string)

Policy instance command id.

policyId -> (string)

Policy id.

status -> (string)

Policy command status.

startTime -> (datetime)

Command start time.

endTime -> (datetime)

Command end time.

trackingInfo -> (string)

JSON data to track polciy status.

message -> (string)

Output of the policy command.

jobType -> (string)

Job type.

totalSteps -> (integer)

Total number of steps.

completedSteps -> (integer)

Number of completed steps.

report -> (object)

Policy report.

lastSucceededInstance -> (object)

Policy report details.

status -> (string)

Status of the command.

endTime -> (datetime)

End time.

lastFailedInstance -> (object)

Policy report details.

status -> (string)

Status of the command.

endTime -> (datetime)

End time.

description -> (string)

Policy description.

executionType -> (string)

Policy execution type.

sourceDataset -> (array)

Source dataset of replication.

item -> (string)

targetDataset -> (array)

Target dataset of replication.

item -> (string)

creationTime -> (datetime)

Policy creation time.

startTime -> (datetime)

Policy start time.

sourceCluster -> (string)

Source cluster of replication.

sourceClusterCrn -> (string)

CRN of the source cluster.

targetCluster -> (string)

Target cluster of replication if not cloud.

targetClusterCrn -> (string)

CRN of the target cluster.

customProperties -> (map)

Custom replication properties.

key -> (string)

value -> (string)

plugins -> (array)

Plugins.

item -> (string)

nextRun -> (string)

Next expected run of the policy.

target -> (object)

Target details.

environmentCrn -> (string)

Target’s environment CRN.

warehouseCrn -> (string)

Target’s warehouse CRN.

cmPolicySubmitUser -> (object)

The user that the replication policy uses to perform operations on the source or target cluster.

userName -> (string)

Username.

sourceUser -> (string)

Source user.

Form Factors¶

public