Novell Doc: Dynamic File Services 2.2 Client Commands and Utilities Reference - Cloud Actions

3.12 Cloud Actions

-cloud

Performs operations on a cloud provider account. When it is used without other cloud action options, all cloud accounts on the server are listed.

Syntax

DswCli.exe -cloud
         [-add | -modify | -delete | -detail] 
         [-cloudId]
         [cloud_options]
         [authentication_parameters]

For information about how to provide the servername and login credentials that are needed to connect to the server that you want to manage, see Section 3.3, Authentication Parameters.

3.12.1 Cloud Parameters

This section describes the following common cloud parameters:

-description

Specifies a textual description of the cloud account. The description is optional.

Syntax

-description=<"text">

Example

-description="John Doe's Dropbox account"

-cloudId

Specifies the cloud account identifier. You can provide the cloud account name, or provide the GUID of the cloud account. A GUID is automatically assigned by Dynamic File Services when you add a cloud account.

Syntax

-cloudId=<"cloud_account_name"|"GUID">

Examples

-cloudId="dropbox1"
-cloudId="cloudme1"
-cloudId="box1"
-cloudID="amazons3tom"

-name

Specifies a friendly local name for the cloud account. The name must be unique on the server you are managing. It can be different than the login name for the cloud account.

Syntax

-name=<"cloud_account_name">

Example

-name=dropbox1
-name=cloudme1
-name=dropboxusers

3.12.2 Add a Cloud Account

-add

The -add action creates a cloud account with the specified name and stores the configuration in the XML file in the C:\ProgramData\Dynamic File Services\Clouds folder.

Syntax

DswCli.exe -cloud
         -add 
         -name=<"cloud_account_name"> 
         [-description=<"text">] 
         -cloudProvider=<"provider"> 
         [-cloudAccountName=<"acc_login_name"> 
            -cloudAccountPwd=<"acc_pwd">
            ] ;Use for CloudMe(TM)
         [-cloudAccountAppKey=<"app_key"> 
            -cloudAccountAppSecret=<"app_secret"> 
            [-cloudAccoutBucket=<"bucket">]
            [-folderPath=<"folder_path">]  
            ] ;Use for Amazon S3(TM)
         [-cloudAccountAppKey=<"app_key"> 
            -cloudAccountAppSecret=<"app_secret"> 
            [-phase1 | -phase2]
            ] ;Use for DropBox(TM)
         [-cloudPath=<"/cloud_path">] 
         [authentication_parameters]

After you add a cloud account, you can use a path on its cloud storage as the secondary path in a retention pair. For information, see Add a Pair.

Add Cloud Account Parameters

-cloudProvider

Specifies the Dynamic File Services code name for your cloud provider.

Syntax

-cloudProvider=<dropbox|cloudme|amazons3>

You can use the -cloudProviders command to get a complete list of the cloud providers that are supported by Dynamic File Services.

Example

-cloudProvider="cloudme"

-cloudAccountName

Specifies the login name for your account with the specified cloud provider. Use this option in combination with the -cloudAccountPwd option.

Use the cloud account name and password credentials for CloudMe cloud storage accounts.

Syntax

-cloudAccountName=<"account_login_name">

Example

-cloudAccountName="box1"

-cloudAccountPwd

Specifies the password for the specified login name for your account with cloud provider. Use this option in combination with the -cloudAccountName option.

Use the cloud account name and password credentials for CloudMe cloud storage accounts.

Syntax

-cloudAccountPwd=<"account_password">

Example

-cloudAccountPwd="box1_pwd"

-cloudAccountAppKey

Specifies the application key credential that allows Dynamic File Services to access files in a cloud account on your behalf. Use this option in combination with the -cloudAccountAppSecret option.

Use the application key and secret credentials with Amazon S3 and Dropbox cloud storage accounts. For information about how to get the key and secret values, see Setting Up Cloud Access Credentials and Folders for Your Cloud Storage Provider in the Dynamic File Services 2.2 Administration Guide.

