och-instance update

Updates a copier.

The following fields can be updated for a copier:
  • Node FQDN
  • SQS listener
  • SQS queue related details
  • SQS credentials
  • Multipart-related parameters
  • Destination CA path, credentials
  • Source credentials
  • Source role ARN
  • Destination credentials
  • bucket mapping rules file

Syntax:

maprcli och-instance update
                 -name copier name
                [ -node FQDN of the OCH service node; auto-assigned via load balancing across active OCH nodes if omitted ]
                [ -sticky pin this copier to -node and exclude it from automatic load rebalancing. default: false. default: false ]
                 -isSQSListener true if using SQS listener, false if using Kafka. default: false
                [ -enableMultipart true to enable multipart copy for large objects. default: false. default: false ]
                [ -multipartThreshold minimum object size in bytes to trigger multipart copy. default: 524288000 (500MB) ]
                [ -multipartSize size of each part in bytes during multipart copy. default: 104857600 (100MB) ]
                [ -multipartConcurrency number of concurrent part uploads. default: 10 ]
                [ -isAuditEnabled true to record one audit entry per copy attempt made by this copier, under /var/mapr/local/mapr.och.audit. default: false. default: false ]
                [ -sqsQueueUrl SQS queue URL, e.g. https://sqs.us-east-1.amazonaws.com/123456789/queue-name ]
                [ -sqsAwsRegion AWS region for SQS, e.g. us-east-1 ]
                [ -sqsAwsAccessKey AWS access key ID for SQS access ]
                [ -sqsAwsSecretKey AWS secret access key for SQS access ]
                [ -sqsAwsSessionToken AWS STS session token for SQS access; required when -sqsAwsAccessKey/-sqsAwsSecretKey are temporary credentials ]
                [ -sqsRoleArn IAM role ARN to assume for SQS access ]
                [ -kafkaTopics comma-separated Kafka topic list, e.g. /var/objstore/event-stream:event-topic ]
                [ -srcIsAWS true if source is AWS S3, false if source is DataFabric. default: false ]
                [ -srcAwsRegion AWS region for source S3 bucket ]
                [ -srcAwsAccessKey AWS access key ID for source S3 access ]
                [ -srcAwsSecretKey AWS secret access key for source S3 access ]
                [ -srcAwsSessionToken AWS STS session token for source S3 access; required when -srcAwsAccessKey/-srcAwsSecretKey are temporary credentials ]
                [ -srcRoleArn IAM role ARN to assume for source S3 access ]
                [ -srcAccessKey DataFabric access key for source ]
                [ -srcSecretKey DataFabric secret key for source ]
                [ -srcEndpoint source DataFabric endpoint, e.g. https://hostname:9000 ]
                [ -srcChainCA path to CA certificate chain file for source endpoint, or the PEM chain itself with -isContentInline true ]
                [ -dstAccessKey DataFabric access key for destination ]
                [ -dstSecretKey DataFabric secret key for destination ]
                [ -dstEndpoint destination DataFabric endpoint, e.g. https://hostname:9000 ]
                [ -dstChainCA path to CA certificate chain file for destination endpoint, or the PEM chain itself with -isContentInline true ]
                [ -bucketMap comma-separated <sourceBucket>:<destBucket>[:<rules>] entries, e.g. src1:dst1,src2:dst2:/path/rules2.json; <rules> is a file path unless -isContentInline true, when it is the rules JSON itself ]

REST

Request Type POST
Request URL
http[s]://<host>:<port>/rest/och-instance/update?<parameters>

Example

Example 1: Update destination fabric endpoint and credentials for copier 'ochtest106'.

CLI
maprcli och-instance update -name ochinst3 -bucketMap srcbkt1:destbkt3,srcbkt2:destbkt3 -json
{
"timestamp":1790210701408,
"timeofday":"2026-09-24 12:45:01.408 GMT+0000 AM",
"status":"OK",
"total":1,
"data":[
{
"name":"ochinst3",
"message":"Successfully updated och-instance 'ochinst3'"
}
]
}

REST

curl -u <username> -X POST https://server.sj.us:8443/rest/och-instance/update?name="ochinst3"&bucketMap="srcbkt1:destbkt3,srcbkt2:destbkt3"