Page History

Section

Column

width	50%

Panel

borderColor	#CCCCCC
bgColor	#FFFFFF
titleBGColor	#F0F0F0
borderStyle	solid
title	On this page:

Table of Contents

Column

Creating a storage

Expand

title	Click to expand...

Code Block

language	bash

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

where

uid

—

Server

—server on which the archive is created

;

,
units

—

properties

—properties;
storage_type

—

archive type:

block

—

old archive type;

object

—

new archive type (object archive). If the parameter is not

—archive type (if the parameter isn't explicitly specified, then an archive of the old type is created):
- block—old archive type,
- object—new archive type (object archive).

Creating an archive volume

Possible ArchiveVolume parameters in the properties section:

Parameter	Description
format	true if it is necessary to format the created volume. The default value is false
volume_size	Volume size in bytes. Applicable if format = true
auto_mount	true if it is necessary to mount the created volume. The The default is value is false
label	Volume label
Parameters for object archive only (storage_type = object):
max_block_size_mb	Maximum block size in MB. The default value is 64, the range of valid values is [16; 512]
optimal_read_size_mb	Optimal size of blocks reading in MB. The default is value is 4, the range of valid values is [1; max_block_size_mb / 2]
incoming_buffer_size_mb	The incoming buffer size in MB. The default value is *3 max_block_size_mb. The minimum value should must be greater than 2 * max_block_size_mb**
block_flush_period_seconds	Block recording period in seconds. The default value is 60, the range of valid values is [30; 300]
index_snapshot_max_block_distance	The maximum number of blocks between indexing operations. The default value is 256, the minimum value is 16
sequence_flush_period_seconds	Sequences Frequency of recording period sequences in seconds. The default value is 60, the minimum value is 32

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

Parameter

Required

Description

schema

Yes

Volume type. Possible values:

file

—local

—local archive on the

Server.

server,
smb

—network

—remote archive with

an

SMB protocol connection

.

,
azure

—archive

—archive in Microsoft Azure cloud storage (azure.microsoft.com),
s3_amazon

—archive

—archive in Amazon S3 cloud storage (aws.amazon.com

/s3

)

.

,
s3_

wasabi—archive in Wasabi

seagate—archive in Seagate Lyve Cloud cloud storage (

wasabi.com).s3_huawei—archive in Huawei Cloud cloud storage (huaweicloud

www.seagate.com)

.

,
s3_

seagate—archive in Seagate Lyve Cloud

wasabi—archive in Wasabi cloud storage (

seagate

wasabi.com)

.

,
s3

_minio

—universal archive in the cloud storage (AxxonSoft tested it with min.io.com version RELEASE.2021-08-05T22-01-19Z). It is used when using other types of cloud storage
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

server with

network repository

remote storage
smb_share	Yes

Network repository

Remote storage
path	Yes	Folder in

network repository

remote storage, where the archive

will be

are stored
smb_domain	No

Network repository

Remote storage domain
user	No

User name

Username
password	No	Password
Parameters for the azure type

:protocol

(Microsoft Azure storage)
protocol	Yes	Connection protocol: HTTP or HTTPS.

This

This parameter is located in the properties of the created container
host	Yes	Azure

Server

server address.

This

This parameter is located in the properties of the created container
access_key	Yes	Access key in base64.

This

This parameter is located in the Access keys section
container	Yes	Azure container.

This

This parameter is located in the properties of the created container
user	Yes

User name

Username.

This

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

must be empty
port	No	Azure

Server

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

server, the volume name

should

must be unique, and for

the

the Axxon One operation, it

should

must 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

server. For the list of possible regions,

see

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

must 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

seagate type (

Huawei

Seagate Lyve Cloud storage):
bucket	Yes	Archive volume name (Bucket Name), predefined by the user

at the Object Storage Service tab

. 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.

Specified in the Endpoint

Corresponds to the Region 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)"

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:

myhuaweicloud

lyvecloud.seagate.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

bucket_endpoint

No

Domain name with a port.

Note

title	Attention!

You must use the parameter only when using MinIO if the domain name of the MinIO server is specified instead of the server IP address.

Example: http://miniopoc1.agis.xh.ar:9000

where,

miniopoc1.agis.xh.ar—the domain name of the MinIO server,
9000—MinIO port

region

Yes

The region where the volume is located

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_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

No	Location of the Axxon One folder

created

inside the bucket
protocol	Yes	Connection protocol: HTTP or HTTPS
host	Yes	Server address

: lyvecloud.seagate.comParameters for the s3_miniotype (MinIO storage):bucketYesArchive volume name (Bucket Name), predefined by the user. Corresponds to the Name parameter in the Bucket propertiesbucket_endpointNoDomain name with a port


port	Yes	Server port

Info

title	Note