Syntax

[-cloudAccountAppKey=<"app_key">]

Example

-cloudAccountAppKey="mshgb4yvfrvabcd"

-cloudAccountAppSecret

Specifies the application secret credential that allows Dynamic File Services to access files in a cloud account on your behalf. Use this option in combination with the -cloudAccountAppKey option.

Syntax

[-cloudAccountAppSecret=<"app_secret">]

Example

-cloudAccountAppSecret="4iangwkivs1abcd"

-phase1, -phase2

Specifies the phase of a two-phase OAuth authentication process. Use the OAuth method to set up a Dropbox cloud account.

Use the -phase1 option to create a URL that has a secret token that allows the Dynamic File Services application to connect to the provider account and to perform file actions on your behalf. In a Web browser, go to the URL, then log in by using your provider account’s user name and password in order to authorize the connection.

After a successful login, use the -phase2 option to confirm to Dynamic File Services that you have authorized the connection. The local cloud account is then created.

Syntax

[-phase1|-phase2]

Examples

-phase1
-phase2

-cloudAccountBucket

Specifies the bucket to use for the cloud account. Use with Amazon S3 cloud storage accounts.

Syntax

[-cloudAccountBucket=<"bucket">]

Example

-cloudAccountBucket="NDFSjohndoebucket"

-folderPath

Specifies the folder path in the bucket for the cloud storage account where you want to store the retention repository files. The path is relative to the root of the bucket. Do not precede the path with a backslash.

Use with an Amazon S3 cloud storage account’s bucket.

Syntax

[-folderPath=<"folder_path"]

Example

-folderPath="bob/video"

-cloudPath

Specifies the path in the cloud storage account where you want to store the retention repository files. The path is relative to the root of the cloud storage account. Begin the path with a backslash.

Syntax

[-cloudPath=<"cloud_path">]

Example

-cloudPath="/main/dir1"

Add Cloud Account Examples

Each of the following -cloud commands creates a cloud account.

Example: Add an Amazon S3 Cloud Account

DswCli.exe -servername=localhost -u=Administrator -p=novell
        -cloud 
        -add 
        -name="box_bob"
        -description="Bob's Amazon3 account description"
        -cloudProvider="amazons3" 
        -cloudAccountAppKey="ABCDJRJVRWA6P7OBABCD"
        -cloudAccountAppSecret="abCDAQWGmZdCfVvOJP7lGDqE2ue3c00G9u+AbCd3" 
        -cloudAccoutBucket="bobs_bucket"
        -folderPath="projects"

Example: Add a CloudMe Cloud Account

DswCli.exe -servername=localhost -u=Administrator -p=novell
        -cloud 
        -add 
        -name="mycloudme_account" 
        -description="cloudme account description" 
        -cloudProvider="cloudme" 
        -cloudAccountName="mycloudme_account" 
        -cloudAccountPwd="mycloudme_password"

Example: Add a DropBox Cloud Account

Dropbox uses a two-phase OAuth authorization process. Phase 1 generates the token you need to authorize access by Dynamic File Services to your Dropbox account.

Enter the command for phase 1 of the OAuth authorization:

DswCli.exe -servername=localhost -u=Administrator -p=novell
        -cloud 
        -add 
        -phase1
        -name="dropbox1"  
        -description="dropbox account for john doe" 
        -cloudProvider="dropbox"
        -cloudAccountAppKey="mshgb4yvfrvabcd" 
        -cloudAccountAppSecret="4iangwkivs1abcd"

This command returns an Authorization URL. For example:

Authorization URL: https://www.dropbox.com/1/oauth/authorize?oauth_token=gaaexample1abcd

In a Web browser, go to the URL, then log in to your Dropbox account by using your Dropbox account name and password. This authorizes Dynamic File Services to access files in the account on your behalf.

