Skip to main content
Skip table of contents

HCMS CLI for managing shared filesystems

For now, "shared filesystem" means an AWS hosted filesystem. One shared filesystem equals to one S3 bucket.

Similarly to the auth command, shared-filesystem always operates on a single configuration. It means that CRUD commands apply to one configuration even if the bucket is used by multiple ones (which is not recommended anyway).

View command

Command

Argument

Meaning

hcms shared-filesystem list

configuration key

Lists all shared filesystems configured for a given configuration group.

Example output:

CODE
  - bucket: censhare-qa-us-east-1
    region: us-east-1
    access_key: AKIAIM5ZU5PHFRED5A53A
    secret_key: 4luieGchwNX88zrur1wnFyda5322fsdh1wfhUk+
    name: assets
    streaming: true

If there is no shared filesystem configured, the list command returns an empty array, like this:

CODE
[]

CRUD operations

Shared filesystems can be configured as part of the hcms configuration create command. You can also add new ones later, using the commands provided below.

Command

1st Argument

2nd Argument

Meaning

hcms shared-filesystem create

HCMS configuration id

Name of the shared filesystem

Defines a new shared filesystem for the specified configuration. Should be the same as the file system ID in the Censhare Server master data and in the Filesystem configuration.

hcms shared-filesystem update

HCMS configuration id

Name of the shared filesystem

Updates the specified attributes of the specified shared filesystem.

hcms shared-filesystem delete

HCMS configuration id

Name of the shared filesystem

Deletes the specified attributes of a shared filesystem (or its entire configuration, if no option is specified).

The following options can be provided for any of the CRUD commands. When not provided, won‘t be changed, or deleted, or created.

Option

Default option value

Meaning

--s3bucket

-

ID of the AWS bucket. Mandatory for creating a new shared filesystem.

--s3region

eu-central-1

AWS region

--s3accessKey

-

An access key with permissions to use (read, write) the bucket; optional if both the satellite and the Censhare Server are on the same EC2 infrastructure with permissions provided via AWS roles.

--s3secretKey

-

A secret key (password) with permissions to use (read, write) the bucket. Required if and only if the -s3accessKey has been specified.

--mode

greedy

Synchronization mode. Can be greedy or lazy.

--streaming

true

Enables or disables direct streaming from the S3 storage, without intermediate cache on the local filesystem.

Note The default mode option - which is also a global default - can be changed in the XML representation of the configuration asset.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.