Starting with Аxxon One 2.0, you can create several volumes of the cloud archive.

Note

title	Attention!

...

The parameter should only be used when using MinIO, if the domain name of the MinIO Server is specified instead of the Server IP address.

Example: http://miniopoc1.agis.xh.ar:9000

where,

miniopoc1.agis.xh.ar—the domain name of the MinIO Server.
9000—MinIO port

...

Access key identifier

...

Server address

...

We recommend adding new volumes of the cloud archive with the same value of archive size. Otherwise, the total depth of the archive storage can change due to the Round-robin algorithm (see General information about the Round-robin algorithm) for record distribution, which can lead to decimation of the frames of archive recordings.
When the archive size of one of the cloud archive volumes increases, the archive volumes are overwritten by the Round-robin algorithm (see General information about the Round-robin algorithm). The depth of the archive storage will gradually increase over the number of days equal to the difference between the original and the new value of the archive storage depth.

Example of creating an archive volume as files on a local disk

Expand

title	Click to expand...

Code Block
{ "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig", "data": {

Info

title	Note

Starting from Аxxon One 2.0, it is possible to create multiple volumes of the object archive.

Note

title	Attention!

It is recommended to add new volumes of the object archive with the same value of archive size. Otherwise, the total depth of the archive storage may change due to the Round-robin algorithm (see General information about the Round-robin algorithm) for record distribution, which may lead to decimation of the archive record frames.
When the archive size of one of the object archive volumes increases, the archive volumes will be overwritten by the Round-robin algorithm (see General information about the Round-robin algorithm). The depth of the archive storage will gradually increase over the number of days equal to the difference between the original and the new value of the archive storage depth.

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

...

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/SERVER/MultimediaStorage.Gray",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "properties": [
                            {
                                "id": "volume_type",
                                "value_string": "object",
                                "properties": [
                                    {
                                        "id": "connection_params",
                                        "value_properties": {
                                            "properties": [
                                                {"id": "schema","value_string": "file"},
                                                {"id": "path","value_string": "D:/archives"}
                                            ]}}]},
                            {"id": "label","value_string": "test"},
                            {"id": "volume_size","value_uint64": "26843545600"},
                            {"id": "format","value_bool": true},
                { "id": "auto_mount", "value_bool": true }
                        ]}]}
        ]
    }
}

Example of creating an archive volume on a network resource:

Expand

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/SERVER/MultimediaStorage.Gray",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "propertiesadded": [
                            {
                                "iduid": "volume_typehosts/SERVER/MultimediaStorage.Gray",
                    "units": [
            "value_string": "object",
        {
                        "propertiestype": [
"ArchiveVolume",
                        "properties": [
                   {
         {
                                "id": "connectionvolume_paramstype",
                                "value_string": "object",
              "value_properties": {
                 "properties": [
                          "properties": [
         {
                                       { "id": "schemaconnection_params", "value_string": "smb" },

                                { "id": "host", "value_string": "computer" },
     "value_properties": {
                                           { "idproperties": "smb_domain", "value_string": "domain" },
    [
                    { "id": "smb_share", "value_string": "Share" },
                        { "id": "pathschema", "value_string": "videofile" },
                        { "id": "user", "value_string": "Tester" },
                        { "id": "passwordpath", "value_string": "Testing321D:/archives" }
                                            ]}}]},
                            {"id": "label","value_string": "test"},
                            {"id": "volume_size","value_uint64": "1207374182426843545600"},
                            {"id": "format","value_bool": true},
                { "id":       ]"auto_mount", "value_bool": true }
                        ]
            ]}]}
        ]
    }
}

Example of creating an

...

archive volume

...

on a remote resource

Expand

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/SERVER/MultimediaStorage.Gray",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "properties": [
                            {
                                "id": "volume_type",
                                "value_string": "object",
                                "properties": [
                                    {
                                        "id": "connection_params",
                                        "value_properties": {
                                            "properties": [
                                                { "id": "schema", "value_string": "azuresmb" },
                                                { "id": "protocolhost", "value_string": "httpscomputer" },
                                                { "id": "hostsmb_domain", "value_string": "axxonsoft.blob.core.windows.netdomain" },
                        { "id": "smb_share", "value_string": "Share" },
                        { "id": "access_keypath", "value_string": "youraccesskey==video" },
                        { "id": "user", "value_string":   "Tester" },
                        { "id": "containerpassword", "value_string": "containerTesting321" },
                                            ]}}]},
     { "id": "user", "value_string": "axxonsoft" },
                  {"id": "label","value_string": "test"},
                            { "id": "pathvolume_size", "value_stringuint64": "12073741824" },
                            {"id": "format","value_bool": true}
                  ]}}]},
      ]}
                      {"id": "label","value_string": "test"}, ]
            }
        ]
    }
}