Enter the command for phase 2 of the OAuth authorization. This action confirms that there was a successful authorization, and allows the cloud account to be created on the Dynamic File Services server.

DswCli.exe -servername=localhost -u=Administrator -p=novell
        -cloud 
        -add 
        -phase2
        -name="dropbox1"  
        -description="dropbox1 for john doe" 
        -cloudProvider="dropbox" 
        -cloudAccountAppKey="mshgb4yvfrvabcd" 
        -cloudAccountAppSecret="4iangwkivs1abcd"

3.12.3 Modify a Cloud Account

-modify

The -modify action changes a the settings for an existing cloud account. You cannot modify the cloud provider. The new configuration is written to the XML file in the C:\ProgramData\Dynamic File Services\Clouds folder.

Syntax

DswCli.exe [authentication_parameters] -cloud
         -modify
         -cloudId=<"cloud_account_name"|"GUID"> 
         [-name=<"cloud_account_name">] 
         [-description=<"text">] 
         [-cloudAccountName=<"acc_login_name"> 
            -cloudAccountPwd=<"acc_pwd">
         ] ;Use for CloudMe(TM)
         [-cloudAccountAppKey=<"app_key"> 
            -cloudAccountAppSecret=<"app_secret"> 
           [-cloudAccoutBucket=<"bucket">]
           [-folderPath=<"folder_path">]
         ] ;Use for Amazon S3(TM)
         [-cloudAccountAppKey=<"app_key"> 
            -cloudAccountAppSecret=<"app_secret"> 
           [-phase1|-phase2]
         ] ;Use for DropBox(TM)
         [-cloudPath=<"/cloud_path">]

For modifying a cloud account, the required parameters are cloud, modify, and cloudId. Name, description, and account credentials can be changed. Cloud GUIDs and cloud providers cannot be changed.

The changes apply to all retention pairs that are associated with the cloud account.

For a description of the cloud account parameters, see Section 3.12.2, Add a Cloud Account.

Modify Cloud Account Examples

Each of the following -cloud commands modifies a cloud account.

Example: Modify a DropBox Account Name

DswCli.exe -servername=localhost -u=Administrator -p=novell
        -cloud 
        -modify
        -cloudId="dropbox1" 
        -name="dropbox_users"

Example: Modify a CloudMe Account’s Password

DswCli.exe -servername=localhost -u=Administrator -p=novell
        -cloud 
        -modify 
        -cloudId="cloudme1" 
        -cloudAccountPwd="newpwd"

3.12.4 Delete a Cloud Account

-delete

The -delete action removes an existing cloud account. This removes the account’s information in the XML file in the C:\ProgramData\Dynamic File Services\Clouds folder.

Syntax

DswCli.exe -cloud
         -delete
         -cloudId=<"cloud_account_name"|"GUID"> 
         [authentication_parameters]

Delete a Cloud Account Example

Delete a cloud account named dropbox1:

DswCli.exe -serverName=localhost -u=Administrator -p=novell 
         -cloud 
         -delete 
         -cloudId "dropbox1"

3.12.5 List All Cloud Accounts

(no action options)

When the -cloud action option is used without any other parameters or options, all cloud accounts on the server are listed.

Syntax

DswCli.exe [authentication_parameters] -cloud

Example

The following -cloud command displays a list of all cloud accounts on the specified server:

DswCli.exe -servername=localhost -u=Administrator -p=novell 
         -cloud

3.12.6 List Details about a Cloud Account

-detail

The -detail action lists information about a specified cloud account.

Syntax

DswCli.exe [authentication_parameters] -cloud
         -detail 
         -cloudId <cloud_account_name|GUID>

List Cloud Account Details Examples

Each of the following -cloud commands provides information about a specified cloud account.

DswCli.exe -cloud -detail -cloudId dropbox1 
DswCli.exe -cloud -detail -cloudId cloudme1 
DswCli.exe -cloud -detail -cloudId box1