Documentation for Axxon Next 4.6.0. Documentation for other versions of Axxon Next is available too.

Previous page Next page

On this page:

Creating an archive entity

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [ {
          "uid": "hosts/server",
          "units": [ {
              "type": "MultimediaStorage",
              "properties": [
                { "id": "display_name", "properties": [], "value_string": "Archive Storage" },
                { "id": "color", "properties": [], "value_string": "Gray" },
                { "id": "storage_type", "value_string": "object" }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

where

  • uid − Server on which the archive is created;
  • units − properties;
  • storage_type − archive type: block − old archive type; object − new archive type (object archive). If the parameter is not explicitly specified, then an archive of old type is created.

Creating an archive volume

Possible ArchiveVolume parameters in the properties section:

ParameterDescription
formattrue if it is necessary to format the created volume. The default is false.
volume_size_gbVolume size in GB. Applicable if format = true.
auto_mounttrue if it is necessary to mount the created volume. The default is false.
labelVolume label
Parameters for object archives only (storage_type = object):
max_block_size_mbMaximum block size in MB. The default is 64, the range of valid values is [16; 512].
optimal_read_size_mbOptimal size of blocks reading in MB. The default is 4, the range of valid values is [1; max_block_size_mb / 2].
incoming_buffer_size_mbThe incoming buffer size in MB. The default is 3 * max_block_size_mb. The minimum value should be greater than 2 * max_block_size_mb.
block_flush_period_secondsBlock recording period in seconds. The default is 60, the range of valid values is [30; 300].
index_snapshot_max_block_distanceThe maximum number of blocks between indexing operations. The default is 256, the minimum is 16.
sequence_flush_period_secondsSequences recording period in seconds. The default is 60, the minimum is 32.

At the ArchiveVolume level, the connection_params property is also added, with the following parameters:

ParameterRequiredDescription
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 − archive in cloud storage Amazon S3 (aws.amazon.com/s3), Wasabi (wasabi.com), Huawei Cloud (huaweicloud.com), or Seagate Lyve Cloud (seagate.com).

Parameters for the file type:
pathYesThe path to the file/disk with the archive.
Parameters for the smb type:
hostYesName of the server with network repository.
smb_shareYesNetwork repository.
pathYesFolder in network repository, where the archive will be stored.
smb_domainNoNetwork repository domain.
userNoUser name.
passwordNoPassword.
Parameters for the Azure type:
protocol Yes

Connection protocol: HTTP or HTTPS. This parameter is located in the properties of the created container.

hostYes

Azure server address. This parameter is located in the properties of the created container.

access_keyYes

Access key in base64. This parameter is located in the Access keys section.

containerYes

Azure container. This parameter is located in the properties of the created container.

userYes

User name. This parameter is located in the Access keys section (Storage account name).

pathNo

Location of the volume folder in Azure.

portNoAzure server port.
Parameters for the s3 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_keyYes

Access key password (available after creating an access key).

bucketYes

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 Next operation, it should be pre-created by the user according to the rules (see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).

regionYes

The region where the volume is located. To reduce the delay when writing and reading an archive, specify the closest region to the Axxon Next Server. For the list of possible regions, see https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints.

pathYesLocation of the Axxon Next volume folder inside the bucket.
protocolYesConnection protocol: HTTP or HTTPS.
hostYes

Amazon S3 server address in the format: <bucket_name>.s3.amazonaws.com.

Parameters for the s3 type (Wasabi storage):
bucketYes

Archive volume name (Bucket Name), predefined by the user at https://console.wasabisys.com/#/file_manager.

regionYes

The region where the corresponding volume is located, as specified at https://console.wasabisys.com/#/file_manager.

access_key_idYes

Access key identifier, which should be pre-created at https://console.wasabisys.com/#/access_keys.

secret_access_keyYesAccess key password (available after creating an access key).
protocolYesConnection protocol: HTTP or HTTPS.
pathYes

Location of the folder created inside the bucket (Folder object in Bucket).

hostYes

Wasabi server address in the format: s3.<region>.wasabisys.com.

Parameters for the s3 type (Huawei Cloud storage):
bucketYes

Archive volume name (Bucket Name), predefined by the user at the Object Storage Service tab.

regionYes

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_idYes

Access key identifier, which should be created by clicking on the link "Obtain access keys (AK and SK)".

secret_access_keyYesAccess key password (available after creating an access key).
pathYes

Location of the folder created inside the bucket.

protocolYesConnection protocol: HTTP or HTTPS.
hostYes

Server address. Corresponds to the Endpoint parameter in the Bucket properties.

Parameters for the s3 type (Seagate Lyve Cloud storage):
bucketYesArchive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket properties.
regionYesThe region where the corresponding volume is located, as specified when it was created. Corresponds to the Region parameter in the Bucket properties.
access_key_idYes

Access key identifier, which is generated when creating an account in the Create Service Account window.

secret_access_keyYesAccess key password (available after creating an access key).
pathYesLocation of the folder created inside the bucket.
protocolYesConnection protocol: HTTP or HTTPS.
hostYes

Server address. Corresponds to the Virtual Host URL parameter in the Bucket properties.

Example of creating an object archive as files on a local disk:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "file" },
                            { "id": "path", "value_string": "D:/Dev/!temp/Archive" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true },
                { "id": "auto_mount", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}  

Example of creating an object archive on a network resource:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "smb" },
                            { "id": "host", "value_string": "qa-t9" },
                            { "id": "smb_share", "value_string": "incoming" },
                            { "id": "path", "value_string": "video" },
                            { "id": "user", "value_string": "Tester" },
                            { "id": "password", "value_string": "123456" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true },
                { "id": "auto_mount", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Example of creating an object archive in Microsoft Azure:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "azure" },
                            { "id": "protocol", "value_string": "https" },
                            { "id": "host", "value_string": "axxonsoft.blob.core.windows.net" },
                            { "id": "access_key", "value_string": "youraccesskey==" },
                            { "id": "container", "value_string": "container" },
                            { "id": "user", "value_string": "axxonsoft" },
                            { "id": "path", "value_string": "" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Example of creating an object archive in Amazon S3:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "id": "bucket", "value_string": "bucketname" },
                            { "id": "region", "value_string": "eu-central-1" },
                            { "id": "access_key_id", "value_string": "youraccesskeyid" },
                            { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
                            { "id": "path", "value_string": "path" },
                            { "id": "protocol", "value_string": "https" },
                            { "id": "host", "value_string": "bucketname.s3.amazonaws.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 1 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Example of creating an object archive in Wasabi:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Tan",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "id": "bucket", "value_string": "archive-wasabi" },
                            { "id": "region", "value_string": "eu-central-1" },
                            { "id": "access_key_id", "value_string": "youraccesskeyid" },
                            { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
                            { "id": "path", "value_string": "path" },
                            { "id": "protocol", "value_string": "https" },
                            { "id": "host", "value_string": "s3.eu-central-1.wasabisys.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 1 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Example of creating an object archive in Huawei Cloud:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "id": "bucket", "value_string": "axxon-test" },
                            { "id": "region", "value_string": "na-mexico-1" },
                            { "id": "access_key_id", "value_string": "youraccesskeyid" },
                            { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
                            { "id": "path", "value_string": "path" },
                            { "id": "protocol", "value_string": "https" },
                            { "id": "host", "value_string": "obs.na-mexico-1.myhuaweicloud.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 5 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Example of creating an object archive in Seagate Lyve Cloud:

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Tan",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                    "id": "connection_params",
                    "value_properties": {
                        "properties": [
                            { "id": "schema", "value_string": "s3" },
                            { "id": "bucket", "value_string": "axxonsoft-test" },
                            { "id": "region", "value_string": "us-west-1" },
                            { "id": "access_key_id", "value_string": "youraccesskeyid" },
                            { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
                            { "id": "path", "value_string": "path" },
                            { "id": "protocol", "value_string": "https" },
                            { "id": "host", "value_string": "s3.us-west-1.lyvecloud.seagate.com" }
                ] } },
                { "id": "label", "value_string": "Test archive" },
                { "id": "volume_size_gb", "value_uint64": 1 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}

Changing an archive volume

To change the archive volume, the same parameters are used as when creating it.

{
  "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
      "added": [
        {
          "uid": "hosts/server/MultimediaStorage.Gray/ArchiveVolume.495c3ef4-043f-4890-a4e0-c66f4fa252e7",
          "units": [
            {
              "type": "ArchiveVolume",
              "properties": [
                {
                  "id": "connection_params",
                  "value_properties": {
                     "properties": [
                       { "id": "schema", "value_string": "file" },
                       { "id": "path", "value_string": "D:/AliceBlueBlock" }
                  ] }
                },
                { "id": "label", "value_string": "Test archive block" },
                { "id": "volume_size_gb", "value_uint64": 100 },
                { "id": "format", "value_bool": true }
      ] } ] } ],
      "changed": [],
      "removed": []
    }
}
  • No labels