Example of creating a cloud archive volume in Microsoft Azure

Expand

title	Click to expand...

Code Block

{
    {"idmethod": "volume_size","value_uint64": "12073741824"},axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                {"iduid": "formathosts/SERVER/MultimediaStorage.Gray","value_bool": true}
                        ]}"units": [
                    {
     ]
            }
        ]"type": "ArchiveVolume",
    }
}

Example of creating an object archive volume in Amazon:

Expand

title	Click to expand...

Code Block

{
      "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "addedproperties": [
             {
               {
  "uid": "hosts/SERVER/MultimediaStorage.Gray",
                   "units": [
            "id": "volume_type",
        {
                        "typevalue_string": "ArchiveVolumeobject",
                        "properties": [
           "properties": [
                {
                        {
        "id": "volume_type",
                                "value_stringid": "objectconnection_params",
                                "properties": [
               "value_properties": {
                     {
                       "properties": [
                "id": "connection_params",
                                { "id": "schema", "value_string": "azure" },
   "value_properties": {
                                             { "id": "protocol", "propertiesvalue_string": ["https" },
                                                { "id": "schemahost", "value_string": "s3_amazonaxxonsoft.blob.core.windows.net" },
                                                { "id": "bucketaccess_key", "value_string": "axxonsoft-testyouraccesskey==" },
                        { "id": "region", "value_string": "us-west-1" },
                        { "id": "access_key_idcontainer", "value_string": "youraccesskeyidcontainer" },
                            { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
                        { "id": "pathuser", "value_string": "pathaxxonsoft" },
                        { "id": "protocol", "value_string": "https" },
                        { "id": "hostpath", "value_string": "amazonaws.com" }
                                            ]}}]},
                            {"id": "label","value_string": "test"},
                            {"id": "volume_size","value_uint64": "12073741824"},
                            {"id": "format","value_bool": true}
                        ]}
                        ]
            }
        ]
    }
}

Example of creating

...

a cloud archive volume in Amazon

Expand

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/SERVER/MultimediaStorage.Gray",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "properties": [
                            {
                                "id": "volume_type",
                                "value_string": "object",
                                "properties": [
                                    {
                                        "id": "connection_params",
                                        "value_properties": {
                                            "properties": [
                                                { "id": "schema", "value_string": "s3_wasabiamazon" },
                                                { "id": "bucket", "value_string": "axxontestaxxonsoft-1test" },
                                                { "id": "region", "value_string": "us-central-1" },
                      ": "us-west-1" },
                          { "id": "access_key_id", "value_string": "youraccesskeyid" },
                                                { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
                        { "id": "path", "value_string": "path" },
                        { "id": "pathprotocol", "value_string": "pathhttps" },
                        { "id": "host", "value_string": "amazonaws.com" }
                   { "id": "protocol", "value_string": "http" },
                    ]}}]},
                            { "id": "hostlabel", "value_string": "wasabisys.comtest" },
                            {"id": "volume_size","value_uint64": "12073741824"},
              ]}}
                {"id": "format","value_bool": true}
              ]},
          ]}
                  {"id": "label","value_string": "test"},
    ]
            }
        ]
    }
}

Example of creating a cloud archive volume in Wasabi

Expand

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig"{"id": "volume_size","value_uint64": "209715200"},
    "data": {
           "added": [
            {"id": "format","value_bool": true}
                        ]"uid": "hosts/SERVER/MultimediaStorage.Gray",
                    }"units": [
                ]
            }{
        ]
    }
}

Example of creating an object archive volume in Huawei Cloud:

Expand

title	Click to expand...

Code Block

