Description of archive settings

Request to get the settings:

https://[server_address]:[port]/settings/archive/?sid=[session_id]

Response:

{
    "name" : "archive",
    "type" : "Archive",
    "subdirs" : [
        "c",
        "d",
        "e",
        "g"
    ],
    "values" : [
        "add_mount_point_local8bit",
        "add_mount_point_stornix_iplist",
        "disks_black_list",
        "encryption_nonempty_rp",
        "encryption_nonempty_wp",
        "encryption_rp",
        "encryption_wp",
        "on_server",
        "postgresql_disk",
        "postrecord",
        "prebuffer",
        "ring_privileged_store_period",
        "ring_ss_longer_storage_period",
        "ring_ss_store_longer",
        "ring_ss_use",
        "settings_disk",
        "settings_mode",
        "stall_timeout",
        "stornix_additional_datacenters",
        "what_to_do_with_new_disk"
    ]
}

Table 116. 

subdirs Description TRASSIR
[disk_name] The name of the archive disk being used to retrieve its settings. ≥3.1

Retrieve a value (R):

https://[server_address]:[port]/settings/archive/[setting]?sid=[session_id]

Change the value of an archive setting (W):

https://[server_address]:[port]/settings/archive/[setting]=[value]?sid=[session_id]

Table 117. 

values Description Type   TRASSIR
add_mount_point_local8bit Add local path to a new mounting point string RW ≥3.1
add_mount_point_stornix_iplist Add Stornix IP address to a new mounting point string RW ≥4.0
disks_black_list Disks black list string RW ≥4.1
encryption_nonempty

The write password has been set:

0 - No

1 - Yes

integer R 3.2
encryption_nonempty_rp

Archive reading password is set:

0 - No

1 - Yes

integer R ≥3.2
encryption_nonempty_wp

Read write password set:

0 - No

1 - Yes

integer R ≥3.2
encryption_rp Set the archive's read password string W ≥3.2
encryption_wp Set the write password string W ≥3.2
on_server   integer R ≥3.1
postgresql_disk PostgresSQL database storage disk string RW ≥3.2
postrecord Time to reset detector (post-recording) real RW ≥3.1
prebuffer Recording prebuffer real RW ≥3.1
ring_privileged_store_period Store privileged channels, in days integer RW ≥3.1
ring_ss_longer_storage_period Substream retention period, in days integer RW ≥3.1
ring_ss_store_longer

Save substream exactly:

0 - No

1 - Yes

integer RW ≥3.1
ring_ss_use

Retain the substream:

0 - No

1 - Yes

integer RW ≥3.1
settings_disk   string RW ≥4.0
settings_mode   integer RW ≥4.0
stall_timeout   integer RW ≥4.0
stornix_additional_datacenters   string RW ≥4.0
what_to_do_with_new_disk

Action to take when a new disk is detected:

0 - None

1 - Mount for reading

2 - Mount for writing

integer RW ≥3.1

Request for the archive's disk settings:

https://[server_address]:[port]/settings/archive/[disk_name]/?sid=[session_id]

Response:

{
    "name" : "d",
    "type" : "ArchiveMountPoint",
    "subdirs" : [
        "stats"
    ],
    "values" : [
        "autodetected",
        "capacity_gb",
        "disk_id",
        "enable",
        "forever_read_only",
        "format",
        "format_needed",
        "fsck_in_progress",
        "iqn",
        "model",
        "path_local8bit",
        "read_only",
        "reserve_gb",
        "serial",
        "stored_settings",
        "stornix_datacenter",
        "stornix_datacenter_remote",
        "stornix_iplist",
        "stornix_password",
        "system_drive",
        "unusable"
    ]
}

Table 118. 

subdirs Description TRASSIR
stats A subdirectory with a list of parameters pertaining to the archive disk's state. ≥3.1

Retrieve a value (R):

https://[server_address]:[port]/settings/archive/[disk_name]/[setting]?sid=[session_id]

Write a value (W):

https://[server_address]:[port]/settings/archive/[disk_name]/[setting]=[value]?sid=[session_id]

Table 119. 

values Description Type   TRASSIR
autodetected

Disk detected automatically:

0 - No

1 - Yes

integer R ≥3.1
capacity_gb Disk volume, gigabytes real R ≥3.1
disk_id Disk ID string R ≥3.1
enable

Disk connected:

0 - No

1 - Yes

integer RW ≥3.1
forever_read_only

Always read only:

0 - No

1 - Yes

integer R ≥3.1
format   string RW ≥3.1
format_needed

Formatting is required:

0 - No

1 - Yes

integer R ≥3.1
fsck_in_progress   integer RW ≥3.2
iqn   string R ≥3.2
model   string R ≥3.1
path_local8bit Disk or mount point path string R ≥3.1
read_only

Read only:

0 - No

1 - Yes

integer RW ≥3.1
reserve_gb Volume reserved on disk, gigabytes real RW ≥3.1
serial   string R ≥3.2
stored_settings   integer R ≥4.0
stornix_datacenter   string W ≥4.0
stornix_datacenter_remote   integer W ≥4.0
stornix_iplist List of Stornix IP addresses string RW ≥4.0
stornix_password Stornix partition password string RW ≥4.0
system_drive

System drive:

0 - No

1 - Yes

integer R ≥3.1
unusable

Unused:

0 - No

1 - Yes

integer R ≥3.1

Request for the parameters pertaining to the archive disk's state:

https://[server_address]:[port]/settings/archive/[disk_name]/stats/?sid=[session_id]

Response:

{
    "name" : "stats",
    "type" : "ArchiveStats",
    "subdirs" : [

    ],
    "values" : [
        "archive_size_days",
        "current_speed_mbs",
        "disk_read_mbs",
        "disk_write_mbs",
        "error_counter",
        "in_use_by_db",
        "last_error_code",
        "set_error_code",
        "sync_mode",
        "unavailable"
    ]
}

Retrieve the value of an archive disk setting (R):

https://[server_address]:[port]/settings/archive/[disk_name]/stats/[setting]?sid=[session_id]

Table 120. 

values Description Type   TRASSIR
archive_size_days Archive depth, days integer R ≥3.2
current_speed_mbs Current speed, Mbps real R ≥3.2
disk_read_mbs Disk reading speed, Mbps real R ≥3.2
disk_write_mbs Disk writing speed, Mbps integer R ≥3.2
error_counter

Archive has errors:

0 - No

1 - Yes

integer RW ≥3.2
in_use_by_db

Used by database:

0 - No

1 - Yes

integer R ≥3.2
last_error_code Last error code string RW ≥3.2
set_error_code   string RW ≥4.1
sync_mode   integer R ≥3.2
unavailable

Unavailable:

0 - No

1 - Yes

integer R ≥3.2

See also