Go to documentation repository
Page History
...
| Parameter | Required | Description |
|---|---|---|
| schema | Yes | Volume type. Possible values: file − local archive on the Server; smb − network archive with an SMB protocol connection; azure − archive in Microsoft Azure cloud storage; s3_amazon − archive in Amazon S3 cloud storage (aws.amazon.com/s3). s3_wasabi − archive in Wasabi cloud storage (wasabi.com). s3_huawei − archive in Huawei Cloud cloud storage (huaweicloud.com). s3_seagate − archive in Seagate Lyve Cloud cloud storage (seagate.com). |
| Parameters for the file type: | ||
| path | Yes | The path to the file/disk with the archive. |
| Parameters for the smb type: | ||
| host | Yes | Name of the server with network repository. |
| smb_share | Yes | Network repository. |
| path | Yes | Folder in network repository, where the archive will be stored. |
| smb_domain | No | Network repository domain. |
| user | No | User name. |
| password | No | Password. |
| Parameters for the azure type: | ||
| protocol | Yes | Connection protocol: HTTP or HTTPS. This parameter is located in the properties of the created container. |
| host | Yes | Azure server address. This parameter is located in the properties of the created container. |
| access_key | Yes | Access key in base64. This parameter is located in the Access keys section. |
| container | Yes | Azure container. This parameter is located in the properties of the created container. |
| user | Yes | User name. This parameter is located in the Access keys section (Storage account name). |
| path | No | Do not specify the location of the volume folder in Azure — the parameter should be empty. |
| port | No | Azure server port. |
| Parameters for the s3_amazon type (Amazon storage): | ||
access_key_id | Yes | Access key identifier (create access keys at https://console.aws.amazon.com/iam/home?#/security_credentials$access_key, authorization required). |
| secret_access_key | Yes | Access key password (available after creating an access key). |
| bucket | Yes | Archive volume in Amazon S3 account (bucket). Different volumes can be located in different regions. On the Amazon S3 server, the volume name should be unique, and for the Axxon One operation, it should be pre-created by the user according to the rules (see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). |
| region | Yes | The region where the volume is located. To reduce the delay when writing and reading an archive, specify the closest region to the Axxon One Server. For the list of possible regions, see https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints. |
| path | Yes | Location of the Axxon One volume folder inside the bucket. |
| protocol | Yes | Connection protocol: HTTP or HTTPS. |
| host | Yes | Server address: amazonaws.com. |
| Parameters for the s3_wasabi type (Wasabi storage): | ||
| bucket | Yes | Archive volume name (Bucket Name), predefined by the user at https://console.wasabisys.com/#/file_manager. |
| region | Yes | The region where the corresponding volume is located, as specified at https://console.wasabisys.com/#/file_manager. |
| access_key_id | Yes | Access key identifier, which should be pre-created at https://console.wasabisys.com/#/access_keys. |
| secret_access_key | Yes | Access key password (available after creating an access key). |
| protocol | Yes | Connection protocol: HTTP or HTTPS. |
| path | Yes | Location of the folder created inside the bucket (Folder object in Bucket). |
| host | Yes | Server address: wasabisys.com. |
| Parameters for the s3_huawei type (Huawei Cloud storage): | ||
| bucket | Yes | Archive volume name (Bucket Name), predefined by the user at the Object Storage Service tab. |
| region | Yes | The region where the corresponding volume is located, as specified when it was created. Specified in the Endpoint parameter in the Bucket properties. |
| access_key_id | Yes | Access key identifier, which should be created by clicking on the link "Obtain access keys (AK and SK)". |
| secret_access_key | Yes | Access key password (available after creating an access key). |
| path | Yes | Location of the folder created inside the bucket. |
| protocol | Yes | Connection protocol: HTTP or HTTPS. |
| host | Yes | Server address: myhuaweicloud.com. |
| Parameters for the s3_seagate type (Seagate Lyve Cloud storage): | ||
| bucket | Yes | Archive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties. |
| region | Yes | The region where the corresponding volume is located, as specified when it was created. Corresponds to the Region parameter in the Bucket properties. |
| access_key_id | Yes | Access key identifier, which is generated when creating an account in the Create Service Account window. |
| secret_access_key | Yes | Access key password (available after creating an access key). |
| path | Yes | Location of the folder created inside the bucket. |
| protocol | Yes | Connection protocol: HTTP or HTTPS. |
| host | Yes | Server address: lyvecloud.seagate.com. |
| Parameters for the s3type: | ||
| bucket | Yes | Archive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties. |
| region | Yes | The region where the volume is located. |
| access_key_id | Yes | Access key identifier. |
| secret_access_key | Yes | Access key password (available after creating an access key). |
| path | No | Location of the Axxon One folder inside the bucket. |
| protocol | Yes | Connection protocol: HTTP or HTTPS. |
| host | Yes | Server address. |
| port | Yes | Server port. |
Example of creating an archive volume as files on a local disk:
...
Overview
Content Tools