Документация AeroDisk Документация
  • Система хранения данных
    • Руководство администратора
  • Системы виртуализации
    • Руководство администратора
Скачать
Menu

Внимание

Вы просматриваете документацию по предыдущей версии Aerodisk ENGINE.

Aerodisk ENGINE API

API¶

EngineAPI

EngineAPI

Access

  1. OAuth AuthorizationUrl:TokenUrl:/api/auth/token

Methods

[ Jump to Models ]

Table of Contents

AD

  • post /api/ad/ad
  • post /api/ad/ad~disconnect_ad
  • get /api/ad/ad

Authentication

  • post /api/auth/token

ConsistencyGroup

  • post /api/cg/group
  • delete /api/cg/group/{id_num}
  • put /api/cg/group/{id_num}
  • get /api/cg/group
  • get /api/cg/rdg_lun

ControllerControl

  • get /api/power/system~export_configuration
  • get /api/power/system
  • get /api/power/license
  • post /api/power/license~update

DDP

  • post /api/ddp/lun
  • post /api/ddp/pool
  • post /api/ddp/snapclone
  • post /api/ddp/snapshot
  • post /api/ddp/thinstorage
  • delete /api/ddp/lun/{pool}/{lun}
  • delete /api/ddp/pool/{name}
  • delete /api/ddp/snapshot/{pool}/{lun}/{name}
  • post /api/ddp/snapshot~delete_group
  • delete /api/ddp/thinstorage/{pool_name}
  • put /api/ddp/lun/{pool}/{lun}
  • put /api/ddp/pool/{name}
  • put /api/ddp/thinstorage/{pool_name}
  • get /api/ddp/pool/{name}~hotspareDisks
  • get /api/ddp/lun
  • get /api/ddp/pool
  • get /api/ddp/snapshot~restore_info
  • get /api/ddp/snapshot
  • get /api/ddp/pool/{name}~switch_controller
  • get /api/ddp/thinstorage
  • post /api/ddp/snapshot~restore_lun
  • post /api/ddp/snapshot~restore_to_object

Disk

  • get /api/disk

FC

  • post /api/fc/group
  • post /api/fc/mapping
  • delete /api/fc/group/{group}
  • delete /api/fc/mapping/{group}/{pool}/{lun}
  • put /api/fc/group/{group}
  • get /api/fc/target/mode
  • get /api/fc/initiator
  • get /api/fc/mapping
  • get /api/fc/target
  • get /api/fc/group
  • put /api/fc/target/rescan
  • put /api/fc/mapping/{group}/{pool}/{lun}
  • put /api/fc/initiator/{initiator}
  • put /api/fc/target/mode

ISCSI

  • post /api/iscsi/group
  • post /api/iscsi/mapping
  • post /api/iscsi/target
  • delete /api/iscsi/group/{group}
  • delete /api/iscsi/mapping/{group}/{pool}/{lun}
  • delete /api/iscsi/target/{target}
  • put /api/iscsi/group/{group}
  • put /api/iscsi/target/{target}
  • get /api/iscsi/initiator
  • get /api/iscsi/mapping
  • get /api/iscsi/group
  • get /api/iscsi/target

LREPL

  • put /api/lrepl
  • post /api/lrepl
  • delete /api/lrepl/{pool}/{name}
  • get /api/lrepl

Log

  • post /api/log/~get_csv_logs
  • get /api/log

Module

  • post /api/module
  • get /api/module

NFS

  • post /api/nfs/dir
  • get /api/nfs/dir/{pool}/{name}~create_snapshot
  • delete /api/nfs/dir/{pool}/{name}
  • get /api/nfs/dir
  • get /api/nfs/dir/{pool}/{name}~set_thick

Network

  • post /api/network/phys~create_bond
  • post /api/network/static
  • post /api/network/vip
  • post /api/network/vlan
  • delete /api/network/phys/{name}~delete_bond
  • delete /api/network/phys/{name}
  • post /api/network/static~delete_route
  • delete /api/network/vip/{ip}
  • delete /api/network/vlan/{name}
  • put /api/network/phys/{name}~edit_bond
  • put /api/network/vip/{ip}
  • put /api/network/vlan/{name}
  • get /api/network/phys
  • put /api/network/phys/{name}
  • get /api/network/static
  • get /api/network/vip
  • get /api/network/vlan

RDG

  • post /api/rdg/lun
  • post /api/rdg/pool
  • post /api/rdg/related_clone
  • post /api/rdg/snapclone
  • post /api/rdg/snapshot
  • delete /api/rdg/lun/{pool}/{lun}
  • delete /api/rdg/pool/{name}
  • post /api/rdg/snapshot~delete_group
  • delete /api/rdg/snapshot/{pool}/{lun}/{name}
  • put /api/rdg/lun/{pool}/{lun}
  • put /api/rdg/pool/{name}
  • get /api/rdg/lun
  • get /api/rdg/pool
  • get /api/rdg/snapshot~restore_info
  • get /api/rdg/snapshot
  • get /api/rdg/pool/{name}~switch_controller
  • post /api/rdg/snapshot~restore_rdg
  • post /api/rdg/snapshot~restore_to_object

Rrepl

  • post /api/rrepl/node~add_node
  • post /api/rrepl/node~change_node_status
  • post /api/rrepl/metro~configure
  • post /api/rrepl/node~connect_metro
  • post /api/rrepl/node~connect_node
  • post /api/rrepl/node
  • post /api/rrepl/node~delete_node
  • delete /api/rrepl/node/{name}
  • post /api/rrepl/node~disconnect_metro
  • post /api/rrepl/node~disconnect_node
  • get /api/rrepl/node
  • post /api/rrepl/node~recovery_replication
  • get /api/rrepl/metro~restart_services
  • post /api/rrepl/node~set_primary
  • get /api/rrepl/metro
  • get /api/rrepl/metro~stop_services

SMB

  • post /api/smb/group~add_delete_user
  • post /api/smb/user~change_password
  • post /api/smb/dir
  • post /api/smb/group
  • get /api/smb/dir/{pool}/{name}~create_snapshot
  • post /api/smb/user
  • delete /api/smb/dir/{pool}/{name}
  • delete /api/smb/group/{name}
  • delete /api/smb/user/{name}
  • get /api/smb/dir
  • get /api/smb/group
  • get /api/smb/user
  • get /api/smb/dir/{pool}/{name}~set_thick

Service

  • post /api/service/mail~add_empty_mailing
  • put /api/service/mail~change_mailing_status
  • post /api/service/running_service~change_services_status
  • post /api/service/system_service~change_services_status
  • delete /api/service/mail/{mailing_id}~delete_mailing
  • get /api/service/snmp~get_mib
  • post /api/service/errors_monitoring
  • post /api/service/running_service~generate_logs
  • get /api/service/running_service~get_logs
  • get /api/service/mail
  • get /api/service/snmp
  • get /api/service/snmptrap
  • post /api/service/mail
  • post /api/service/mail~save_mailing
  • post /api/service/snmp
  • post /api/service/snmptrap
  • get /api/service/mail~show_emails
  • get /api/service/errors_monitoring
  • get /api/service/running_service
  • get /api/service/system_service

Sysutils

  • post /api/sysutils/dns
  • post /api/sysutils/ntp
  • get /api/sysutils/system
  • get /api/sysutils/ping~ping
  • delete /api/sysutils/dns/{ip}/{interf}
  • delete /api/sysutils/ntp/{prefix}/{ip}
  • post /api/sysutils/system
  • get /api/sysutils/dns
  • get /api/sysutils/ntp
  • post /api/sysutils/iperf
  • get /api/sysutils/ping~traceroute

Update

  • get /api/update/update
  • post /api/update/update

User

  • post /api/user/password
  • get /api/user/

AD