{
            "methodtype": "axxonsoft.bl.config.ConfigurationService.ChangeConfigArchiveVolume",
             "data": {
           "addedproperties": [
              {
              {
  "uid": "hosts/SERVER/MultimediaStorage.Gray",
                  "units": [
           "id": "volume_type",
        {
                        "typevalue_string": "ArchiveVolumeobject",
                                "properties": [
                                    {
        {
                                "id": "volumeconnection_typeparams",
                                        "value_stringproperties": "object",{
                                "properties": [
           "properties": [
                        {
                        { "id": "schema", "value_string": "s3_wasabi" },
           "id": "connection_params",
                                     { "id": "bucket", "value_propertiesstring": {
"axxontest-1" },
                                                { "id": "region", "propertiesvalue_string": ["us-central-1" },
                                                { "id": "schemaaccess_key_id", "value_string": "s3_huaweiyouraccesskeyid" },
                                                { "id": "bucketsecret_access_key", "value_string": "axxon-test-1yoursecretaccesskey" },
                            { "id": "region", "value_string": "ap-southeast-1" },
                            { "id": "access_key_idpath", "value_string": "youraccesskeyidpath" },
                            { "id": "secret_access_key", "value_string": "yoursecretaccesskey" },
                            { "id": "pathprotocol", "value_string": "pathhttp" },
                                                { "id": "protocolhost", "value_string": "httpswasabisys.com" },
                            { "id": "host", "value_string": "myhuaweicloud.com" }
            ]}}
                                ]}}]},
                            {"id": "label","value_string": "test"},
                            {"id": "volume_size","value_uint64": "10073741824209715200"},
                            {"id": "format","value_bool": true}
                        ]
                    }
                ]
            }
        ]
    }
}

Example of creating

...

a cloud archive volume in Seagate Lyve Cloud

...

Expand

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/SERVER/MultimediaStorage.Gray",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "properties": [
                            {
                                "id": "volume_type",
                                "value_string": "object",
                                "properties": [
                                    {
                                        "id": "connection_params",
                                        "value_properties": {
                                            "properties": [
                                                { "id": "schema", "value_string": "s3_seagate" },
                            { "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": "lyvecloud.seagate.com" }
                                            ]}}]},
                            {"id": "label","value_string": "test"},
                            {"id": "volume_size","value_uint64": "1073741824"},
                            {"id": "format","value_bool": true}
                        ]}]}
        ]
    }
}

Example of creating

...

a cloud archive volume in MinIO S3

Expand

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/ServerName/MultimediaStorage.Gray",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "properties": [
                            {
                                "id": "volume_type",
                                "value_string": "object",
                                "properties": [
                                    {
                                        "id": "connection_params",
                                        "value_properties": {
                                            "properties": [
                                                { "id": "schema", "value_string": "s3" },
                                                { "id": "bucket", "value_string": "bucket" },
                                                { "id": "region", "value_string": "us-east-1" },
                                                { "id": "access_key_id", "value_string": "MINIOROOT" },
                                                { "id": "secret_access_key", "value_string": "MINIOPASS" },
                                                { "id": "path", "value_string": "path" },
                                                { "id": "protocol", "value_string": "http" },
                                                { "id": "host", "value_string": "192.168.56.102" },
                                                { "id": "port", "value_string": "9000" }
                                            ]}}]},
                            {"id": "label","value_string": "test"},
                            {"id": "volume_size","value_uint64": 1207374182},
                            {"id": "format","value_bool": true}
                        ]}
                        ]
            }
        ]
    }
}

Example of creating

...

a cloud archive volume in MinIO S3 using the domain name

...

Expand

title	Click to expand...

Code Block

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/Server/MultimediaStorage.Gray",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "properties": [
                            {
                                "id": "volume_type",
                                "value_string": "object",
                                "properties": [
                                    {
                                        "id": "connection_params",
                                        "value_properties": {
                                            "properties": [
                                                { "id": "schema", "value_string": "s3" },
                                                { "id": "bucket", "value_string": "bucket" },
                                                { "id": "region", "value_string": "us-east-1" },
                                                { "id": "access_key_id", "value_string": "MINIOROOT" },
                                                { "id": "secret_access_key", "value_string": "MINIOPASS" },
                                                { "id": "path", "value_string": "" },
                                                { "id": "protocol", "value_string": "http" },
                                                { "id": "host", "value_string": "" },
                                                { "id": "bucket_endpoint", "value_string": "http://miniopoc1.agis.xh.ar:9000" }
                                            ]}}]},
                            {"id": "label","value_string": "test"},
                            {"id": "volume_size","value_uint64": 1207374182},
                            {"id": "format","value_bool": true}
                        ]}
                        ]
            }
        ]
    }
}

Changing an archive volume

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

Expand

title	Click to expand...

Code Block

language	bash

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "changed": [
            {
                "uid": "hosts/Server/MultimediaStorage.Gray/ArchiveVolume.4508f459-5eeb-4ee3-881b-4a4e149c7802",
                "properties": [
                    {
                        "id": "label",
                        "value_string": "NewLabel"
                    },
                    {
                        "id": "readonly",
                        "value_bool": false
                    },
                    {
                        "id": "connection_params",
                        "value_properties": {
                            "properties": [
                                {
                                }
                            ]
                        }
                    }
                ]
            }
        ]
    }
}

Page tree

Versions Compared

Old Version 8

New Version 13

Key

Creating a storage

Creating an archive volume

Example of creating an archive volume as files on a local disk

Example of creating an

archive volume

on a remote resource

Example of creating a cloud archive volume in Microsoft Azure

Example of creating

a cloud archive volume in Amazon

Example of creating a cloud archive volume in Wasabi

Example of creating

a cloud archive volume in Seagate Lyve Cloud

Example of creating

a cloud archive volume in MinIO S3

Example of creating

a cloud archive volume in MinIO S3 using the domain name

Changing an archive volume