Up
post /api/ad/ad
Connect Active Directory (connectActiveDirectoryApiAdAdPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body ConnectADSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/ad/ad~disconnect_ad
Disconnect Ad (disconnectAdApiAdAdDisconnectAdPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DeleteADSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/ad/ad
Get Active Directory (getActiveDirectoryApiAdAdGet)

Return type

array[ADInfoSchema]

Example data

Content-Type: application/json
[ {
  "hostname" : "hostname",
  "domain" : "domain",
  "initdate" : 0.8008281904610115,
  "domainIp" : "domainIp",
  "kdcAdmin" : "kdcAdmin",
  "kdcOther" : "kdcOther",
  "account" : "account",
  "netbios" : "netbios"
}, {
  "hostname" : "hostname",
  "domain" : "domain",
  "initdate" : 0.8008281904610115,
  "domainIp" : "domainIp",
  "kdcAdmin" : "kdcAdmin",
  "kdcOther" : "kdcOther",
  "account" : "account",
  "netbios" : "netbios"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Authentication

Up
post /api/auth/token
Login (loginApiAuthTokenPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/x-www-form-urlencoded

Form parameters

grant_type (required)
Form Parameter —
username (required)
Form Parameter —
password (required)
Form Parameter —
scope (required)
Form Parameter —
client_id (required)
Form Parameter —
client_secret (required)
Form Parameter —

Return type

JWTSchema

Example data

Content-Type: application/json
{
  "access_token" : "access_token",
  "token_type" : "token_type"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response JWTSchema

422

Validation Error HTTPValidationError

ConsistencyGroup

Up
post /api/cg/group
Create Cg (createCgApiCgGroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body CgCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/cg/group/{id_num}
Delete Cg (deleteCgApiCgGroupIdNumDelete)

Path parameters

id_num (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/cg/group/{id_num}
Edit Cg (editCgApiCgGroupIdNumPut)

Path parameters

id_num (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body CgEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/cg/group
Get Cg (getCgApiCgGroupGet)

Query parameters

id_num (optional)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/cg/rdg_lun
Get Cg Rdg Lun (getCgRdgLunApiCgRdgLunGet)

Query parameters

cg_id (optional)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

ControllerControl

Up
get /api/power/system~export_configuration
Export Configuration (exportConfigurationApiPowerSystemExportConfigurationGet)

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

Up
get /api/power/system
Get Info (getInfoApiPowerSystemGet)

Return type

array[SystemInfoSchema]

Example data

Content-Type: application/json
[ {
  "adapters" : [ {
    "hostname" : "hostname",
    "ethCount" : 1,
    "diskCount" : 6,
    "fcCount" : 5
  }, {
    "hostname" : "hostname",
    "ethCount" : 1,
    "diskCount" : 6,
    "fcCount" : 5
  } ],
  "software" : [ {
    "hostname" : "hostname",
    "engineType" : "engineType",
    "fwVersion" : "fwVersion",
    "engineSn" : "engineSn"
  }, {
    "hostname" : "hostname",
    "engineType" : "engineType",
    "fwVersion" : "fwVersion",
    "engineSn" : "engineSn"
  } ],
  "scsiAdapters" : [ {
    "nvdata" : "nvdata",
    "hostname" : "hostname",
    "bios" : "bios",
    "name" : "name",
    "model" : "model",
    "state" : "state",
    "type" : "type",
    "firmware" : "firmware"
  }, {
    "nvdata" : "nvdata",
    "hostname" : "hostname",
    "bios" : "bios",
    "name" : "name",
    "model" : "model",
    "state" : "state",
    "type" : "type",
    "firmware" : "firmware"
  } ],
  "controllers" : [ {
    "hostname" : "hostname",
    "connectStatus" : true,
    "rdgStatus" : true,
    "ddpStatus" : true
  }, {
    "hostname" : "hostname",
    "connectStatus" : true,
    "rdgStatus" : true,
    "ddpStatus" : true
  } ],
  "hardware" : [ {
    "hostname" : "hostname",
    "cpuType" : "cpuType",
    "memory" : 0,
    "coresCount" : "coresCount",
    "cpuCount" : "cpuCount"
  }, {
    "hostname" : "hostname",
    "cpuType" : "cpuType",
    "memory" : 0,
    "coresCount" : "coresCount",
    "cpuCount" : "cpuCount"
  } ]
}, {
  "adapters" : [ {
    "hostname" : "hostname",
    "ethCount" : 1,
    "diskCount" : 6,
    "fcCount" : 5
  }, {
    "hostname" : "hostname",
    "ethCount" : 1,
    "diskCount" : 6,
    "fcCount" : 5
  } ],
  "software" : [ {
    "hostname" : "hostname",
    "engineType" : "engineType",
    "fwVersion" : "fwVersion",
    "engineSn" : "engineSn"
  }, {
    "hostname" : "hostname",
    "engineType" : "engineType",
    "fwVersion" : "fwVersion",
    "engineSn" : "engineSn"
  } ],
  "scsiAdapters" : [ {
    "nvdata" : "nvdata",
    "hostname" : "hostname",
    "bios" : "bios",
    "name" : "name",
    "model" : "model",
    "state" : "state",
    "type" : "type",
    "firmware" : "firmware"
  }, {
    "nvdata" : "nvdata",
    "hostname" : "hostname",
    "bios" : "bios",
    "name" : "name",
    "model" : "model",
    "state" : "state",
    "type" : "type",
    "firmware" : "firmware"
  } ],
  "controllers" : [ {
    "hostname" : "hostname",
    "connectStatus" : true,
    "rdgStatus" : true,
    "ddpStatus" : true
  }, {
    "hostname" : "hostname",
    "connectStatus" : true,
    "rdgStatus" : true,
    "ddpStatus" : true
  } ],
  "hardware" : [ {
    "hostname" : "hostname",
    "cpuType" : "cpuType",
    "memory" : 0,
    "coresCount" : "coresCount",
    "cpuCount" : "cpuCount"
  }, {
    "hostname" : "hostname",
    "cpuType" : "cpuType",
    "memory" : 0,
    "coresCount" : "coresCount",
    "cpuCount" : "cpuCount"
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/power/license
Get Licenses (getLicensesApiPowerLicenseGet)

Return type

array[LicenseInfoSchema]

Example data

Content-Type: application/json
[ {
  "hostname" : "hostname",
  "name" : "name",
  "count" : 6,
  "id" : 0,
  "updated" : 1
}, {
  "hostname" : "hostname",
  "name" : "name",
  "count" : 6,
  "id" : 0,
  "updated" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
post /api/power/license~update
Update License (updateLicenseApiPowerLicenseUpdatePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body LicenseEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

DDP

Up
post /api/ddp/lun
Create Lun (createLunApiDdpLunPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpLunCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/ddp/pool
Create Pool (createPoolApiDdpPoolPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpPoolCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/ddp/snapclone
Create Snapclone (createSnapcloneApiDdpSnapclonePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpSnapcloneCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/ddp/snapshot
Create Snapshot (createSnapshotApiDdpSnapshotPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpSnapshotCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/ddp/thinstorage
Create Thinstorage (createThinstorageApiDdpThinstoragePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpThinStorageCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/ddp/lun/{pool}/{lun}
Delete Lun (deleteLunApiDdpLunPoolLunDelete)

Path parameters

pool (required)
Path Parameter —
lun (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/ddp/pool/{name}
Delete Pool (deletePoolApiDdpPoolNameDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/ddp/snapshot/{pool}/{lun}/{name}
Delete Snapshot (deleteSnapshotApiDdpSnapshotPoolLunNameDelete)

Path parameters

pool (required)
Path Parameter —
lun (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/ddp/snapshot~delete_group
Delete Snapshot Group (deleteSnapshotGroupApiDdpSnapshotDeleteGroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpSnapshotDeleteGroupSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/ddp/thinstorage/{pool_name}
Delete Thinstorage (deleteThinstorageApiDdpThinstoragePoolNameDelete)

Path parameters

pool_name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/ddp/lun/{pool}/{lun}
Edit Lun (editLunApiDdpLunPoolLunPut)

Path parameters

pool (required)
Path Parameter —
lun (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpLunEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/ddp/pool/{name}
Edit Pool (editPoolApiDdpPoolNamePut)

Path parameters

name (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpPoolEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/ddp/thinstorage/{pool_name}
Edit Thinstorage (editThinstorageApiDdpThinstoragePoolNamePut)

Path parameters

pool_name (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpThinStorageEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/ddp/pool/{name}~hotspareDisks
Get Hot Spare Disks (getHotSpareDisksApiDdpPoolNameHotspareDisksGet)

Path parameters

name (required)
Path Parameter —

Return type

DdpAutoReplaceDisksSchema

Example data

Content-Type: application/json
{
  "cache" : [ null, null ],
  "data" : [ {
    "minor" : 5,
    "slot" : "",
    "speed" : 3,
    "wwn" : "wwn",
    "encStatus" : "encStatus",
    "logBs" : 1,
    "sasType" : "sasType",
    "physBs" : 2,
    "major" : 5,
    "enclosure" : "enclosure",
    "vendor" : "vendor",
    "model" : "model",
    "id" : 6,
    "power" : "",
    "state" : "state",
    "group" : "group",
    "licensed" : true,
    "driveType" : "driveType",
    "cylinders" : 0,
    "rpm" : 7,
    "target" : "target",
    "size" : 9,
    "serial" : "serial",
    "indication" : true,
    "device" : "device",
    "status" : "status"
  }, {
    "minor" : 5,
    "slot" : "",
    "speed" : 3,
    "wwn" : "wwn",
    "encStatus" : "encStatus",
    "logBs" : 1,
    "sasType" : "sasType",
    "physBs" : 2,
    "major" : 5,
    "enclosure" : "enclosure",
    "vendor" : "vendor",
    "model" : "model",
    "id" : 6,
    "power" : "",
    "state" : "state",
    "group" : "group",
    "licensed" : true,
    "driveType" : "driveType",
    "cylinders" : 0,
    "rpm" : 7,
    "target" : "target",
    "size" : 9,
    "serial" : "serial",
    "indication" : true,
    "device" : "device",
    "status" : "status"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DdpAutoReplaceDisksSchema

422

Validation Error HTTPValidationError

Up
get /api/ddp/lun
Get Luns (getLunsApiDdpLunGet)

Query parameters

lun (optional)
Query Parameter —
pool (optional)
Query Parameter —

Return type

array[DdpLunGetSchema]

Example data

Content-Type: application/json
[ {
  "disks" : [ "", "" ],
  "dataPercent" : 6.027456183070403,
  "lunCached" : true,
  "type" : "type",
  "uuid" : "uuid",
  "sync" : "sync",
  "poolType" : "poolType",
  "cacheDisks" : [ "", "" ],
  "createdAt" : "createdAt",
  "hostname" : "hostname",
  "disksFree" : 5,
  "size" : 0,
  "cacheFree" : 5,
  "qos" : {
    "write_iops" : 9,
    "read_mbs" : 3,
    "write_mbs" : 2,
    "read_iops" : 7
  },
  "name" : "name",
  "alias" : "alias",
  "state" : "state",
  "poolFree" : 1,
  "disksCount" : 2,
  "raid" : "raid"
}, {
  "disks" : [ "", "" ],
  "dataPercent" : 6.027456183070403,
  "lunCached" : true,
  "type" : "type",
  "uuid" : "uuid",
  "sync" : "sync",
  "poolType" : "poolType",
  "cacheDisks" : [ "", "" ],
  "createdAt" : "createdAt",
  "hostname" : "hostname",
  "disksFree" : 5,
  "size" : 0,
  "cacheFree" : 5,
  "qos" : {
    "write_iops" : 9,
    "read_mbs" : 3,
    "write_mbs" : 2,
    "read_iops" : 7
  },
  "name" : "name",
  "alias" : "alias",
  "state" : "state",
  "poolFree" : 1,
  "disksCount" : 2,
  "raid" : "raid"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/ddp/pool
Get Pools (getPoolsApiDdpPoolGet)

Query parameters

name (optional)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/ddp/snapshot~restore_info
Get Snapshot Restore Info (getSnapshotRestoreInfoApiDdpSnapshotRestoreInfoGet)

Query parameters

lun_name (optional)
Query Parameter —

Return type

array[DdpProcessInfoSchema]

Example data

Content-Type: application/json
[ {
  "hostname" : "hostname",
  "lun" : "lun",
  "pool" : "pool",
  "percent" : 0.8008281904610115
}, {
  "hostname" : "hostname",
  "lun" : "lun",
  "pool" : "pool",
  "percent" : 0.8008281904610115
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/ddp/snapshot
Get Snapshots (getSnapshotsApiDdpSnapshotGet)

Query parameters

pool_name (optional)
Query Parameter —
lun_name (optional)
Query Parameter —

Return type

array[DdpSnapshotInfoSchema]

Example data

Content-Type: application/json
[ {
  "parent" : {
    "name" : "name"
  },
  "hostname" : "hostname",
  "lun" : "lun",
  "snapshotType" : "snapshotType",
  "size" : 0,
  "pool" : "pool",
  "name" : "name"
}, {
  "parent" : {
    "name" : "name"
  },
  "hostname" : "hostname",
  "lun" : "lun",
  "snapshotType" : "snapshotType",
  "size" : 0,
  "pool" : "pool",
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/ddp/pool/{name}~switch_controller
Get Switch Pool (getSwitchPoolApiDdpPoolNameSwitchControllerGet)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/ddp/thinstorage
Get Thin Storage (getThinStorageApiDdpThinstorageGet)

Query parameters

pool (required)
Query Parameter —

Return type

array[DdpThinStorageInfoSchema]

Example data

Content-Type: application/json
[ {
  "createdAt" : "createdAt",
  "hostname" : "hostname",
  "freeSize" : 0,
  "size" : "size",
  "disks" : [ "disks", "disks" ],
  "name" : "name",
  "raid" : "raid"
}, {
  "createdAt" : "createdAt",
  "hostname" : "hostname",
  "freeSize" : 0,
  "size" : "size",
  "disks" : [ "disks", "disks" ],
  "name" : "name",
  "raid" : "raid"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
post /api/ddp/snapshot~restore_lun
Restore Lun (restoreLunApiDdpSnapshotRestoreLunPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpSnapshotRestoreLunSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/ddp/snapshot~restore_to_object
Restore Snapshot To Object (restoreSnapshotToObjectApiDdpSnapshotRestoreToObjectPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DdpSnapshotRestoreToObjectSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Disk

Up
get /api/disk
Get Disks (getDisksApiDiskGet)

Return type

array[DiskInfoSchema]

Example data

Content-Type: application/json
[ {
  "minor" : 5,
  "slot" : "",
  "speed" : 3,
  "wwn" : "wwn",
  "encStatus" : "encStatus",
  "logBs" : 1,
  "sasType" : "sasType",
  "physBs" : 2,
  "major" : 5,
  "enclosure" : "enclosure",
  "vendor" : "vendor",
  "model" : "model",
  "id" : 6,
  "power" : "",
  "state" : "state",
  "group" : "group",
  "licensed" : true,
  "driveType" : "driveType",
  "cylinders" : 0,
  "rpm" : 7,
  "target" : "target",
  "size" : 9,
  "serial" : "serial",
  "indication" : true,
  "device" : "device",
  "status" : "status"
}, {
  "minor" : 5,
  "slot" : "",
  "speed" : 3,
  "wwn" : "wwn",
  "encStatus" : "encStatus",
  "logBs" : 1,
  "sasType" : "sasType",
  "physBs" : 2,
  "major" : 5,
  "enclosure" : "enclosure",
  "vendor" : "vendor",
  "model" : "model",
  "id" : 6,
  "power" : "",
  "state" : "state",
  "group" : "group",
  "licensed" : true,
  "driveType" : "driveType",
  "cylinders" : 0,
  "rpm" : 7,
  "target" : "target",
  "size" : 9,
  "serial" : "serial",
  "indication" : true,
  "device" : "device",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

FC

Up
post /api/fc/group
Create Fc Group (createFcGroupApiFcGroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body FCTargetGroupSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/fc/mapping
Create Fc Mapping (createFcMappingApiFcMappingPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body FCCreateMappingSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/fc/group/{group}
Delete Fc Group (deleteFcGroupApiFcGroupGroupDelete)

Path parameters

group (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/fc/mapping/{group}/{pool}/{lun}
Delete Fc Mapping (deleteFcMappingApiFcMappingGroupPoolLunDelete)

Path parameters

group (required)
Path Parameter —
pool (required)
Path Parameter —
lun (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/fc/group/{group}
Edit Fc Group (editFcGroupApiFcGroupGroupPut)

Path parameters

group (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body FCTargetPutGroupSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/fc/target/mode
Get Fc Driver Mode (getFcDriverModeApiFcTargetModeGet)

Return type

array[FCTargetGetQliniModeSchema]

Example data

Content-Type: application/json
[ {
  "hostname" : "hostname",
  "qliniMode" : "qliniMode"
}, {
  "hostname" : "hostname",
  "qliniMode" : "qliniMode"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/fc/initiator
Get Fc Initiators (getFcInitiatorsApiFcInitiatorGet)

Return type

array[FCInitInfoSchema]

Example data

Content-Type: application/json
[ {
  "hostname" : "hostname",
  "driver" : "driver",
  "initiator" : "initiator",
  "alias" : "alias",
  "portName" : "portName",
  "group" : "group"
}, {
  "hostname" : "hostname",
  "driver" : "driver",
  "initiator" : "initiator",
  "alias" : "alias",
  "portName" : "portName",
  "group" : "group"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/fc/mapping
Get Fc Mapping (getFcMappingApiFcMappingGet)

Query parameters

pool (optional)
Query Parameter —
lun (optional)
Query Parameter —

Return type

array[FCMappingSchema]

Example data

Content-Type: application/json
[ {
  "naaId" : "naaId",
  "lun" : "lun",
  "replId" : "replId",
  "pool" : "pool",
  "lunid" : 0,
  "thinProvisioned" : true,
  "alias" : "alias",
  "alua" : true,
  "rotational" : true,
  "portName" : [ "portName", "portName" ],
  "outOfSync" : true,
  "group" : "group"
}, {
  "naaId" : "naaId",
  "lun" : "lun",
  "replId" : "replId",
  "pool" : "pool",
  "lunid" : 0,
  "thinProvisioned" : true,
  "alias" : "alias",
  "alua" : true,
  "rotational" : true,
  "portName" : [ "portName", "portName" ],
  "outOfSync" : true,
  "group" : "group"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/fc/target
Get Fc Ports (getFcPortsApiFcTargetGet)

Return type

array[FCTargetInfoSchema]

Example data

Content-Type: application/json
[ {
  "supportedSpeeds" : "supportedSpeeds",
  "hostname" : "hostname",
  "portState" : "portState",
  "supportedClasses" : "supportedClasses",
  "symbolicName" : "symbolicName",
  "portStatus" : true,
  "portName" : "portName",
  "speed" : "speed",
  "qliniMode" : true
}, {
  "supportedSpeeds" : "supportedSpeeds",
  "hostname" : "hostname",
  "portState" : "portState",
  "supportedClasses" : "supportedClasses",
  "symbolicName" : "symbolicName",
  "portStatus" : true,
  "portName" : "portName",
  "speed" : "speed",
  "qliniMode" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/fc/group
Get Fc Target Groups (getFcTargetGroupsApiFcGroupGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[FCTargetGroupInfoSchema]

Example data

Content-Type: application/json
[ {
  "access" : [ {
    "hostname" : "hostname",
    "portName" : "portName",
    "initiators" : [ {
      "initiator" : "initiator",
      "alias" : "alias"
    }, {
      "initiator" : "initiator",
      "alias" : "alias"
    } ]
  }, {
    "hostname" : "hostname",
    "portName" : "portName",
    "initiators" : [ {
      "initiator" : "initiator",
      "alias" : "alias"
    }, {
      "initiator" : "initiator",
      "alias" : "alias"
    } ]
  } ],
  "luns" : [ "luns", "luns" ],
  "group" : "group"
}, {
  "access" : [ {
    "hostname" : "hostname",
    "portName" : "portName",
    "initiators" : [ {
      "initiator" : "initiator",
      "alias" : "alias"
    }, {
      "initiator" : "initiator",
      "alias" : "alias"
    } ]
  }, {
    "hostname" : "hostname",
    "portName" : "portName",
    "initiators" : [ {
      "initiator" : "initiator",
      "alias" : "alias"
    }, {
      "initiator" : "initiator",
      "alias" : "alias"
    } ]
  } ],
  "luns" : [ "luns", "luns" ],
  "group" : "group"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
put /api/fc/target/rescan
Rescan Fc Ports (rescanFcPortsApiFcTargetRescanPut)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body FCTargetRescanSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/fc/mapping/{group}/{pool}/{lun}
Restore Fc Mapping (restoreFcMappingApiFcMappingGroupPoolLunPut)

Path parameters

group (required)
Path Parameter —
pool (required)
Path Parameter —
lun (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body FCRestoreMappingSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/fc/initiator/{initiator}
Set Initiator Alias (setInitiatorAliasApiFcInitiatorInitiatorPut)

Path parameters

initiator (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body FCInitAliasSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/fc/target/mode
Switch Driver Mode (switchDriverModeApiFcTargetModePut)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body FCTargetSetQliniModeSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

ISCSI

Up
post /api/iscsi/group
Create Iscsi Group (createIscsiGroupApiIscsiGroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body IscsiGroupCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/iscsi/mapping
Create Iscsi Mapping (createIscsiMappingApiIscsiMappingPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body IscsiMappingCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/iscsi/target
Create Iscsi Target (createIscsiTargetApiIscsiTargetPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body IscsiTargetCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/iscsi/group/{group}
Delete Iscsi Group (deleteIscsiGroupApiIscsiGroupGroupDelete)

Path parameters

group (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/iscsi/mapping/{group}/{pool}/{lun}
Delete Iscsi Mapping (deleteIscsiMappingApiIscsiMappingGroupPoolLunDelete)

Path parameters

group (required)
Path Parameter —
pool (required)
Path Parameter —
lun (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/iscsi/target/{target}
Delete Iscsi Target (deleteIscsiTargetApiIscsiTargetTargetDelete)

Path parameters

target (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/iscsi/group/{group}
Edit Iscsi Group (editIscsiGroupApiIscsiGroupGroupPut)

Path parameters

group (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body IscsiGroupEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/iscsi/target/{target}
Edit Iscsi Target (editIscsiTargetApiIscsiTargetTargetPut)

Path parameters

target (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body IscsiTargetEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/iscsi/initiator
Get Iscsi Initiators (getIscsiInitiatorsApiIscsiInitiatorGet)

Query parameters

init (optional)
Query Parameter —

Return type

array[IscsiInitiatorInfoSchema]

Example data

Content-Type: application/json
[ {
  "init" : "init",
  "engine" : "engine",
  "alias" : "alias",
  "target" : "target",
  "group" : "group"
}, {
  "init" : "init",
  "engine" : "engine",
  "alias" : "alias",
  "target" : "target",
  "group" : "group"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/iscsi/mapping
Get Iscsi Mappings (getIscsiMappingsApiIscsiMappingGet)

Return type

array[IscsiMappingInfoSchema]

Example data

Content-Type: application/json
[ {
  "naaId" : "naaId",
  "lun" : "lun",
  "lunid" : "lunid",
  "alias" : "alias",
  "alua" : true,
  "group" : "group",
  "target" : "target"
}, {
  "naaId" : "naaId",
  "lun" : "lun",
  "lunid" : "lunid",
  "alias" : "alias",
  "alua" : true,
  "group" : "group",
  "target" : "target"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/iscsi/group
Get Iscsi Qroups (getIscsiQroupsApiIscsiGroupGet)

Query parameters

group (optional)
Query Parameter —

Return type

array[IscsiGroupInfoSchema]

Example data

Content-Type: application/json
[ {
  "inits" : [ "", "" ],
  "luns" : [ "", "" ],
  "group" : "group",
  "target" : { }
}, {
  "inits" : [ "", "" ],
  "luns" : [ "", "" ],
  "group" : "group",
  "target" : { }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/iscsi/target
Get Iscsi Target (getIscsiTargetApiIscsiTargetGet)

Query parameters

target (optional)
Query Parameter —

Return type

array[IscsiTargetInfoSchema]

Example data

Content-Type: application/json
[ {
  "rdma" : true,
  "portals" : [ "", "" ],
  "users" : [ "", "" ],
  "target" : "target"
}, {
  "rdma" : true,
  "portals" : [ "", "" ],
  "users" : [ "", "" ],
  "target" : "target"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

LREPL

Up
put /api/lrepl
Change Replication Status (changeReplicationStatusApiLreplPut)

Query parameters

lun (required)
Query Parameter —
name (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/lrepl
Create Or Edit Replication (createOrEditReplicationApiLreplPost)

Query parameters

lun (required)
Query Parameter —
name (required)
Query Parameter —
copies (required)
Query Parameter —
frequency (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/lrepl/{pool}/{name}
Delete Replication (deleteReplicationApiLreplPoolNameDelete)

Path parameters

pool (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/lrepl
Show All Replications (showAllReplicationsApiLreplGet)

Return type

array[LreplSchema]

Example data

Content-Type: application/json
[ {
  "lun" : "lun",
  "source" : "source",
  "type" : "type",
  "name_snapshot" : "name_snapshot",
  "script" : "script",
  "frequency" : 6,
  "thin" : true,
  "copies" : 0,
  "last_start" : 1,
  "next_time" : "next_time",
  "rdg" : "rdg",
  "last_time" : "last_time",
  "name_script" : "name_script",
  "name" : "name",
  "status" : "status"
}, {
  "lun" : "lun",
  "source" : "source",
  "type" : "type",
  "name_snapshot" : "name_snapshot",
  "script" : "script",
  "frequency" : 6,
  "thin" : true,
  "copies" : 0,
  "last_start" : 1,
  "next_time" : "next_time",
  "rdg" : "rdg",
  "last_time" : "last_time",
  "name_script" : "name_script",
  "name" : "name",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Log

Up
post /api/log/~get_csv_logs
Get Csv Logs (getCsvLogsApiLogGetCsvLogsPost)

Query parameters

from_time (optional)
Query Parameter —
to_time (optional)
Query Parameter —

Return type

CsvLogsSchema

Example data

Content-Type: application/json
{
  "path" : "path",
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response CsvLogsSchema

422

Validation Error HTTPValidationError

Up
get /api/log
Show Local Logs (showLocalLogsApiLogGet)

Query parameters

limit (required)
Query Parameter —
min_id (optional)
Query Parameter —

Return type

array[LogSchema]

Example data

Content-Type: application/json
[ {
  "code" : "code",
  "engine" : "engine",
  "id" : 0,
  "time" : "time",
  "message" : "message",
  "status" : "status"
}, {
  "code" : "code",
  "engine" : "engine",
  "id" : 0,
  "time" : "time",
  "message" : "message",
  "status" : "status"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Module

Up
post /api/module
Change Module Status (changeModuleStatusApiModulePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body PostModuleSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/module
Show Modules (showModulesApiModuleGet)

Query parameters

module (optional)
Query Parameter —

Return type

array[GetModuleSchema]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "state" : "state",
  "services" : [ { }, { } ]
}, {
  "name" : "name",
  "state" : "state",
  "services" : [ { }, { } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

NFS

Up
post /api/nfs/dir
Create Dir (createDirApiNfsDirPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body schemas__nfs__DirCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/nfs/dir/{pool}/{name}~create_snapshot
Create Snapshot (createSnapshotApiNfsDirPoolNameCreateSnapshotGet)

Path parameters

pool (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/nfs/dir/{pool}/{name}
Delete Nfs Dir (deleteNfsDirApiNfsDirPoolNameDelete)

Path parameters

pool (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/nfs/dir
Get Dirs (getDirsApiNfsDirGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[schemas__nfs__DirInfoSchema]

Example data

Content-Type: application/json
[ {
  "blocksize" : "blocksize",
  "lunType" : "lunType",
  "subtreeCheck" : true,
  "usedSpace" : "usedSpace",
  "isAsync" : true,
  "pool" : "pool",
  "hostname" : "hostname",
  "localUsername" : "localUsername",
  "availableSpace" : "availableSpace",
  "noRootSquash" : true,
  "quota" : "quota",
  "name" : "name",
  "readAccess" : [ {
    "ip" : "ip",
    "mask" : 0
  }, {
    "ip" : "ip",
    "mask" : 0
  } ],
  "writeAccess" : [ null, null ],
  "localGroupName" : "localGroupName",
  "allSquash" : true
}, {
  "blocksize" : "blocksize",
  "lunType" : "lunType",
  "subtreeCheck" : true,
  "usedSpace" : "usedSpace",
  "isAsync" : true,
  "pool" : "pool",
  "hostname" : "hostname",
  "localUsername" : "localUsername",
  "availableSpace" : "availableSpace",
  "noRootSquash" : true,
  "quota" : "quota",
  "name" : "name",
  "readAccess" : [ {
    "ip" : "ip",
    "mask" : 0
  }, {
    "ip" : "ip",
    "mask" : 0
  } ],
  "writeAccess" : [ null, null ],
  "localGroupName" : "localGroupName",
  "allSquash" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/nfs/dir/{pool}/{name}~set_thick
Set Thick (setThickApiNfsDirPoolNameSetThickGet)

Path parameters

pool (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Network

Up
post /api/network/phys~create_bond
Create Bond (createBondApiNetworkPhysCreateBondPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body BondCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/network/static
Create Static Route (createStaticRouteApiNetworkStaticPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body StaticRouteCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/network/vip
Create Vip (createVipApiNetworkVipPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body VipCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/network/vlan
Create Vlan (createVlanApiNetworkVlanPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body VlanCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/network/phys/{name}~delete_bond
Delete Bond (deleteBondApiNetworkPhysNameDeleteBondDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/network/phys/{name}
Delete Physical Interface (deletePhysicalInterfaceApiNetworkPhysNameDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/network/static~delete_route
Delete Static Route (deleteStaticRouteApiNetworkStaticDeleteRoutePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body StaticRouteDeleteSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/network/vip/{ip}
Delete Vip (deleteVipApiNetworkVipIpDelete)

Path parameters

ip (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/network/vlan/{name}
Delete Vlan (deleteVlanApiNetworkVlanNameDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/network/phys/{name}~edit_bond
Edit Bond (editBondApiNetworkPhysNameEditBondPut)

Path parameters

name (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body BondEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/network/vip/{ip}
Edit Vip (editVipApiNetworkVipIpPut)

Path parameters

ip (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body VipEditStateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/network/vlan/{name}
Edit Vlan (editVlanApiNetworkVlanNamePut)

Path parameters

name (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body VlanEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/network/phys
Get Physical Interface (getPhysicalInterfaceApiNetworkPhysGet)

Return type

array[PhysInterfaceInfoSchema]

Example data

Content-Type: application/json
[ {
  "parent" : { },
  "slotPort" : "slotPort",
  "ip" : "ip",
  "duplex" : "duplex",
  "portName" : "portName",
  "maxSpeed" : "maxSpeed",
  "currentSpeed" : "currentSpeed",
  "mac" : "mac",
  "mtu" : 0,
  "hostname" : "hostname",
  "state" : true,
  "gateway" : "gateway",
  "mask" : "mask"
}, {
  "parent" : { },
  "slotPort" : "slotPort",
  "ip" : "ip",
  "duplex" : "duplex",
  "portName" : "portName",
  "maxSpeed" : "maxSpeed",
  "currentSpeed" : "currentSpeed",
  "mac" : "mac",
  "mtu" : 0,
  "hostname" : "hostname",
  "state" : true,
  "gateway" : "gateway",
  "mask" : "mask"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
put /api/network/phys/{name}
Get Physical Interface (getPhysicalInterfaceApiNetworkPhysNamePut)

Path parameters

name (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body PhysInterfaceEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/network/static
Get Static Route (getStaticRouteApiNetworkStaticGet)

Return type

array[StaticRouteInfoSchema]

Example data

Content-Type: application/json
[ {
  "hostname" : "hostname",
  "networkIp" : "networkIp",
  "ip" : "ip",
  "networkMask" : "networkMask",
  "interface" : "interface",
  "gateway" : "gateway"
}, {
  "hostname" : "hostname",
  "networkIp" : "networkIp",
  "ip" : "ip",
  "networkMask" : "networkMask",
  "interface" : "interface",
  "gateway" : "gateway"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/network/vip
Get Vips (getVipsApiNetworkVipGet)

Query parameters

ip (optional)
Query Parameter —

Return type

array[VipGetSchema]

Example data

Content-Type: application/json
[ {
  "int0" : "int0",
  "rtype" : "rtype",
  "hostname" : "hostname",
  "int1" : "int1",
  "metro" : 0,
  "ip" : "ip",
  "name" : "name",
  "repl" : 6,
  "state" : "state",
  "poolType" : "poolType",
  "mask" : "mask",
  "poolName" : "poolName"
}, {
  "int0" : "int0",
  "rtype" : "rtype",
  "hostname" : "hostname",
  "int1" : "int1",
  "metro" : 0,
  "ip" : "ip",
  "name" : "name",
  "repl" : 6,
  "state" : "state",
  "poolType" : "poolType",
  "mask" : "mask",
  "poolName" : "poolName"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/network/vlan
Get Vlans (getVlansApiNetworkVlanGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[VlanGetSchema]

Example data

Content-Type: application/json
[ {
  "vId" : 6,
  "hostname" : "hostname",
  "ip" : "ip",
  "isGlobal" : true,
  "name" : "name",
  "state" : "state",
  "physInterface" : "physInterface",
  "isBond" : true,
  "gateway" : "gateway",
  "mask" : "mask",
  "mtu" : 0
}, {
  "vId" : 6,
  "hostname" : "hostname",
  "ip" : "ip",
  "isGlobal" : true,
  "name" : "name",
  "state" : "state",
  "physInterface" : "physInterface",
  "isBond" : true,
  "gateway" : "gateway",
  "mask" : "mask",
  "mtu" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

RDG

Up
post /api/rdg/lun
Create Lun (createLunApiRdgLunPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgLunCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rdg/pool
Create Pool (createPoolApiRdgPoolPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgPoolCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rdg/related_clone
Create Rdg Related Clone (createRdgRelatedCloneApiRdgRelatedClonePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgRelatedCloneNameSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rdg/snapclone
Create Rdg Snapclone (createRdgSnapcloneApiRdgSnapclonePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgSnapcloneNameSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rdg/snapshot
Create Snapshot (createSnapshotApiRdgSnapshotPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgSnapshotNameSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/rdg/lun/{pool}/{lun}
Delete Lun (deleteLunApiRdgLunPoolLunDelete)

Path parameters

lun (required)
Path Parameter —
pool (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/rdg/pool/{name}
Delete Pool (deletePoolApiRdgPoolNameDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rdg/snapshot~delete_group
Delete Rdg Snap Group (deleteRdgSnapGroupApiRdgSnapshotDeleteGroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgSnapshotDeleteGroup (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/rdg/snapshot/{pool}/{lun}/{name}
Delete Snapshot (deleteSnapshotApiRdgSnapshotPoolLunNameDelete)

Path parameters

lun (required)
Path Parameter —
name (required)
Path Parameter —
pool (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/rdg/lun/{pool}/{lun}
Edit Lun (editLunApiRdgLunPoolLunPut)

Path parameters

lun (required)
Path Parameter —
pool (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgLunEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
put /api/rdg/pool/{name}
Edit Pool (editPoolApiRdgPoolNamePut)

Path parameters

name (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgPoolEditSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/rdg/lun
Get Luns (getLunsApiRdgLunGet)

Query parameters

pool (optional)
Query Parameter —
lun (optional)
Query Parameter —

Return type

array[RdgLunInfoSchema]

Example data

Content-Type: application/json
[ {
  "aerodiskBlkioThrottleReadBpsDevice" : 1,
  "aerodiskBlkioThrottleWriteIopsDevice" : 6,
  "aerodiskBlkioThrottleWriteBpsDevice" : 1,
  "origin" : "origin",
  "available" : 1,
  "used" : 6,
  "compressratio" : 5.637376656633329,
  "refreservation" : 2,
  "volblocksize" : 3,
  "aerodiskType" : "aerodiskType",
  "hostname" : "hostname",
  "readonly" : true,
  "usedbychildren" : 1,
  "reservation" : 7,
  "creation" : 0,
  "aerodiskModelDisk" : "aerodiskModelDisk",
  "aerodiskBlkioThrottleReadIopsDevice" : 7,
  "aerodiskHotspare" : true,
  "lunType" : "lunType",
  "clones" : [ "", "" ],
  "usedbydataset" : 7,
  "volsize" : 9,
  "usedbyrefreservation" : 1,
  "sync" : "sync",
  "poolType" : "poolType",
  "dedup" : true,
  "refcompressratio" : 2.3021358869347655,
  "referenced" : 5,
  "aerodiskDiskLogicalBlockSize" : 4,
  "name" : "name",
  "usedbysnapshots" : 4,
  "aerodiskAlias" : "aerodiskAlias",
  "compression" : true
}, {
  "aerodiskBlkioThrottleReadBpsDevice" : 1,
  "aerodiskBlkioThrottleWriteIopsDevice" : 6,
  "aerodiskBlkioThrottleWriteBpsDevice" : 1,
  "origin" : "origin",
  "available" : 1,
  "used" : 6,
  "compressratio" : 5.637376656633329,
  "refreservation" : 2,
  "volblocksize" : 3,
  "aerodiskType" : "aerodiskType",
  "hostname" : "hostname",
  "readonly" : true,
  "usedbychildren" : 1,
  "reservation" : 7,
  "creation" : 0,
  "aerodiskModelDisk" : "aerodiskModelDisk",
  "aerodiskBlkioThrottleReadIopsDevice" : 7,
  "aerodiskHotspare" : true,
  "lunType" : "lunType",
  "clones" : [ "", "" ],
  "usedbydataset" : 7,
  "volsize" : 9,
  "usedbyrefreservation" : 1,
  "sync" : "sync",
  "poolType" : "poolType",
  "dedup" : true,
  "refcompressratio" : 2.3021358869347655,
  "referenced" : 5,
  "aerodiskDiskLogicalBlockSize" : 4,
  "name" : "name",
  "usedbysnapshots" : 4,
  "aerodiskAlias" : "aerodiskAlias",
  "compression" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/rdg/pool
Get Pools (getPoolsApiRdgPoolGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[null]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response array[null]

422

Validation Error HTTPValidationError

Up
get /api/rdg/snapshot~restore_info
Get Snapshot Restore Info (getSnapshotRestoreInfoApiRdgSnapshotRestoreInfoGet)

Query parameters

pool (required)
Query Parameter —

Return type

array[RdgSnapshotRestoreInfoSchema]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "type" : "rdg_pool",
  "title" : "Перестроение группы",
  "percent" : 0.8008281904610115
}, {
  "name" : "name",
  "type" : "rdg_pool",
  "title" : "Перестроение группы",
  "percent" : 0.8008281904610115
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/rdg/snapshot
Get Snapshots (getSnapshotsApiRdgSnapshotGet)

Query parameters

snapshot_name (optional)
Query Parameter —

Return type

array[RdgSnapshotInfoSchema]

Example data

Content-Type: application/json
[ {
  "hostname" : "hostname",
  "name" : "name",
  "used" : 0
}, {
  "hostname" : "hostname",
  "name" : "name",
  "used" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/rdg/pool/{name}~switch_controller
Get Switch Poll (getSwitchPollApiRdgPoolNameSwitchControllerGet)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rdg/snapshot~restore_rdg
Snapshot Restore Rdg (snapshotRestoreRdgApiRdgSnapshotRestoreRdgPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgSnapshotRestoreRdgSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rdg/snapshot~restore_to_object
Snapshot Restore To Object (snapshotRestoreToObjectApiRdgSnapshotRestoreToObjectPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RdgSnapshotRestoreToObjSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Rrepl

Up
post /api/rrepl/node~add_node
Add Node (addNodeApiRreplNodeAddNodePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body AddNodeSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node~change_node_status
Change Node Status (changeNodeStatusApiRreplNodeChangeNodeStatusPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body ChangeNodeStatusSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/metro~configure
Configure (configureApiRreplMetroConfigurePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body MetroConfigureSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node~connect_metro
Connect Metro (connectMetroApiRreplNodeConnectMetroPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body ConnectMetroSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node~connect_node
Connect Node (connectNodeApiRreplNodeConnectNodePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body ActivateDeactivateNodeSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node
Create Rrepl (createRreplApiRreplNodePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RreplCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node~delete_node
Delete Node (deleteNodeApiRreplNodeDeleteNodePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DeleteNodeSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/rrepl/node/{name}
Delete Rrepl (deleteRreplApiRreplNodeNameDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node~disconnect_metro
Disconnect Metro (disconnectMetroApiRreplNodeDisconnectMetroPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body DisconnectMetroSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node~disconnect_node
Disconnect Node (disconnectNodeApiRreplNodeDisconnectNodePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body ActivateDeactivateNodeSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/rrepl/node
Get Rrepl (getRreplApiRreplNodeGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[RreplInfoSchema]

Example data

Content-Type: application/json
[ {
  "nodes" : [ {
    "linkStatus" : "linkStatus",
    "protocol" : "protocol",
    "role" : "role",
    "lun" : "lun",
    "metro" : "metro",
    "ip" : "ip",
    "name" : "name",
    "lunState" : "lunState",
    "type" : "type",
    "nodeId" : "nodeId",
    "local" : true
  }, {
    "linkStatus" : "linkStatus",
    "protocol" : "protocol",
    "role" : "role",
    "lun" : "lun",
    "metro" : "metro",
    "ip" : "ip",
    "name" : "name",
    "lunState" : "lunState",
    "type" : "type",
    "nodeId" : "nodeId",
    "local" : true
  } ],
  "deviceId" : 0
}, {
  "nodes" : [ {
    "linkStatus" : "linkStatus",
    "protocol" : "protocol",
    "role" : "role",
    "lun" : "lun",
    "metro" : "metro",
    "ip" : "ip",
    "name" : "name",
    "lunState" : "lunState",
    "type" : "type",
    "nodeId" : "nodeId",
    "local" : true
  }, {
    "linkStatus" : "linkStatus",
    "protocol" : "protocol",
    "role" : "role",
    "lun" : "lun",
    "metro" : "metro",
    "ip" : "ip",
    "name" : "name",
    "lunState" : "lunState",
    "type" : "type",
    "nodeId" : "nodeId",
    "local" : true
  } ],
  "deviceId" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
post /api/rrepl/node~recovery_replication
Recovery Replication (recoveryReplicationApiRreplNodeRecoveryReplicationPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body RecoveryReplicationSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/rrepl/metro~restart_services
Restart Services (restartServicesApiRreplMetroRestartServicesGet)

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

Up
post /api/rrepl/node~set_primary
Set Primary (setPrimaryApiRreplNodeSetPrimaryPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body SetPrimarySchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/rrepl/metro
Show Metro (showMetroApiRreplMetroGet)

Return type

array[MetroInfoSchema]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "state" : true,
  "key" : "key"
}, {
  "name" : "name",
  "state" : true,
  "key" : "key"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/rrepl/metro~stop_services
Stop Services (stopServicesApiRreplMetroStopServicesGet)

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

SMB

Up
post /api/smb/group~add_delete_user
Add Delete User (addDeleteUserApiSmbGroupAddDeleteUserPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body UserToGroupAddSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/smb/user~change_password
Change Password (changePasswordApiSmbUserChangePasswordPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body ChangePasswordSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/smb/dir
Create Dir (createDirApiSmbDirPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body schemas__smb__DirCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/smb/group
Create Group (createGroupApiSmbGroupPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body GroupCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/smb/dir/{pool}/{name}~create_snapshot
Create Snapshot (createSnapshotApiSmbDirPoolNameCreateSnapshotGet)

Path parameters

pool (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/smb/user
Create User (createUserApiSmbUserPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body UserCreateSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/smb/dir/{pool}/{name}
Delete Dir (deleteDirApiSmbDirPoolNameDelete)

Path parameters

pool (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/smb/group/{name}
Delete Group (deleteGroupApiSmbGroupNameDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/smb/user/{name}
Delete User (deleteUserApiSmbUserNameDelete)

Path parameters

name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/smb/dir
Get Dir (getDirApiSmbDirGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[schemas__smb__DirInfoSchema]

Example data

Content-Type: application/json
[ {
  "blocksize" : "blocksize",
  "lunType" : "lunType",
  "isInheritOnCreate" : false,
  "adminGroups" : [ "", "" ],
  "pool" : "pool",
  "groups" : [ "", "" ],
  "used" : "used",
  "isInherit" : false,
  "availableSize" : "availableSize",
  "users" : [ "", "" ],
  "accessIsAllowed" : [ "", "" ],
  "adminUsers" : [ "", "" ],
  "hostname" : "hostname",
  "readonly" : false,
  "quota" : "quota",
  "name" : "name",
  "onlyOwnerCanDelete" : false
}, {
  "blocksize" : "blocksize",
  "lunType" : "lunType",
  "isInheritOnCreate" : false,
  "adminGroups" : [ "", "" ],
  "pool" : "pool",
  "groups" : [ "", "" ],
  "used" : "used",
  "isInherit" : false,
  "availableSize" : "availableSize",
  "users" : [ "", "" ],
  "accessIsAllowed" : [ "", "" ],
  "adminUsers" : [ "", "" ],
  "hostname" : "hostname",
  "readonly" : false,
  "quota" : "quota",
  "name" : "name",
  "onlyOwnerCanDelete" : false
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/smb/group
Get Groups (getGroupsApiSmbGroupGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[GroupInfoSchema]

Example data

Content-Type: application/json
[ {
  "adminGroups" : [ "", "" ],
  "groups" : [ "", "" ],
  "unixGroups" : [ {
    "name" : "name",
    "users" : [ "", "" ]
  }, {
    "name" : "name",
    "users" : [ "", "" ]
  } ]
}, {
  "adminGroups" : [ "", "" ],
  "groups" : [ "", "" ],
  "unixGroups" : [ {
    "name" : "name",
    "users" : [ "", "" ]
  }, {
    "name" : "name",
    "users" : [ "", "" ]
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/smb/user
Get Users (getUsersApiSmbUserGet)

Query parameters

name (optional)
Query Parameter —

Return type

array[UserInfoSchema]

Example data

Content-Type: application/json
[ {
  "users" : [ "", "" ],
  "adminUsers" : [ "", "" ],
  "unixUsers" : [ "", "" ]
}, {
  "users" : [ "", "" ],
  "adminUsers" : [ "", "" ],
  "unixUsers" : [ "", "" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/smb/dir/{pool}/{name}~set_thick
Set Thick (setThickApiSmbDirPoolNameSetThickGet)

Path parameters

pool (required)
Path Parameter —
name (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Service

Up
post /api/service/mail~add_empty_mailing
Add Empty Mailing (addEmptyMailingApiServiceMailAddEmptyMailingPost)

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

Up
put /api/service/mail~change_mailing_status
Change Mailing Status (changeMailingStatusApiServiceMailChangeMailingStatusPut)

Query parameters

status (required)
Query Parameter —
id (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/service/running_service~change_services_status
Change Systemctl Status (changeSystemctlStatusApiServiceRunningServiceChangeServicesStatusPost)

Query parameters

service_name (required)
Query Parameter —
action (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/service/system_service~change_services_status
Change Systemctl Status (changeSystemctlStatusApiServiceSystemServiceChangeServicesStatusPost)

Query parameters

service_name (required)
Query Parameter —
action (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/service/mail/{mailing_id}~delete_mailing
Delete Mailing (deleteMailingApiServiceMailMailingIdDeleteMailingDelete)

Path parameters

mailing_id (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/service/snmp~get_mib
Download Mib (downloadMibApiServiceSnmpGetMibGet)

Return type

MibSchema

Example data

Content-Type: application/json
{
  "link" : "link"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response MibSchema

Up
post /api/service/errors_monitoring
Edit Service (editServiceApiServiceErrorsMonitoringPost)

Query parameters

name (required)
Query Parameter —
active (optional)
Query Parameter —
set_time (optional)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/service/running_service~generate_logs
Generate Arch Logs (generateArchLogsApiServiceRunningServiceGenerateLogsPost)

Query parameters

info (optional)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/service/running_service~get_logs
Get Arch Logs (getArchLogsApiServiceRunningServiceGetLogsGet)

Return type

array[ServiceSystemLogsSchema]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "message" : "message"
}, {
  "name" : "name",
  "message" : "message"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/service/mail
Get Data Mail (getDataMailApiServiceMailGet)

Return type

array[EmailSchema]

Example data

Content-Type: application/json
[ {
  "password" : "password",
  "starttls" : "starttls",
  "port" : "port",
  "sender" : "sender",
  "host" : "host",
  "id" : 0,
  "user" : "user",
  "status" : true
}, {
  "password" : "password",
  "starttls" : "starttls",
  "port" : "port",
  "sender" : "sender",
  "host" : "host",
  "id" : 0,
  "user" : "user",
  "status" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/service/snmp
Get Snmp Info Local (getSnmpInfoLocalApiServiceSnmpGet)

Return type

SNMPSchema

Example data

Content-Type: application/json
{
  "snmp3_state" : "snmp3_state",
  "snmp2_community_name" : "snmp2_community_name",
  "snmp2_state" : "snmp2_state",
  "snmp3_users" : "snmp3_users"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response SNMPSchema

Up
get /api/service/snmptrap
Get Snmptrap Settings (getSnmptrapSettingsApiServiceSnmptrapGet)

Return type

SNMPTrapSchema

Example data

Content-Type: application/json
{
  "replication" : true,
  "cluster" : true,
  "disk" : true,
  "dg" : true,
  "memory" : true,
  "ip" : "ip",
  "sensor" : true,
  "snmp_trap_daemon_status" : "snmp_trap_daemon_status",
  "fc" : true,
  "frequency" : "frequency",
  "ram" : true,
  "target" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response SNMPTrapSchema

Up
post /api/service/mail
Save Mail (saveMailApiServiceMailPost)

Query parameters

host (required)
Query Parameter —
id (required)
Query Parameter —
password (required)
Query Parameter —
port (required)
Query Parameter —
sender (required)
Query Parameter —
starttls (required)
Query Parameter —
user (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/service/mail~save_mailing
Save Mailing (saveMailingApiServiceMailSaveMailingPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body MailingSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/service/snmp
Set Snmp Settings (setSnmpSettingsApiServiceSnmpPost)

Query parameters

snmp3_state (optional)
Query Parameter — default: Off
snmp2_state (optional)
Query Parameter — default: On
snmp_user_name (optional)
Query Parameter —
snmp_community_name (optional)
Query Parameter — default: public
snmp_user_password (optional)
Query Parameter —
snmp_user_confirm_password (optional)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/service/snmptrap
Set Snmptrap Settings (setSnmptrapSettingsApiServiceSnmptrapPost)

Query parameters

snmp_trap_daemon_status (required)
Query Parameter —
ip (required)
Query Parameter —
frequency (required)
Query Parameter —
ram (optional)
Query Parameter — default: false
replication (optional)
Query Parameter — default: false
sensor (optional)
Query Parameter — default: false
target (optional)
Query Parameter — default: false
cluster (optional)
Query Parameter — default: false
dg (optional)
Query Parameter — default: false
disk (optional)
Query Parameter — default: false
fc (optional)
Query Parameter — default: false
memory (optional)
Query Parameter — default: false

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/service/mail~show_emails
Show Emails (showEmailsApiServiceMailShowEmailsGet)

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

Up
get /api/service/errors_monitoring
Show Errors Monitoring (showErrorsMonitoringApiServiceErrorsMonitoringGet)

Return type

array[ErrorMonitorSchema]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "active" : true,
  "time" : 0
}, {
  "name" : "name",
  "active" : true,
  "time" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/service/running_service
Show Services (showServicesApiServiceRunningServiceGet)

Return type

array[ServiceShowSchema]

Example data

Content-Type: application/json
[ {
  "service_name" : "service_name",
  "can_restart" : true,
  "can_stop" : true,
  "name" : "name",
  "state" : "state"
}, {
  "service_name" : "service_name",
  "can_restart" : true,
  "can_stop" : true,
  "name" : "name",
  "state" : "state"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
get /api/service/system_service
Show System Services (showSystemServicesApiServiceSystemServiceGet)

Return type

array[ServiceShowSchema]

Example data

Content-Type: application/json
[ {
  "service_name" : "service_name",
  "can_restart" : true,
  "can_stop" : true,
  "name" : "name",
  "state" : "state"
}, {
  "service_name" : "service_name",
  "can_restart" : true,
  "can_stop" : true,
  "name" : "name",
  "state" : "state"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Sysutils

Up
post /api/sysutils/dns
Add Dns (addDnsApiSysutilsDnsPost)

Query parameters

ip (required)
Query Parameter —
interf (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/sysutils/ntp
Add Ntp Server (addNtpServerApiSysutilsNtpPost)

Query parameters

prefix (required)
Query Parameter —
ip (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/sysutils/system
Get Settings (getSettingsApiSysutilsSystemGet)

Return type

SystemSchema

Example data

Content-Type: application/json
{
  "unit" : "unit",
  "transfer_protocol" : "transfer_protocol",
  "active" : "active",
  "logging" : "logging",
  "alua" : "alua",
  "alua_switch" : "alua_switch",
  "lang" : "lang"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response SystemSchema

Up
get /api/sysutils/ping~ping
Ping (pingApiSysutilsPingPingGet)

Query parameters

ip (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/sysutils/dns/{ip}/{interf}
Remove Dns (removeDnsApiSysutilsDnsIpInterfDelete)

Path parameters

ip (required)
Path Parameter —
interf (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
delete /api/sysutils/ntp/{prefix}/{ip}
Remove Ntp Server (removeNtpServerApiSysutilsNtpPrefixIpDelete)

Path parameters

prefix (required)
Path Parameter —
ip (required)
Path Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
post /api/sysutils/system
Set Settings (setSettingsApiSysutilsSystemPost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

body SystemSchema (required)
Body Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/sysutils/dns
Show Dns (showDnsApiSysutilsDnsGet)

Query parameters

filtered (required)
Query Parameter —

Return type

array[DnsSchema]

Example data

Content-Type: application/json
[ {
  "name" : "name",
  "interf" : "interf"
}, {
  "name" : "name",
  "interf" : "interf"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Up
get /api/sysutils/ntp
Show Ntp Servers (showNtpServersApiSysutilsNtpGet)

Return type

array[NtpSchema]

Example data

Content-Type: application/json
[ {
  "sync_default" : true,
  "prefix" : "prefix",
  "name" : "name"
}, {
  "sync_default" : true,
  "prefix" : "prefix",
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
post /api/sysutils/iperf
Start Iperf Client (startIperfClientApiSysutilsIperfPost)

Query parameters

ip_host (required)
Query Parameter —
ip_bind (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/sysutils/ping~traceroute
Traceroute (tracerouteApiSysutilsPingTracerouteGet)

Query parameters

ip (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Update

Up
get /api/update/update
Get Installed Patches (getInstalledPatchesApiUpdateUpdateGet)

Return type

array[UpdateInfoSchema]

Example data

Content-Type: application/json
[ {
  "comments" : "comments",
  "installDate" : 1,
  "initDate" : 6,
  "name" : "name",
  "id" : 0,
  "version" : "version",
  "revision" : "revision"
}, {
  "comments" : "comments",
  "installDate" : 1,
  "initDate" : 6,
  "name" : "name",
  "id" : 0,
  "version" : "version",
  "revision" : "revision"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

Up
post /api/update/update
Install Patch (installPatchApiUpdateUpdatePost)

Consumes

This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data

Form parameters

file (required)
Form Parameter — format: binary

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

User

Up
post /api/user/password
Change Password (changePasswordApiUserPasswordPost)

Query parameters

old_password (required)
Query Parameter —
new_password (required)
Query Parameter —
confirm_password (required)
Query Parameter —

Return type

DefaultResponse

Example data

Content-Type: application/json
{
  "success" : true,
  "message" : "OK"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response DefaultResponse

422

Validation Error HTTPValidationError

Up
get /api/user/
Get User (getUserApiUserGet)

Query parameters

id (optional)
Query Parameter —

Return type

array[UserGetSchema]

Example data

Content-Type: application/json
[ {
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "isSuperuser" : true,
  "id" : 0,
  "isActive" : true,
  "email" : "",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00"
}, {
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "name" : "name",
  "isSuperuser" : true,
  "id" : 0,
  "isActive" : true,
  "email" : "",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

Successful Response

422

Validation Error HTTPValidationError

Models

[ Jump to Methods ]

Table of Contents

  1. ADInfoSchema - ADInfoSchema
  2. ActivateDeactivateNodeSchema - ActivateDeactivateNodeSchema
  3. AdapterInfoSchema - AdapterInfoSchema
  4. AddNodeSchema - AddNodeSchema
  5. Body_install_patch_api_update_update_post - Body_install_patch_api_update_update_post
  6. Body_login_api_auth_token_post - Body_login_api_auth_token_post
  7. BondCreateSchema - BondCreateSchema
  8. BondEditSchema - BondEditSchema
  9. BondModeType - BondModeType
  10. CacheDisks - CacheDisks
  11. CgCreateSchema - CgCreateSchema
  12. CgEditSchema - CgEditSchema
  13. ChangeNodeStatusSchema - ChangeNodeStatusSchema
  14. ChangePasswordSchema - ChangePasswordSchema
  15. ConnectADSchema - ConnectADSchema
  16. ConnectMetroSchema - ConnectMetroSchema
  17. ControllerInfoSchema - ControllerInfoSchema
  18. CsvLogsSchema - CsvLogsSchema
  19. DataDisks - DataDisks
  20. DdpAutoReplaceDisksSchema - DdpAutoReplaceDisksSchema
  21. DdpLunCreateSchema - DdpLunCreateSchema
  22. DdpLunEditSchema - DdpLunEditSchema
  23. DdpLunGetSchema - DdpLunGetSchema
  24. DdpLunSize - DdpLunSize
  25. DdpPoolCreateSchema - DdpPoolCreateSchema
  26. DdpPoolEditSchema - DdpPoolEditSchema
  27. DdpProcessInfoSchema - DdpProcessInfoSchema
  28. DdpSnapcloneCreateSchema - DdpSnapcloneCreateSchema
  29. DdpSnapshotCreateSchema - DdpSnapshotCreateSchema
  30. DdpSnapshotDeleteGroupSchema - DdpSnapshotDeleteGroupSchema
  31. DdpSnapshotInfoSchema - DdpSnapshotInfoSchema
  32. DdpSnapshotRestoreLunSchema - DdpSnapshotRestoreLunSchema
  33. DdpSnapshotRestoreToObjectSchema - DdpSnapshotRestoreToObjectSchema
  34. DdpThinStorageCreateSchema - DdpThinStorageCreateSchema
  35. DdpThinStorageEditSchema - DdpThinStorageEditSchema
  36. DdpThinStorageInfoSchema - DdpThinStorageInfoSchema
  37. DefaultResponse - DefaultResponse
  38. DeleteADSchema - DeleteADSchema
  39. DeleteNodeSchema - DeleteNodeSchema
  40. DisconnectMetroSchema - DisconnectMetroSchema
  41. DiskInfoSchema - DiskInfoSchema
  42. DnsSchema - DnsSchema
  43. EmailSchema - EmailSchema
  44. ErrorMonitorSchema - ErrorMonitorSchema
  45. FCCreateMappingSchema - FCCreateMappingSchema
  46. FCInitAliasSchema - FCInitAliasSchema
  47. FCInitInfoSchema - FCInitInfoSchema
  48. FCMappingSchema - FCMappingSchema
  49. FCRestoreMappingSchema - FCRestoreMappingSchema
  50. FCTargetGetQliniModeSchema - FCTargetGetQliniModeSchema
  51. FCTargetGroupInfoSchema - FCTargetGroupInfoSchema
  52. FCTargetGroupSchema - FCTargetGroupSchema
  53. FCTargetInfoSchema - FCTargetInfoSchema
  54. FCTargetPutGroupSchema - FCTargetPutGroupSchema
  55. FCTargetRescanSchema - FCTargetRescanSchema
  56. FCTargetSetQliniModeSchema - FCTargetSetQliniModeSchema
  57. GetModuleSchema - GetModuleSchema
  58. GroupCreateSchema - GroupCreateSchema
  59. GroupInfoSchema - GroupInfoSchema
  60. HTTPValidationError - HTTPValidationError
  61. HardwareInfoSchema - HardwareInfoSchema
  62. IpAccessSchema - IpAccessSchema
  63. IscsiGroupCreateSchema - IscsiGroupCreateSchema
  64. IscsiGroupEditSchema - IscsiGroupEditSchema
  65. IscsiGroupInfoSchema - IscsiGroupInfoSchema
  66. IscsiInitiatorInfoSchema - IscsiInitiatorInfoSchema
  67. IscsiMappingCreateSchema - IscsiMappingCreateSchema
  68. IscsiMappingInfoSchema - IscsiMappingInfoSchema
  69. IscsiTargetCreateSchema - IscsiTargetCreateSchema
  70. IscsiTargetEditSchema - IscsiTargetEditSchema
  71. IscsiTargetInfoSchema - IscsiTargetInfoSchema
  72. IscsiUser - IscsiUser
  73. JWTSchema - JWTSchema
  74. LicenseEditSchema - LicenseEditSchema
  75. LicenseInfoSchema - LicenseInfoSchema
  76. LogSchema - LogSchema
  77. LreplSchema - LreplSchema
  78. MailingSchema - MailingSchema
  79. MetroConfigureSchema - MetroConfigureSchema
  80. MetroInfoSchema - MetroInfoSchema
  81. MibSchema - MibSchema
  82. Name - Name
  83. NodeCreateSchema - NodeCreateSchema
  84. NodeInfoSchema - NodeInfoSchema
  85. NtpSchema - NtpSchema
  86. PhysInterfaceEditSchema - PhysInterfaceEditSchema
  87. PhysInterfaceInfoSchema - PhysInterfaceInfoSchema
  88. PoolTypeChoice - PoolTypeChoice
  89. PostModuleSchema - PostModuleSchema
  90. ProtocolType - ProtocolType
  91. QosSchema - QosSchema
  92. RdgBrokenPoolInfoSchema - RdgBrokenPoolInfoSchema
  93. RdgLunCreateSchema - RdgLunCreateSchema
  94. RdgLunEditSchema - RdgLunEditSchema
  95. RdgLunInfoSchema - RdgLunInfoSchema
  96. RdgPoolCreateSchema - RdgPoolCreateSchema
  97. RdgPoolEditSchema - RdgPoolEditSchema
  98. RdgPoolInfoSchema - RdgPoolInfoSchema
  99. RdgRaid - RdgRaid
  100. RdgRelatedCloneNameSchema - RdgRelatedCloneNameSchema
  101. RdgSnapcloneNameSchema - RdgSnapcloneNameSchema
  102. RdgSnapshotDeleteGroup - RdgSnapshotDeleteGroup
  103. RdgSnapshotInfoSchema - RdgSnapshotInfoSchema
  104. RdgSnapshotNameSchema - RdgSnapshotNameSchema
  105. RdgSnapshotRestoreInfoSchema - RdgSnapshotRestoreInfoSchema
  106. RdgSnapshotRestoreRdgSchema - RdgSnapshotRestoreRdgSchema
  107. RdgSnapshotRestoreToObjSchema - RdgSnapshotRestoreToObjSchema
  108. RecoveryReplicationSchema - RecoveryReplicationSchema
  109. RreplCreateSchema - RreplCreateSchema
  110. RreplInfoSchema - RreplInfoSchema
  111. SCSIAdapterInfoSchema - SCSIAdapterInfoSchema
  112. SNMPSchema - SNMPSchema
  113. SNMPTrapSchema - SNMPTrapSchema
  114. ServiceShowSchema - ServiceShowSchema
  115. ServiceSystemLogsSchema - ServiceSystemLogsSchema
  116. SetPrimarySchema - SetPrimarySchema
  117. SnapShotParent - SnapShotParent
  118. SoftwareInfoSchema - SoftwareInfoSchema
  119. StaticRouteCreateSchema - StaticRouteCreateSchema
  120. StaticRouteDeleteSchema - StaticRouteDeleteSchema
  121. StaticRouteInfoSchema - StaticRouteInfoSchema
  122. SystemInfoSchema - SystemInfoSchema
  123. SystemSchema - SystemSchema
  124. TieringDisks - TieringDisks
  125. UnixGroupSchema - UnixGroupSchema
  126. UpdateInfoSchema - UpdateInfoSchema
  127. UserCreateSchema - UserCreateSchema
  128. UserGetSchema - UserGetSchema
  129. UserInfoSchema - UserInfoSchema
  130. UserToGroupAddSchema - UserToGroupAddSchema
  131. ValidationError - ValidationError
  132. VipCreateSchema - VipCreateSchema
  133. VipEditStateSchema - VipEditStateSchema
  134. VipGetSchema - VipGetSchema
  135. VlanCreateSchema - VlanCreateSchema
  136. VlanEditSchema - VlanEditSchema
  137. VlanGetSchema - VlanGetSchema
  138. _FCAccessSchema - _FCAccessSchema
  139. _FCInitSchema - _FCInitSchema
  140. _FCTargetGroupTargetSchema - _FCTargetGroupTargetSchema
  141. schemas__nfs__DirCreateSchema - DirCreateSchema
  142. schemas__nfs__DirInfoSchema - DirInfoSchema
  143. schemas__smb__DirCreateSchema - DirCreateSchema
  144. schemas__smb__DirInfoSchema - DirInfoSchema

ADInfoSchema - ADInfoSchema Up

account
String
domain
String
domainIp
String
hostname
String
initdate
BigDecimal
kdcAdmin
String
kdcOther
String
netbios
String

ActivateDeactivateNodeSchema - ActivateDeactivateNodeSchema Up

name
String
vip
String

AdapterInfoSchema - AdapterInfoSchema Up

hostname
String
diskCount
Integer
ethCount
Integer
fcCount
Integer

AddNodeSchema - AddNodeSchema Up

name
String
pool_type
PoolTypeChoice
pool_name
String
lun_name
String
ip
String

Body_install_patch_api_update_update_post - Body_install_patch_api_update_update_post Up

file
byte[] format: binary

Body_login_api_auth_token_post - Body_login_api_auth_token_post Up

grant_type (optional)
String
username
String
password
String
scope (optional)
String
client_id (optional)
String
client_secret (optional)
String

BondCreateSchema - BondCreateSchema Up

id
Integer
interface_names
array[String]
hostname
String
mtu
Integer
ip
String format: ipv4
mask
Integer
gateway
String format: ipv4
mode
BondModeType

BondEditSchema - BondEditSchema Up

ip
String format: ipv4
mask
Integer
hostname
String
mtu
Integer
mode
BondModeType
gateway
String format: ipv4

BondModeType - BondModeType Up

An enumeration.

CacheDisks - CacheDisks Up

disk_wwns
array[String]

CgCreateSchema - CgCreateSchema Up

name
String
refresh_interval
Integer
schedule_refresh (optional)
Boolean
cg_luns (optional)
array[String]

CgEditSchema - CgEditSchema Up

refresh_interval (optional)
Integer
schedule_refresh (optional)
Boolean
cg_luns (optional)
array[String]
refresh (optional)
Boolean

ChangeNodeStatusSchema - ChangeNodeStatusSchema Up

name
String
ip
String

ChangePasswordSchema - ChangePasswordSchema Up

name
String
password
String

ConnectADSchema - ConnectADSchema Up

domain
String
domain_ip
String
domain_account
String
domain_password
String
netbios
String
admin_server (optional)
String
kdc (optional)
array[null]

ConnectMetroSchema - ConnectMetroSchema Up

node_ip
String
name
String
metro_ip
String
metro_mask
Integer

ControllerInfoSchema - ControllerInfoSchema Up

hostname
String
ddpStatus
Boolean
rdgStatus
Boolean
connectStatus
Boolean

CsvLogsSchema - CsvLogsSchema Up

path
String
message
String

DataDisks - DataDisks Up

disk_wwns
array[String]

DdpAutoReplaceDisksSchema - DdpAutoReplaceDisksSchema Up

data
array[DiskInfoSchema]
cache
array[DiskInfoSchema]

DdpLunCreateSchema - DdpLunCreateSchema Up

pool
String
raid
String
size
Integer
virtual_size (optional)
Integer
disk_qty
Integer
wwns (optional)
array[String]
name
String
alias (optional)
String
is_deduplication (optional)
Boolean
is_compression (optional)
Boolean
is_thin (optional)
Boolean
qos (optional)
QosSchema

DdpLunEditSchema - DdpLunEditSchema Up

size (optional)
DdpLunSize
alias (optional)
String
qos (optional)
QosSchema
is_dedup (optional)
Boolean
is_compression (optional)
Boolean

DdpLunGetSchema - DdpLunGetSchema Up

alias
String
name
String
createdAt
String
hostname
String
size
Integer
uuid
String
sync
String
dataPercent
BigDecimal
poolFree
Integer
lunCached
Boolean
state
String
cacheDisks
array[null]
cacheFree
Integer
poolType
String
type
String
disks
array[null]
disksFree
Integer
disksCount
Integer
raid
String
qos (optional)
QosSchema

DdpLunSize - DdpLunSize Up

physical_size
Integer
virtual_size (optional)
Integer

DdpPoolCreateSchema - DdpPoolCreateSchema Up

alua
Integer
block_size
Integer
hot_spare
Integer
max_recovery_rate
Integer
name
String
data_disks
array[String]
cache_disks (optional)
array[String]

DdpPoolEditSchema - DdpPoolEditSchema Up

state (optional)
Integer
alua (optional)
Integer
hot_spare (optional)
Integer
max_recovery_rate
Integer

DdpProcessInfoSchema - DdpProcessInfoSchema Up

hostname
String
pool
String
lun
String
percent
BigDecimal

DdpSnapcloneCreateSchema - DdpSnapcloneCreateSchema Up

pool
String
lun
String
destination_name
String

DdpSnapshotCreateSchema - DdpSnapshotCreateSchema Up

pool
String
lun
String

DdpSnapshotDeleteGroupSchema - DdpSnapshotDeleteGroupSchema Up

pool
String
lun
String

DdpSnapshotInfoSchema - DdpSnapshotInfoSchema Up

parent
SnapShotParent
hostname
String
pool
String
lun
String
name
String
snapshotType
String
size
Integer

DdpSnapshotRestoreLunSchema - DdpSnapshotRestoreLunSchema Up

pool
String
lun
String
snapshot_name
String

DdpSnapshotRestoreToObjectSchema - DdpSnapshotRestoreToObjectSchema Up

pool
String
lun
String
snapshot_name
String
destination_name
String

DdpThinStorageCreateSchema - DdpThinStorageCreateSchema Up

pool
String
raid
String
size
Integer
disk_qty
Integer
wwns (optional)
array[String]

DdpThinStorageEditSchema - DdpThinStorageEditSchema Up

new_size
Integer

DdpThinStorageInfoSchema - DdpThinStorageInfoSchema Up

hostname
String
name
String
size
String
freeSize
Integer
disks
array[String]
raid
String
createdAt
String

DefaultResponse - DefaultResponse Up

success
Boolean
message (optional)
String

DeleteADSchema - DeleteADSchema Up

account
String
domain
String
netbios
String

DeleteNodeSchema - DeleteNodeSchema Up

name
String
node_id
String

DisconnectMetroSchema - DisconnectMetroSchema Up

node_ip
String
name
String

DiskInfoSchema - DiskInfoSchema Up

cylinders (optional)
Integer
device
String
driveType
String
encStatus
String
enclosure
String
group
String
id
Integer
indication
Boolean
licensed
Boolean
logBs
Integer
major
Integer
minor
Integer
model
String
physBs
Integer
power
anyOf:
rpm (optional)
Integer
sasType
String
serial
String
size
Integer
slot
anyOf:
speed (optional)
Integer
state
String
status
String
target
String
vendor
String
wwn
String

DnsSchema - DnsSchema Up

name
String
interf
String

EmailSchema - EmailSchema Up

host
String
port
String
user
String
password
String
id
Integer
starttls
String
sender
String
status (optional)
Boolean

ErrorMonitorSchema - ErrorMonitorSchema Up

name
String
time (optional)
Integer
active (optional)
Boolean

FCCreateMappingSchema - FCCreateMappingSchema Up

group
String
pool
String
lun
String
lunid (optional)
Integer

FCInitAliasSchema - FCInitAliasSchema Up

alias
String

FCInitInfoSchema - FCInitInfoSchema Up

alias
String
driver
String
group
String
hostname
String
initiator
String
portName
String

FCMappingSchema - FCMappingSchema Up

alias (optional)
String
alua
Boolean
group
String
pool
String
lun
String
lunid
Integer
naaId
String
outOfSync
Boolean
portName
array[String]
replId (optional)
String
rotational
Boolean
thinProvisioned
Boolean

FCRestoreMappingSchema - FCRestoreMappingSchema Up

lunid (optional)
Integer

FCTargetGetQliniModeSchema - FCTargetGetQliniModeSchema Up

hostname
String
qliniMode
String

FCTargetGroupInfoSchema - FCTargetGroupInfoSchema Up

access
array[_FCAccessSchema]
group
String
luns
array[String]

FCTargetGroupSchema - FCTargetGroupSchema Up

group
String
targets
array[_FCTargetGroupTargetSchema]

FCTargetInfoSchema - FCTargetInfoSchema Up

portStatus (optional)
Boolean
qliniMode (optional)
Boolean
hostname
String
portName
String
portState
String
speed
String
supportedClasses
String
supportedSpeeds
String
symbolicName
String

FCTargetPutGroupSchema - FCTargetPutGroupSchema Up

targets
array[_FCTargetGroupTargetSchema]

FCTargetRescanSchema - FCTargetRescanSchema Up

rescanPorts
Boolean

FCTargetSetQliniModeSchema - FCTargetSetQliniModeSchema Up

isEngine0Dual
String
isEngine1Dual
String

GetModuleSchema - GetModuleSchema Up

name
String
state
String
services
array[Object]

GroupCreateSchema - GroupCreateSchema Up

name
String
users (optional)
array[String]

GroupInfoSchema - GroupInfoSchema Up

adminGroups (optional)
array[null]
unixGroups (optional)
array[UnixGroupSchema]
groups (optional)
array[null]

HTTPValidationError - HTTPValidationError Up

detail (optional)
array[ValidationError]

HardwareInfoSchema - HardwareInfoSchema Up

hostname
String
coresCount
String
cpuCount
String
cpuType
String
memory
Integer

IpAccessSchema - IpAccessSchema Up

ip
String
mask
Integer

IscsiGroupCreateSchema - IscsiGroupCreateSchema Up

group
String
inits
array[null]
target
String
driver (optional)
String

IscsiGroupEditSchema - IscsiGroupEditSchema Up

inits
array[null]

IscsiGroupInfoSchema - IscsiGroupInfoSchema Up

group
String
inits
array[null]
luns
array[null]
target
Object

IscsiInitiatorInfoSchema - IscsiInitiatorInfoSchema Up

init
String
alias
String
target
String
group
String
engine
String

IscsiMappingCreateSchema - IscsiMappingCreateSchema Up

group
String
lun
String
lunid (optional)
String

IscsiMappingInfoSchema - IscsiMappingInfoSchema Up

alias
String
alua
Boolean
group
String
lun
String
lunid
String
naaId
String
target
String

IscsiTargetCreateSchema - IscsiTargetCreateSchema Up

target
String
portals
array[null]
users (optional)
array[IscsiUser]
rdma (optional)
Boolean

IscsiTargetEditSchema - IscsiTargetEditSchema Up

portals (optional)
array[null]
users (optional)
array[null]
rdma (optional)
Boolean

IscsiTargetInfoSchema - IscsiTargetInfoSchema Up

target
String
portals
array[null]
users
array[null]
rdma
Boolean

IscsiUser - IscsiUser Up

username
String
password
String

JWTSchema - JWTSchema Up

access_token
String
token_type
String

LicenseEditSchema - LicenseEditSchema Up

license_key
String

LicenseInfoSchema - LicenseInfoSchema Up

hostname
String
id
Integer
name
String
count
Integer
updated
Integer

LogSchema - LogSchema Up

id
Integer
code
String
message
String
status
String
time
String
engine
String

LreplSchema - LreplSchema Up

copies (optional)
Integer
frequency (optional)
Integer
last_start (optional)
Integer
last_time (optional)
String
lun
String
name
String
name_script (optional)
String
name_snapshot (optional)
String
next_time (optional)
String
rdg (optional)
String
thin (optional)
Boolean
script (optional)
String
source (optional)
String
status (optional)
String
type (optional)
String

MailingSchema - MailingSchema Up

errors (optional)
Object
id
Integer
status
Integer

MetroConfigureSchema - MetroConfigureSchema Up

arbiter_ip
String
remote_mgr_0
String
remote_mgr_1
String

MetroInfoSchema - MetroInfoSchema Up

key
String
name
String
state
Boolean

MibSchema - MibSchema Up

link
String

Name - Name Up

NodeCreateSchema - NodeCreateSchema Up

pool_type
PoolTypeChoice
pool_name
String
lun_name
String
vip
String

NodeInfoSchema - NodeInfoSchema Up

name
String
local
Boolean
lun
String
lunState
String
linkStatus
String
role
String
ip
String
type
String
protocol
String
metro (optional)
String
nodeId
String

NtpSchema - NtpSchema Up

name
String
prefix
String
sync_default (optional)
Boolean

PhysInterfaceEditSchema - PhysInterfaceEditSchema Up

ip (optional)
String format: ipv4
mask (optional)
Integer
mtu (optional)
Integer
gateway (optional)
String format: ipv4
hostname
String

PhysInterfaceInfoSchema - PhysInterfaceInfoSchema Up

portName
String
slotPort
String
ip (optional)
String
mask (optional)
String
mac
String
state
Boolean
maxSpeed
String
currentSpeed
String
duplex
String
mtu
Integer
hostname
String
gateway (optional)
String
parent (optional)
Object

PoolTypeChoice - PoolTypeChoice Up

An enumeration.

PostModuleSchema - PostModuleSchema Up

name
String
status
Boolean

ProtocolType - ProtocolType Up

An enumeration.

QosSchema - QosSchema Up

read_iops (optional)
Integer
write_iops (optional)
Integer
read_mbs (optional)
Integer
write_mbs (optional)
Integer

RdgBrokenPoolInfoSchema - RdgBrokenPoolInfoSchema Up

health
String
hostname
String
pool
String
state
String
type
String

RdgLunCreateSchema - RdgLunCreateSchema Up

pool
String
lun
String
alias (optional)
String
lun_count (optional)
Integer
size
anyOf:
block_size
Integer
is_thin (optional)
Boolean
is_alua (optional)
Boolean
is_rotational (optional)
Boolean
is_dedup (optional)
Boolean
is_compression (optional)
Boolean
qos (optional)
QosSchema

RdgLunEditSchema - RdgLunEditSchema Up

size (optional)
Integer
alias (optional)
String
qos (optional)
QosSchema
type (optional)
String

RdgLunInfoSchema - RdgLunInfoSchema Up

name
String
creation
Integer
used
Integer
available
Integer
referenced
Integer
compressratio
BigDecimal
refcompressratio
BigDecimal
reservation
Integer
volsize
Integer
volblocksize
Integer
compression
Boolean
readonly
Boolean
origin (optional)
String
refreservation
Integer
usedbysnapshots
Integer
usedbydataset
Integer
usedbychildren
Integer
usedbyrefreservation
Integer
dedup
Boolean
sync
String
aerodiskBlkioThrottleReadBpsDevice (optional)
Integer
aerodiskBlkioThrottleWriteIopsDevice (optional)
Integer
aerodiskBlkioThrottleReadIopsDevice (optional)
Integer
aerodiskBlkioThrottleWriteBpsDevice (optional)
Integer
aerodiskType (optional)
String
aerodiskAlias
String
aerodiskHotspare
Boolean
aerodiskDiskLogicalBlockSize
Integer
aerodiskModelDisk (optional)
String
hostname (optional)
String
clones (optional)
array[null]
poolType (optional)
String
lunType (optional)
String

RdgPoolCreateSchema - RdgPoolCreateSchema Up

name
String
data_disks
DataDisks
raid
RdgRaid
cache_disks (optional)
CacheDisks
tiering_disks (optional)
TieringDisks
is_alua (optional)
Boolean
is_compression (optional)
Integer
is_dedup (optional)
Integer
is_hotspare (optional)
Integer

RdgPoolEditSchema - RdgPoolEditSchema Up

is_state (optional)
Boolean
is_alua (optional)
Boolean
is_dedup (optional)
Boolean
is_compression (optional)
Boolean
is_hotspare (optional)
Boolean

RdgPoolInfoSchema - RdgPoolInfoSchema Up

aerodiskDiskLogicalBlockSize
Integer
aerodiskHotspare
Boolean
aerodiskModelDisk
String
alua
Boolean
available
Integer
checksum
Boolean
compression
Boolean
creation
Integer
dataVdev
Integer
dedup
Boolean
dedupratio
BigDecimal
fragmentation
Integer
guid
Integer
health
String
hostname
String
logicalUsed
Integer
lunCount
Integer
mcacheInVdev
Integer
onlineTiering
Integer
perfPlan
String
pool
String
readonly
Boolean
resilverPercent
Integer
resilverProcess
String
resilverSpeed
String
resilverStatus
Boolean
resilverTime
String
rotational
Boolean
rwCache
Integer
rwmcacheCache
Integer
size
Integer
snapCount
Integer
state
String
status
array[null]
thinProvisioned
array[null]
totalDisk
Integer
type
String
used
Integer
usedbychildren
Integer
usedbydataset
Integer
usedbyrefreservation
Integer
usedbysnapshots
Integer
vdev
Integer

RdgRaid - RdgRaid Up

vdev_qty
Integer
raid
String

RdgRelatedCloneNameSchema - RdgRelatedCloneNameSchema Up

pool
String
lun
String
name
String
is_thin (optional)
Boolean

RdgSnapcloneNameSchema - RdgSnapcloneNameSchema Up

pool
String
lun
String
name
String

RdgSnapshotDeleteGroup - RdgSnapshotDeleteGroup Up

name (optional)
String

RdgSnapshotInfoSchema - RdgSnapshotInfoSchema Up

hostname
String
name
String
used
Integer

RdgSnapshotNameSchema - RdgSnapshotNameSchema Up

pool
String
lun
String

RdgSnapshotRestoreInfoSchema - RdgSnapshotRestoreInfoSchema Up

type (optional)
String
name
String
title (optional)
String
percent (optional)
BigDecimal

RdgSnapshotRestoreRdgSchema - RdgSnapshotRestoreRdgSchema Up

group (optional)
String
name (optional)
String

RdgSnapshotRestoreToObjSchema - RdgSnapshotRestoreToObjSchema Up

snap (optional)
String
group (optional)
String
lun (optional)
String
pool
String

RecoveryReplicationSchema - RecoveryReplicationSchema Up

name
String
ip
String

RreplCreateSchema - RreplCreateSchema Up

name
String
protocol
ProtocolType
local_node
NodeCreateSchema
remote_nodes
array[NodeCreateSchema]

RreplInfoSchema - RreplInfoSchema Up

deviceId
Integer
nodes
array[NodeInfoSchema]

SCSIAdapterInfoSchema - SCSIAdapterInfoSchema Up

hostname
String
bios
String
firmware
String
model
String
name
String
nvdata
String
state
String
type
String

SNMPSchema - SNMPSchema Up

snmp2_community_name
String
snmp2_state
String
snmp3_users (optional)
String
snmp3_state
String

SNMPTrapSchema - SNMPTrapSchema Up

snmp_trap_daemon_status
String
ip
String
frequency
String
ram
Boolean
replication
Boolean
sensor
Boolean
target
Boolean
cluster
Boolean
dg
Boolean
disk
Boolean
fc
Boolean
memory
Boolean

ServiceShowSchema - ServiceShowSchema Up

service_name
String
state
String
can_stop
Boolean
can_restart
Boolean
name
String

ServiceSystemLogsSchema - ServiceSystemLogsSchema Up

name
String
message
String

SetPrimarySchema - SetPrimarySchema Up

name
String
node_id
String
ip
String

SnapShotParent - SnapShotParent Up

name
String

SoftwareInfoSchema - SoftwareInfoSchema Up

hostname
String
engineSn
String
engineType
String
fwVersion
String

StaticRouteCreateSchema - StaticRouteCreateSchema Up

interface_name
String
ip
String format: ipv4
mask
Integer
gateway
String format: ipv4
hostname
String

StaticRouteDeleteSchema - StaticRouteDeleteSchema Up

ip
String format: ipv4
hostname
String

StaticRouteInfoSchema - StaticRouteInfoSchema Up

ip
String
networkIp (optional)
String
networkMask (optional)
String
gateway (optional)
String
interface
String
hostname
String

SystemInfoSchema - SystemInfoSchema Up

controllers
array[ControllerInfoSchema]
software
array[SoftwareInfoSchema]
hardware
array[HardwareInfoSchema]
adapters
array[AdapterInfoSchema]
scsiAdapters
array[SCSIAdapterInfoSchema]

SystemSchema - SystemSchema Up

lang
String
transfer_protocol
String
unit
String
active
String
logging
String
alua
String
alua_switch
String

TieringDisks - TieringDisks Up

disk_wwns
array[String]

UnixGroupSchema - UnixGroupSchema Up

name
String
users (optional)
array[null]

UpdateInfoSchema - UpdateInfoSchema Up

id
Integer
initDate
Integer
installDate
Integer
name
String
revision
String
version
String
comments
String

UserCreateSchema - UserCreateSchema Up

name
String
password
String

UserGetSchema - UserGetSchema Up

id
Integer
name
String
email (optional)
String format: email
isActive
Boolean
isSuperuser
Boolean
createdAt
Date format: date-time
updatedAt
Date format: date-time

UserInfoSchema - UserInfoSchema Up

users
array[null]
adminUsers
array[null]
unixUsers
array[null]

UserToGroupAddSchema - UserToGroupAddSchema Up

name
String
new_users (optional)
array[String]
users_to_delete (optional)
array[String]

ValidationError - ValidationError Up

loc
array[null]
items anyOf:
msg
String
type
String

VipCreateSchema - VipCreateSchema Up

int0
String
int1
String
ip
String format: ipv4
mask
String format: ipv4
pool_name
String
vip_type
String

VipEditStateSchema - VipEditStateSchema Up

state
String

VipGetSchema - VipGetSchema Up

hostname
String
int0
String
int1
String
ip
String format: ipv4
mask
String format: ipv4
metro
Integer
name
String
poolName
String
poolType
String
repl
Integer
rtype
String
state
String

VlanCreateSchema - VlanCreateSchema Up

gateway
String format: ipv4
ip
String format: ipv4
mask
String format: ipv4
mtu
Integer
phys_interface
String
v_id
Integer
name
String

VlanEditSchema - VlanEditSchema Up

gateway (optional)
String format: ipv4
ip (optional)
String format: ipv4
mask (optional)
String format: ipv4
mtu (optional)
Integer
v_id (optional)
Integer

VlanGetSchema - VlanGetSchema Up

gateway (optional)
String format: ipv4
hostname
String
physInterface (optional)
String
isGlobal
Boolean
ip
String format: ipv4
isBond
Boolean
mask
String format: ipv4
mtu
Integer
name
String
state
String
vId
Integer

_FCAccessSchema - _FCAccessSchema Up

hostname
String
portName
String
initiators
array[_FCInitSchema]

_FCInitSchema - _FCInitSchema Up

alias
String
initiator
String

_FCTargetGroupTargetSchema - _FCTargetGroupTargetSchema Up

portName
String
initiators
array[String]

schemas__nfs__DirCreateSchema - DirCreateSchema Up

name
String
pool
String
size
String
thin
Boolean
blocksize
String
read_access (optional)
array[IpAccessSchema]
write_access (optional)
array[IpAccessSchema]
is_async (optional)
Boolean
root_access (optional)
Boolean
anonymous_user_access (optional)
Boolean
subtree_check (optional)
Boolean
anonymous_as_local_user (optional)
String
anonymous_as_local_group (optional)
String

schemas__nfs__DirInfoSchema - DirInfoSchema Up

name
String
localUsername (optional)
String
localGroupName (optional)
String
allSquash
Boolean
isAsync
Boolean
availableSpace
String
blocksize
String
pool
String
hostname
String
lunType
String
noRootSquash
Boolean
quota
String
readAccess (optional)
array[IpAccessSchema]
writeAccess (optional)
array[IpAccessSchema]
subtreeCheck
Boolean
usedSpace
String

schemas__smb__DirCreateSchema - DirCreateSchema Up

name
String
pool
String
size
String
blocksize
String
thin
Boolean
is_inherit
Boolean
is_inherit_on_create
Boolean
readonly
Boolean
only_owner_can_delete
Boolean
admin_users (optional)
array[null]
admin_groups (optional)
array[null]
users (optional)
array[null]
groups (optional)
array[null]

schemas__smb__DirInfoSchema - DirInfoSchema Up

name
String
pool
String
lunType
String
hostname
String
availableSize
String
blocksize
String
used
String
quota
String
isInherit (optional)
Boolean
isInheritOnCreate (optional)
Boolean
readonly (optional)
Boolean
onlyOwnerCanDelete (optional)
Boolean
accessIsAllowed (optional)
array[null]
adminGroups (optional)
array[null]
adminUsers (optional)
array[null]
groups (optional)
array[null]
users (optional)
array[null]
Назад
ENGINE N4 4U
    • Руководство пользователя
    • Руководство пользователя
  • 5.1.8
    • 5.5.0
    • 5.4.8
    • 5.4.7
    • 5.4.6
    • 5.4.5
    • 5.4.4
    • 5.4.3
    • 5.4.2
    • 5.4.1
    • 5.4.0
    • 5.3.0
    • 5.2.0
    • 5.1.9
    • 5.1.8
    • 5.1.7
    • 5.1.6
    • 5.1.5
    • 5.1.4
    • 5.1.3
    • 5.1.2
    • 5.1.1
    • 5.1.0
    • 5.0.0
    • 4.0.11
    • 4.0.10
    • 4.0.9
    • 4.0.8
    • 4.0.7
    • 4.0.6
    • 4.0.5
    • 4.0.3
Скачать
  • Подключение СХД
  • Обзор интерфейса
    • Информационная панель
    • Навигация
  • Системная панель (Dashboard)
  • Базовая настройка
  • Сетевые интерфейсы
    • Сетевые интерфейсы
    • Физические интерфейсы
    • BOND-интерфейс
    • Виртуальные интерфейсы
    • Статические маршруты
    • IP-Ресурсы
  • Блочный доступ iSCSI (iSER)
    • Таргеты
    • Инициаторы
    • Группы
    • Маппинг
  • Блочный доступ Fibre Channel
    • Порты
    • Инициаторы
    • Группы
    • Маппинг
  • Подсистема хранения
  • Диски
    • Операции и действия
  • RAID Distributed Group (RDG)
    • Группы
    • Создание RDG
    • Просмотр информации
    • Добавление DATA дисков
    • Режимы ускорения ввода/вывода
    • Настройка режимов ускорения
    • Действия с RDG
    • Логические тома (LUN на RDG)
    • Резервные копии
    • Мгновенные снимки
    • Группы консистентности связанных клонов
  • Dynamic Disk Pool (DDP)
    • Группы
    • Создание DDP
    • Просмотр информации
    • Добавление DATA дисков
    • Тонкое хранилище
    • Настройка ALUA
    • Действия с DDP
    • Толстые логические тома (LUN на DDP)
    • Тонкие логические тома (LUN на DDP)
    • Мгновенные снимки
  • Файловые системы
    • NFS
    • SMB/CIFS
    • Пользователи и группы
    • Ввод в домен AD
  • Локальная репликация
    • Создание репликации
  • Удаленная репликация
    • Создание репликации
    • Управление и действия
  • Метрокластер
    • Арбитр
    • Настройка метрокластера
  • Производительность
    • Преднастроенные графики
    • Пользовательские графики
    • Преднастроенные наборы графиков
    • Визуализация и статистика
  • Управление
    • Лицензии
    • Системные утилиты
    • Сервис
    • Сервис SNMP
    • Сенсоры
    • Системный журнал
    • Обновление системы
    • Модули
  • Настройка блочного доступа
    • Настройка для ESXi
    • Настройка для Windows Server 2008 и выше
    • Настройка для Linux
  • Настройка файлового доступа
    • Настройка NFS для ESXi
    • Настройка NFS для Windows Server
    • Настройка NFS для Linux
    • Настройка SMB для Windows Server
    • Настройка SMB для Linux
  • Рекомендации по защите данных
    • Уровни RDG
    • Организация RDG
    • Уровни DDP
    • Организация DDP
    • SPARE-диски
    • Отличия RDG и DDP
    • Распределение групп
    • Система лицензирования
  • Лучшие практики по производительности СХД
  • Статьи технической поддержки
    • Первичный запуск и настройка
    • Настройка кластера
    • Настройка IPMI
    • Проверка параметров
    • Настройка параметров
    • Настройка Fibre Channel
    • Настройка Multipath Windows
    • Мониторинг системы
    • Обновление системы
  • Схемы подключения дисковых полок
    • ENGINE N2 2U
    • ENGINE N2 4U
    • ENGINE N4 4U
  • API
AERODISK
Документация Контакты О нас
© 2025, Aerodisk. All rights reserved.
Last updated on 27 Aug 2025.