Notifications

get__notifications_query

Code samples

GET /notifications/query HTTP/1.1

Accept: application/json

GET /notifications/query

Query past notifications.

Parameters

Name	In	Type	Required	Description
nodes	query	array[string]	false	The names of the S1 nodes to get notifications from.
minLevel	query	string	false	Filter by minimum notification level.
levels	query	array[string]	false	Filter by specific event levels.
modules	query	array[string]	false	Filter by notification module names.
startTimestamp	query	string(date-time)	false	Filter by date/time - start date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
endTimestamp	query	string(date-time)	false	Filter by date/time - end date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
search	query	string	false	A string to search for. Hint: you can search customer, system (cloud), node and module names.
top	query	integer(int64)	false	Show top configurations.
descendingOrder	query	boolean	false	Sort the results in a descending order.

Example responses

200 Response

{
  "Data": [
    {
      "Timestamp": "2019-08-24T14:15:22Z",
      "Node": "string",
      "Id": 0,
      "Level": 0,
      "Module": "string",
      "Message": "string",
      "Exception": "string",
      "Properties": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	NotificationElementApiResult
400	Bad Request	Bad Request	string

post__notifications_test

Code samples

POST /notifications/test HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /notifications/test

Generate a test notification.

Body parameter

{
  "Node": "string",
  "Level": "string",
  "Module": "string",
  "Message": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTest	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__notifications_settings_show

Code samples

GET /notifications/settings/show HTTP/1.1

Accept: application/json

GET /notifications/settings/show

Display notifications settings.

Example responses

200 Response

{
  "EmailSettings": {
    "MailServerAddress": "string",
    "MailServerPort": 0,
    "MailServerUsername": "string",
    "SendingEmailAddress": "string",
    "SecureSocketOption": 0,
    "ValidateCertificate": true
  },
  "NotificationTargets": [
    {
      "Name": "string",
      "Type": 0,
      "MinEventLevel": 0,
      "ModulesListenedTo": [
        "string"
      ],
      "VisibleToCustomers": true,
      "IsEnabled": true
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	NotificationsEmailSettingsAndNotificationTargetsResult
400	Bad Request	Bad Request	string

delete__notifications_targets_delete

Code samples

DELETE /notifications/targets/delete HTTP/1.1

Accept: application/json

DELETE /notifications/targets/delete

Delete notification target.

Parameters

Name	In	Type	Required	Description
name	query	array[string]	false	List of notification target names to delete.
force	query	boolean	false	Do not ask approval.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_targets_disable

Code samples

PUT /notifications/targets/disable HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/targets/disable

Temporarily disable notifications targets.

Body parameter

{
  "Name": [
    "string"
  ],
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsDisable	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_targets_enable

Code samples

PUT /notifications/targets/enable HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/targets/enable

Enable notifications targets.

Body parameter

{
  "Name": [
    "string"
  ],
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsEnable	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__notifications_targets_list

Code samples

GET /notifications/targets/list HTTP/1.1

Accept: application/json

GET /notifications/targets/list

Display notifications targets.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Limit results by the notification target name.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Type": 0,
      "MinEventLevel": 0,
      "ModulesListenedTo": [
        "string"
      ],
      "VisibleToCustomers": true,
      "IsEnabled": true
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	NotificationTargetElementApiResult
400	Bad Request	Bad Request	string

put__notifications_settings_email_edit

Code samples

PUT /notifications/settings/email/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/settings/email/edit

Edit email notifications settings.

Body parameter

{
  "Server": "string",
  "Port": 0,
  "Username": "string",
  "Password": "string",
  "SendFromAddress": "string",
  "RemoveUsernameAndPassword": true,
  "RemoveSendFromAddress": true,
  "SecureSocketOption": "string",
  "DisableCertificateValidation": true,
  "EnableCertificateValidation": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsSettingsEmailEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_settings_email_reset

Code samples

PUT /notifications/settings/email/reset HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/settings/email/reset

Reset email settings to default values.

Body parameter

{
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsSettingsEmailReset	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__notifications_settings_email_show

Code samples

GET /notifications/settings/email/show HTTP/1.1

Accept: application/json

GET /notifications/settings/email/show

Display email settings.

Example responses

200 Response

{
  "EmailSettings": {
    "MailServerAddress": "string",
    "MailServerPort": 0,
    "MailServerUsername": "string",
    "SendingEmailAddress": "string",
    "SecureSocketOption": 0,
    "ValidateCertificate": true
  },
  "Notes": "string"
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	NotificationsEmailSettingsResult
400	Bad Request	Bad Request	string

post__notifications_targets_email_add

Code samples

POST /notifications/targets/email/add HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /notifications/targets/email/add

Add e-mail notification target.

Body parameter

{
  "Email": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "HideForCustomers": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsEmailAdd	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_targets_email_edit

Code samples

PUT /notifications/targets/email/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/targets/email/edit

Edit e-mail notification target.

Body parameter

{
  "Name": "string",
  "Address": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "HideForCustomers": true,
  "ShowForCustomers": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsEmailEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__notifications_targets_seq_add

Code samples

POST /notifications/targets/seq/add HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /notifications/targets/seq/add

Add Seq server notification target.

Body parameter

{
  "ServerUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSeqAdd	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_targets_seq_edit

Code samples

PUT /notifications/targets/seq/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/targets/seq/edit

Edit Seq server notification target.

Body parameter

{
  "Name": "string",
  "ServerUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSeqEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__notifications_targets_slack_add

Code samples

POST /notifications/targets/slack/add HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /notifications/targets/slack/add

Add Slack notification target.

Body parameter

{
  "WebhookUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSlackAdd	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_targets_slack_edit

Code samples

PUT /notifications/targets/slack/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/targets/slack/edit

Edit Slack notification target.

Body parameter

{
  "Name": "string",
  "WebhookUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSlackEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__notifications_targets_snmp_add

Code samples

POST /notifications/targets/snmp/add HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /notifications/targets/snmp/add

Add SNMP notification target.

Body parameter

{
  "Ip": "string",
  "ManagerPort": 0,
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "CommunityString": "string",
  "TrapVersion": "string",
  "V3Context": "string",
  "V3Username": "string",
  "V3AuthPhrase": "string",
  "V3PrivacyPhrase": "string",
  "Name": "string",
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSnmpAdd	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_targets_snmp_edit

Code samples

PUT /notifications/targets/snmp/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/targets/snmp/edit

Edit SNMP notification target.

Body parameter

{
  "Name": "string",
  "ManagerAddress": "string",
  "ManagerPort": 0,
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "CommunityString": "string",
  "TrapVersion": "string",
  "V3Context": "string",
  "V3Username": "string",
  "V3AuthPhrase": "string",
  "V3PrivacyPhrase": "string",
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSnmpEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__notifications_targets_storone_support_add

Code samples

POST /notifications/targets/storone_support/add HTTP/1.1

Accept: application/json

POST /notifications/targets/storone_support/add

Add StorONE remote support target.

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__notifications_targets_syslog_add

Code samples

POST /notifications/targets/syslog/add HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /notifications/targets/syslog/add

Add Syslog notification target.

Body parameter

{
  "ConnectionType": "string",
  "ServerAddress": "string",
  "ServerPort": 0,
  "SslProtocol": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSyslogAdd	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__notifications_targets_syslog_edit

Code samples

PUT /notifications/targets/syslog/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /notifications/targets/syslog/edit

Edit Syslog notification target.

Body parameter

{
  "Name": "string",
  "ConnectionType": "string",
  "ServerAddress": "string",
  "ServerPort": 0,
  "SslProtocol": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	NotificationsTargetsSyslogEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

Replication

put__replication_edit

Code samples

PUT /replication/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /replication/edit

Edit a replication pair.

Body parameter

{
  "Application": "string",
  "Volume": "string",
  "TargetSystem": "string",
  "Synchronous": true,
  "Semisynchronous": true,
  "Asynchronous": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ReplicationEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__replication_list

Code samples

GET /replication/list HTTP/1.1

Accept: application/json

GET /replication/list

List replicated volumes.

Parameters

Name	In	Type	Required	Description
application	query	string	false	Limit results by the application instance name.
volume	query	string	false	Limit results by the volume name.
filterSecondary	query	boolean	false	Show only secondary volumes.
filterPrimary	query	boolean	false	Show only primary volumes.

Example responses

200 Response

{
  "Data": [
    {
      "Application": "string",
      "Template": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "VolumeEntityId": 0,
          "Id": 0,
          "MetadataVolumeEntityId": 0,
          "IsInternalVolume": true,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "IsRoot": true,
          "State": "Ok",
          "Vms": [
            "string"
          ],
          "Shares": [
            {
              "Application": "string",
              "Volume": "string",
              "Share": "string",
              "Path": "string",
              "Browsable": true,
              "RecycleBin": true,
              "ReadonlyAccess": true,
              "AllowedSubnets": [
                "string"
              ],
              "Smb": true,
              "Nfs": true
            }
          ],
          "Profile": "string",
          "Mapping": [
            {
              "Host": "string",
              "LunId": 0
            }
          ],
          "Naa": "string",
          "StatsInfo": {
            "UserDataAllocatedSizeInBytes": 0.1,
            "UserDataConsumedSizeInBytes": 0.1,
            "UpperTierAllocatedSizeInBytes": 0.1,
            "UpperTierConsumedSizeInBytes": 0.1,
            "RetentionAllocatedSizeInBytes": 0.1,
            "RetentionConsumedSizeInBytes": 0.1,
            "VRAIDAllocatedSizeInBytes": 0.1,
            "VRAIDConsumedSizeInBytes": 0.1,
            "Iops": 0.1,
            "LatencyInMilliseconds": 0.1,
            "IoSizeInBytes": 0.1,
            "ThroughputInBytes": 0.1
          },
          "FileSystemInformation": {
            "MountState": "Mounted",
            "ReplicationMetadata": "None",
            "Profile": "string",
            "FilesystemState": "string",
            "InodeCount": "string",
            "FreeInodes": "string",
            "BlockSize": "string",
            "BlockCount": "string",
            "FreeBlocks": "string",
            "FilesystemCreated": "string",
            "LastMountTime": "string",
            "LastWriteTime": "string",
            "MountCount": "string",
            "LastChecked": "string",
            "LifeTimeWrites": "string"
          },
          "Object": {
            "Application": "string",
            "Volume": "string",
            "IP": "string",
            "FloatingIp": "string",
            "Port": 0,
            "EnableSsl": true,
            "AccessKeys": [
              "string"
            ],
            "ObjectProvider": "Minio"
          },
          "ConnectivityType": "None",
          "Replication": {
            "IpAddress": "string",
            "Port": 0,
            "Role": "Unknown",
            "InternalRole": "Unknown",
            "LocalDataStatus": "NotAvailable",
            "ReplicationPairs": [
              {
                "SyncInPercentage": 0.1,
                "ReplicationId": 0,
                "RemoteSystemName": "string",
                "RemoteSystemId": 0,
                "RemoteSystemRole": "Unknown",
                "IpAddress": "string",
                "Port": 0,
                "RemoteAppName": "string",
                "RemoteVolName": "string",
                "ReplicationProtocol": "None",
                "ConnectionStatus": "Initializing",
                "RemoteDataStatus": "NotAvailable",
                "RemoteDiskStatus": "Unknown"
              }
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "DataDegradationHistogram": [
            0
          ],
          "MetadataDegradationHistogram": [
            0
          ],
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string",
          "DisableSpaceReclamation": true,
          "EncryptionKey": "string",
          "SaveEncryptedRecoveryKey": true,
          "Encrypted": true,
          "Uptime": "string",
          "ReadOnly": true,
          "Force": true
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "ParentConsistencyGroupId": 0,
          "ParentSnapshotId": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "IsVssBasedSnapshotScheduler": true,
          "VssInitiators": [
            "string"
          ],
          "IsDirectVssMapping": true,
          "IsAvailable": true,
          "WorkerProcess": 0,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "VolumeEntityId": 0,
              "Id": 0,
              "MetadataVolumeEntityId": 0,
              "IsInternalVolume": true,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "IsRoot": true,
              "State": "Ok",
              "Vms": [
                "string"
              ],
              "Shares": [
                {
                  "Application": "string",
                  "Volume": "string",
                  "Share": "string",
                  "Path": "string",
                  "Browsable": true,
                  "RecycleBin": true,
                  "ReadonlyAccess": true,
                  "AllowedSubnets": [
                    "string"
                  ],
                  "Smb": true,
                  "Nfs": true
                }
              ],
              "Profile": "string",
              "Mapping": [
                {
                  "Host": "string",
                  "LunId": 0
                }
              ],
              "Naa": "string",
              "StatsInfo": {
                "UserDataAllocatedSizeInBytes": 0.1,
                "UserDataConsumedSizeInBytes": 0.1,
                "UpperTierAllocatedSizeInBytes": 0.1,
                "UpperTierConsumedSizeInBytes": 0.1,
                "RetentionAllocatedSizeInBytes": 0.1,
                "RetentionConsumedSizeInBytes": 0.1,
                "VRAIDAllocatedSizeInBytes": 0.1,
                "VRAIDConsumedSizeInBytes": 0.1,
                "Iops": 0.1,
                "LatencyInMilliseconds": 0.1,
                "IoSizeInBytes": 0.1,
                "ThroughputInBytes": 0.1
              },
              "FileSystemInformation": {
                "MountState": "Mounted",
                "ReplicationMetadata": "None",
                "Profile": "string",
                "FilesystemState": "string",
                "InodeCount": "string",
                "FreeInodes": "string",
                "BlockSize": "string",
                "BlockCount": "string",
                "FreeBlocks": "string",
                "FilesystemCreated": "string",
                "LastMountTime": "string",
                "LastWriteTime": "string",
                "MountCount": "string",
                "LastChecked": "string",
                "LifeTimeWrites": "string"
              },
              "Object": {
                "Application": "string",
                "Volume": "string",
                "IP": "string",
                "FloatingIp": "string",
                "Port": 0,
                "EnableSsl": true,
                "AccessKeys": [
                  "string"
                ],
                "ObjectProvider": "Minio"
              },
              "ConnectivityType": "None",
              "Replication": {
                "IpAddress": "string",
                "Port": 0,
                "Role": "Unknown",
                "InternalRole": "Unknown",
                "LocalDataStatus": "NotAvailable",
                "ReplicationPairs": [
                  {
                    "SyncInPercentage": 0.1,
                    "ReplicationId": 0,
                    "RemoteSystemName": "string",
                    "RemoteSystemId": 0,
                    "RemoteSystemRole": "Unknown",
                    "IpAddress": "string",
                    "Port": 0,
                    "RemoteAppName": "string",
                    "RemoteVolName": "string",
                    "ReplicationProtocol": "None",
                    "ConnectionStatus": "Initializing",
                    "RemoteDataStatus": "NotAvailable",
                    "RemoteDiskStatus": "Unknown"
                  }
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "DataDegradationHistogram": [
                0
              ],
              "MetadataDegradationHistogram": [
                0
              ],
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string",
              "DisableSpaceReclamation": true,
              "EncryptionKey": "string",
              "SaveEncryptedRecoveryKey": true,
              "Encrypted": true,
              "Uptime": "string",
              "ReadOnly": true,
              "Force": true
            }
          ],
          "Snapshots": [
            {
              "Id": 0,
              "Date": "2019-08-24T14:15:22Z",
              "Owner": "None"
            }
          ]
        }
      ],
      "Vms": [
        {
          "Name": "string",
          "VolumeName": "string"
        }
      ]
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	ApplicationElementApiResult
400	Bad Request	Bad Request	string

put__replication_primary

Code samples

PUT /replication/primary HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /replication/primary

Promote secondary volumes to active/primary state.

Body parameter

{
  "Application": "string",
  "Volume": [
    "string"
  ],
  "Cgids": [
    0
  ],
  "AllSecondaryVolumes": true,
  "InactiveFloatingToActivate": [
    "string"
  ],
  "ActivateAllInactiveFloatingIps": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ReplicationPrimary	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__replication_refresh

Code samples

GET /replication/refresh HTTP/1.1

Accept: application/json

GET /replication/refresh

Refresh replication connections.

Parameters

Name	In	Type	Required	Description
application	query	string	false	Perform on this application only.
volume	query	string	false	Perform on this volume only.
reconnect	query	boolean	false	Disconnect and reconnect the replication link.

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__replication_start

Code samples

POST /replication/start HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /replication/start

Replicate a volume.

Body parameter

{
  "Application": "string",
  "Volume": "string",
  "TargetSystem": "string",
  "TargetApplication": "string",
  "TargetVolume": "string",
  "SourceFloatingIp": "string",
  "TargetFloatingIp": "string",
  "Synchronous": true,
  "Semisynchronous": true,
  "Asynchronous": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ReplicationStart	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__replication_stop

Code samples

DELETE /replication/stop HTTP/1.1

Accept: application/json

DELETE /replication/stop

Stop volume replication.

Parameters

Name	In	Type	Required	Description
application	query	string	false	The source app on which the volume you want to stop the replication.
volume	query	string	false	Source volume to stop replicating.
targetSystem	query	string	false	Stop replication for this target system.
allowOnDisconnected	query	boolean	false	Allow stopping the replication on systems which are disconnected. --force Force operation.
force	query	boolean	false	Force operation.
forceDeleteReplicationMetadata	query	boolean	false	Delete the replication metadata for NAS volumes.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__replication_floatingips_create

Code samples

POST /replication/floatingips/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /replication/floatingips/create

Create a replication floating ip.

Body parameter

{
  "Name": "string",
  "Nodes": [
    "string"
  ],
  "Interfaces": [
    "string"
  ],
  "Addresses": [
    "string"
  ],
  "Mask": "string",
  "Gateway": "string",
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ReplicationFloatingipsCreate	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__replication_floatingips_delete

Code samples

DELETE /replication/floatingips/delete HTTP/1.1

Accept: application/json

DELETE /replication/floatingips/delete

Delete a replication floating ip.

Parameters

Name	In	Type	Required	Description
name	query	string	false	The replication floating ip to delete.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__replication_floatingips_edit

Code samples

POST /replication/floatingips/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /replication/floatingips/edit

Edit a replication floating ip.

Body parameter

{
  "Name": "string",
  "Newname": "string",
  "Nodes": [
    "string"
  ],
  "Interfaces": [
    "string"
  ],
  "Addresses": [
    "string"
  ],
  "Mask": "string",
  "Gateway": "string",
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ReplicationFloatingipsEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__replication_floatingips_list

Code samples

GET /replication/floatingips/list HTTP/1.1

Accept: application/json

GET /replication/floatingips/list

View replication floatings ips.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Filter replication floating ips by name.
ip	query	string	false	Filter replication floating ips by ip.

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

Resources

delete__resources_delete

Code samples

DELETE /resources/delete HTTP/1.1

Accept: application/json

DELETE /resources/delete

Delete missing resources.

Parameters

Name	In	Type	Required	Description
entityIds	query	array[integer]	false	Delete missing resources.
all	query	boolean	false	Delete all missing resources.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__resources_list

Code samples

GET /resources/list HTTP/1.1

Accept: application/json

GET /resources/list

List all hardware resources.

Parameters

Name	In	Type	Required	Description
resourceType	query	string	false	Show results by resource type.
node	query	string	false	Limit results for a specific node.
errors	query	boolean	false	Show only components with errors.
details	query	boolean	false	Show advanced information.
sensors	query	boolean	false	Show sensor information.
ids	query	array[integer]	false	Show only results for resources filtered by these ids.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	NodeElementApiResult
400	Bad Request	Bad Request	string

put__resources_drives_approve

Code samples

PUT /resources/drives/approve HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/approve

Approve new drives.

Body parameter

{
  "DriveIds": [
    0
  ],
  "All": true,
  "Patterns": [
    "string"
  ],
  "Count": 0,
  "ManualPool": "string",
  "Force": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ResourcesDrivesApprove	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__resources_drives_list

Code samples

GET /resources/drives/list HTTP/1.1

Accept: application/json

GET /resources/drives/list

List all available drives.

Parameters

Name	In	Type	Required	Description
node	query	string	false	Show results from a specific node. If not specified, the results will be gathered from the first available node.
errors	query	boolean	false	Show only components with errors.
details	query	boolean	false	Show advanced information.
ids	query	array[integer]	false	Show only results for resources filtered by these ids.
led	query	boolean	false	Show the LED status.
patterns	query	array[string]	false	Patterns to filter drives by either drive name, capacity, serial or type. Regex is supported.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Device": "string",
      "UsedCapacityInBytes": 0,
      "ManualPool": "string",
      "DeviceName": "string",
      "PhysicalSector": "string",
      "LogicalSector": "string",
      "Vendor": "string",
      "Model": "string",
      "RotationRate": "string",
      "EnclosureIndex": "string",
      "OSName": "string",
      "Version": "string",
      "SelfEncryptingDrive": "NotSupported",
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "LedState": "string",
      "Type": "HDD",
      "CapacityInBytes": 0,
      "ApprovedState": "Approved",
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	DriveElementApiResult
400	Bad Request	Bad Request	string

get__resources_drives_performance_analyzer

Code samples

GET /resources/drives/performance_analyzer HTTP/1.1

Accept: application/json

GET /resources/drives/performance_analyzer

Run performance tests on drives.

Parameters

Name	In	Type	Required	Description
driveIds	query	array[integer]	false	Run the performance analyzer on these ids.
all	query	boolean	false	Run the performance analyzer on all drives.
ssd	query	boolean	false	Run the performance analyzer on ssd drives.
hdd	query	boolean	false	Run the performance analyzer on hdd drives.
nvme	query	boolean	false	Run the performance analyzer on nvme drives.
manualPools	query	string	false	Run the performance analyzer on manual pools drives.
iterationTimeInSeconds	query	integer(int64)	false	Duration for each iteration in seconds.

Example responses

200 Response

{
  "Data": [
    {
      "NodeName": "string",
      "PerformanceTestName": "string",
      "Entity": "string",
      "Status": "SystemPerformance",
      "PerformanceResult": {
        "IOPS": 0,
        "Throughput": "string",
        "LatencyInMilliseconds": 0.1,
        "DurationInSec": 0.1
      }
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	PerformanceAnalyzerDriveElementApiResult
400	Bad Request	Bad Request	string

get__resources_drives_smart

Code samples

GET /resources/drives/smart HTTP/1.1

Accept: application/json

GET /resources/drives/smart

Get SMART output of drives.

Parameters

Name	In	Type	Required	Description
node	query	string	false	The node on which the SMART command will be inititaed.
driveid	query	integer(int64)	false	The drive id on which the SMART command will be initiated.

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__resources_network_iscsi

Code samples

PUT /resources/network/iscsi HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/network/iscsi

Enable/disable iscsi traffic on specific ips.

Body parameter

{
  "Enable": true,
  "Force": true
}

Parameters

Name	In	Type	Required	Description
ips	query	array[string]	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ResourcesNetworkIscsi	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__resources_network_list

Code samples

GET /resources/network/list HTTP/1.1

Accept: application/json

GET /resources/network/list

List all available network interface cards.

Parameters

Name	In	Type	Required	Description
errors	query	boolean	false	Show only components with errors.
details	query	boolean	false	Show advanced information.
ids	query	array[integer]	false	Show only results for resources filtered by these ids.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	NodeElementApiResult
400	Bad Request	Bad Request	string

put__resources_network_nvmeof

Code samples

PUT /resources/network/nvmeof HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/network/nvmeof

Enable/disable nvmeof traffic on specific ips.

Body parameter

{
  "Port": 0,
  "Enable": true,
  "Rdma": true,
  "Tcp": true
}

Parameters

Name	In	Type	Required	Description
ip	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ResourcesNetworkNvmeof	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__resources_network_ping

Code samples

GET /resources/network/ping HTTP/1.1

Accept: application/json

GET /resources/network/ping

Ping test.

Parameters

Name	In	Type	Required	Description
ip	query	string	false	The ip to try to ping.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	NodeElementApiResult
400	Bad Request	Bad Request	string

post__resources_drives_pools_create

Code samples

POST /resources/drives/pools/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /resources/drives/pools/create

Create a manual pool.

Body parameter

{
  "Name": "string",
  "MaxSectorsKb": 0
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ResourcesDrivesPoolsCreate	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__resources_drives_pools_edit

Code samples

PUT /resources/drives/pools/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/pools/edit

Edit a manual pool.

Body parameter

{
  "Name": "string",
  "NewName": "string",
  "MaxSectorsKb": 0
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ResourcesDrivesPoolsEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__resources_drives_pools_list

Code samples

GET /resources/drives/pools/list HTTP/1.1

Accept: application/json

GET /resources/drives/pools/list

List all available pools.

Parameters

Name	In	Type	Required	Description
drives	query	boolean	false	See drives within the pools.
volumes	query	boolean	false	See volumes within the pools.
capacity	query	boolean	false	See basic capacity consumptions.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "TotalCapacityInBytes": 0.1,
      "UsedCapacityInBytes": 0.1,
      "Type": "UserDefined",
      "ManualPoolType": "Normal",
      "DriveCount": 0,
      "VolumesCount": 0,
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Volumes": [
        {
          "Id": 0,
          "Application": "string",
          "Volume": "string"
        }
      ],
      "IsHdd": true,
      "IsSsd": true,
      "MaxSectorsKb": 0
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	DrivePoolElementApiResult
400	Bad Request	Bad Request	string

put__resources_drives_sed_initialize

Code samples

PUT /resources/drives/sed/initialize HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/sed/initialize

Initialize self-encrypting drives with a password. This should be done on new drives.

Body parameter

{
  "DriveIds": [
    0
  ],
  "All": true,
  "Password": "string",
  "ConfirmPassword": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ResourcesDrivesSedInitialize	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__resources_drives_sed_supply_password

Code samples

PUT /resources/drives/sed/supply_password HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/sed/supply_password

Set password used to unlock the self-encrypting drives.

Body parameter

{
  "Password": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	ResourcesDrivesSedSupplyPassword	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

Settings

put__settings_authentication

Code samples

PUT /settings/authentication HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /settings/authentication

Enable/disable two factor authentication.

Body parameter

{
  "EnableMultifactorAuthentication": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	SettingsAuthentication	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__settings_capacity_units

Code samples

PUT /settings/capacity_units HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /settings/capacity_units

Change the capacity units used for drives, volumes and statistics.

Body parameter

{
  "BinaryUnits": true,
  "DecimalUnits": true
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	SettingsCapacityUnits	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__settings_anomaly_detection_edit

Code samples

PUT /settings/anomaly_detection/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /settings/anomaly_detection/edit

Update anomaly detection settings.

Body parameter

{
  "Timeframe_days": 0,
  "ChangeInPercentage": 0.1
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	SettingsAnomalyDetectionEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__settings_anomaly_detection_show

Code samples

GET /settings/anomaly_detection/show HTTP/1.1

Accept: application/json

GET /settings/anomaly_detection/show

Display anomaly detection settings.

Example responses

200 Response

{
  "TimeframeDays": 0,
  "AbnormalChangePercentage": 0.1
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	AnomalyDetectionSettingsResult
400	Bad Request	Bad Request	string

Systems

get__systems_list

Code samples

GET /systems/list HTTP/1.1

Accept: application/json

GET /systems/list

List systems.

Parameters

Name	In	Type	Required	Description
connectToAllSystems	query	boolean	false	Create a connection to all systems.
showNodes	query	boolean	false	Show nodes within the systems.

Example responses

200 Response

{
  "Systems": [
    {
      "Id": 0,
      "Name": "string",
      "IsCurrentlyConnectedSystem": true,
      "Connectivity": "Relay",
      "ConnectedNodeAddress": "string",
      "RefreshedCachedQueryCount": 0,
      "Nodes": [
        {
          "Name": "string",
          "Id": 0,
          "Time": "2019-08-24T14:15:22Z",
          "State": "Running",
          "HAState": "Unknown",
          "CurrentManagementConnection": true
        }
      ],
      "ReplicationTargetSystems": [
        "string"
      ]
    }
  ],
  "Message": "string"
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	SystemsList
400	Bad Request	Bad Request	string

put__systems_rename

Code samples

PUT /systems/rename HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /systems/rename

Rename a system.

Body parameter

{
  "Name": "string",
  "Id": 0,
  "Newname": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	SystemsRename	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__systems_select

Code samples

GET /systems/select HTTP/1.1

Accept: application/json

GET /systems/select

Switch to a different system.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Switch and manage this system by name.
id	query	integer(int64)	false	Switch and manage this system by id.

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

Templates

post__templates_create

Code samples

POST /templates/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /templates/create

Create an application template.

Body parameter

{
  "Application": "string",
  "Description": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	TemplateElementCreate	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__templates_delete

Code samples

DELETE /templates/delete HTTP/1.1

Accept: application/json

DELETE /templates/delete

Delete an application template.

Parameters

Name	In	Type	Required	Description
name	query	string	false	The name of the application template to delete.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__templates_edit

Code samples

PUT /templates/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /templates/edit

Edit an application template.

Body parameter

{
  "Application": "string",
  "Description": "string"
}

Parameters

Name	In	Type	Required	Description
application	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	TemplateElementEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__templates_list

Code samples

GET /templates/list HTTP/1.1

Accept: application/json

GET /templates/list

List application templates.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Limit results by the application template name.
desc	query	boolean	false	Show description of templates.
cg	query	boolean	false	Show consistency groups within the applications.
vols	query	boolean	false	Show volumes within the application templates.

Example responses

200 Response

{
  "Data": [
    {
      "Application": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "Id": 0,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string"
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "VolumeShadowCopySupport": true,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "Id": 0,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string"
            }
          ]
        }
      ]
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateElementApiResult
400	Bad Request	Bad Request	string

put__templates_snapshots_schedule

Code samples

PUT /templates/snapshots/schedule HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /templates/snapshots/schedule

Schedule snapshots.

Body parameter

{
  "Frequency": [
    "string"
  ],
  "Retention": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
cgid	query	integer(int64)	false	none
application	query	string	false	none
volume	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	TemplatesSnapshotsSchedule	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

post__templates_volumes_create

Code samples

POST /templates/volumes/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /templates/volumes/create

Create a new volume template.

Body parameter

{
  "Application": "string",
  "Volume": "string",
  "CapacityInBytes": 0,
  "Pool": "string",
  "N": 0,
  "K": 0,
  "MetadataPool": "string",
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "StripedPools": [
    "string"
  ],
  "StripedMetadataPools": [
    "string"
  ],
  "SnapshotCapacityInBytes": 0,
  "GroupedVolume": "string",
  "Cgid": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	VolumeTemplateElementCreate	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__templates_volumes_delete

Code samples

DELETE /templates/volumes/delete HTTP/1.1

Accept: application/json

DELETE /templates/volumes/delete

Delete an application template volume.

Parameters

Name	In	Type	Required	Description
application	query	string	false	The name of the application template.
volumes	query	array[string]	false	Delete specific volumes within the application template (and not the entire application template).
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__templates_volumes_edit

Code samples

PUT /templates/volumes/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /templates/volumes/edit

Change the parameters of a volume within an application template.

Body parameter

{
  "Volume": "string",
  "CapacityInBytes": 0,
  "Pool": "string",
  "N": 0,
  "K": 0,
  "MetadataPool": "string",
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "StripedPools": [
    "string"
  ],
  "StripedMetadataPools": [
    "string"
  ],
  "SnapshotCapacityInBytes": 0,
  "GroupedVolume": "string",
  "Cgid": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Parameters

Name	In	Type	Required	Description
application	query	string	false	none
volume	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	VolumeTemplateElementEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__templates_volumes_list

Code samples

GET /templates/volumes/list HTTP/1.1

Accept: application/json

GET /templates/volumes/list

List application volume templates.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Limit results by the application template name.
desc	query	boolean	false	Show description of templates.
cg	query	boolean	false	Show consistency groups within the applications.

Example responses

200 Response

{
  "Data": [
    {
      "Application": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "Id": 0,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string"
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "VolumeShadowCopySupport": true,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "Id": 0,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string"
            }
          ]
        }
      ]
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	TemplateElementApiResult
400	Bad Request	Bad Request	string

Users

post__users_create

Code samples

POST /users/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /users/create

Creating another user that can view and manage S1.

Body parameter

{
  "Name": "string",
  "Password": "string",
  "Role": "string",
  "Email": "string"
}

Parameters

Name	In	Type	Required	Description
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	UserElementCreate	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

delete__users_delete

Code samples

DELETE /users/delete HTTP/1.1

Accept: application/json

DELETE /users/delete

Delete user.

Parameters

Name	In	Type	Required	Description
name	query	string	false	The user name to delete.
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

put__users_edit

Code samples

PUT /users/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /users/edit

Edit a user.

Body parameter

{
  "Role": "string",
  "Password": "string",
  "Email": "string"
}

Parameters

Name	In	Type	Required	Description
name	query	string	false	none
async	query	boolean	false	none
uncommitAndAggregateId	query	string	false	none
body	body	UserElementEdit	false	none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Bad Request	string

get__users_list

Code samples

GET /users/list HTTP/1.1

Accept: application/json

GET /users/list

List all available users.

Parameters

Name	In	Type	Required	Description
name	query	string	false	Filter users by name.
role	query	string	false	Filter by permissions.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Password": "string",
      "Email": "string",
      "TwoStepAuthenticationEnabled": true,
      "Role": "string"
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	UserElementApiResult
400	Bad Request	Bad Request	string

Version

get__Version

Code samples

GET /Version HTTP/1.1

Accept: application/json

GET /Version

See S1 version.

Example responses

200 Response

{
  "Versions": [
    {
      "Component": "string",
      "Version": "string",
      "BuildNumber": "string"
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	S1Version
400	Bad Request	Bad Request	string

Workflows

get__workflows_volume_provisioning

Code samples

GET /workflows/volume_provisioning HTTP/1.1

Accept: application/json

GET /workflows/volume_provisioning

Example responses

200 Response

{
  "Path": "string",
  "DisplayName": "string",
  "RedirectPathOnSuccess": "string",
  "TitleForChildrenSelection": "string",
  "OrderedCommands": [
    {
      "Command": "string",
      "DisplayName": "string",
      "AllowSkipping": true,
      "AllowRecurrentOperations": true
    }
  ],
  "Children": [
    {
      "Path": "string",
      "DisplayName": "string",
      "RedirectPathOnSuccess": "string",
      "TitleForChildrenSelection": "string",
      "OrderedCommands": [
        {
          "Command": "string",
          "DisplayName": "string",
          "AllowSkipping": true,
          "AllowRecurrentOperations": true
        }
      ],
      "Children": []
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	WorkflowElement
400	Bad Request	Bad Request	string

get__workflows_volume_provisioning_block

Code samples

GET /workflows/volume_provisioning/block HTTP/1.1

Accept: application/json

GET /workflows/volume_provisioning/block

Example responses

200 Response

{
  "Path": "string",
  "DisplayName": "string",
  "RedirectPathOnSuccess": "string",
  "TitleForChildrenSelection": "string",
  "OrderedCommands": [
    {
      "Command": "string",
      "DisplayName": "string",
      "AllowSkipping": true,
      "AllowRecurrentOperations": true
    }
  ],
  "Children": [
    {
      "Path": "string",
      "DisplayName": "string",
      "RedirectPathOnSuccess": "string",
      "TitleForChildrenSelection": "string",
      "OrderedCommands": [
        {
          "Command": "string",
          "DisplayName": "string",
          "AllowSkipping": true,
          "AllowRecurrentOperations": true
        }
      ],
      "Children": []
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	WorkflowElement
400	Bad Request	Bad Request	string

get__workflows_volume_provisioning_NAS

Code samples

GET /workflows/volume_provisioning/NAS HTTP/1.1

Accept: application/json

GET /workflows/volume_provisioning/NAS

Example responses

200 Response

{
  "Path": "string",
  "DisplayName": "string",
  "RedirectPathOnSuccess": "string",
  "TitleForChildrenSelection": "string",
  "OrderedCommands": [
    {
      "Command": "string",
      "DisplayName": "string",
      "AllowSkipping": true,
      "AllowRecurrentOperations": true
    }
  ],
  "Children": [
    {
      "Path": "string",
      "DisplayName": "string",
      "RedirectPathOnSuccess": "string",
      "TitleForChildrenSelection": "string",
      "OrderedCommands": [
        {
          "Command": "string",
          "DisplayName": "string",
          "AllowSkipping": true,
          "AllowRecurrentOperations": true
        }
      ],
      "Children": []
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	WorkflowElement
400	Bad Request	Bad Request	string

get__workflows_volume_provisioning_Object

Code samples

GET /workflows/volume_provisioning/Object HTTP/1.1

Accept: application/json

GET /workflows/volume_provisioning/Object

Example responses

200 Response

{
  "Path": "string",
  "DisplayName": "string",
  "RedirectPathOnSuccess": "string",
  "TitleForChildrenSelection": "string",
  "OrderedCommands": [
    {
      "Command": "string",
      "DisplayName": "string",
      "AllowSkipping": true,
      "AllowRecurrentOperations": true
    }
  ],
  "Children": [
    {
      "Path": "string",
      "DisplayName": "string",
      "RedirectPathOnSuccess": "string",
      "TitleForChildrenSelection": "string",
      "OrderedCommands": [
        {
          "Command": "string",
          "DisplayName": "string",
          "AllowSkipping": true,
          "AllowRecurrentOperations": true
        }
      ],
      "Children": []
    }
  ]
}

400 Response

"string"

Responses

Status	Meaning	Description	Schema
200	OK	Success	WorkflowElement
400	Bad Request	Bad Request	string

Vcp

post__vmware_datastore_vcp_create

Code samples

POST /vmware/datastore/vcp/create HTTP/1.1

Content-Type: application/json-patch+json

async: true

POST /vmware/datastore/vcp/create

Body parameter

{
  "volume": {
    "Application": "string",
    "Volume": "string",
    "VolumeEntityId": 0,
    "Id": 0,
    "MetadataVolumeEntityId": 0,
    "IsInternalVolume": true,
    "CapacityInBytes": 0,
    "SnapshotCapacityInBytes": 0,
    "Tiers": {
      "TierEntityIds": [
        0
      ],
      "TierPools": [
        "string"
      ],
      "TierN": [
        0
      ],
      "TierK": [
        0
      ],
      "TierSizesInBytes": [
        0
      ],
      "EvacuationThresholdsInPercentage": [
        0.1
      ],
      "LowerThresholdsInPercentage": [
        0.1
      ],
      "TierDataDegradationHistogram": [
        [
          0
        ]
      ],
      "TierMetadataDegradationHistogram": [
        [
          0
        ]
      ]
    },
    "IsRoot": true,
    "State": "Ok",
    "Vms": [
      "string"
    ],
    "Shares": [
      {
        "Application": "string",
        "Volume": "string",
        "Share": "string",
        "Path": "string",
        "Browsable": true,
        "RecycleBin": true,
        "ReadonlyAccess": true,
        "AllowedSubnets": [
          "string"
        ],
        "Smb": true,
        "Nfs": true
      }
    ],
    "Profile": "string",
    "Mapping": [
      {
        "Host": "string",
        "LunId": 0
      }
    ],
    "Naa": "string",
    "StatsInfo": {
      "UserDataAllocatedSizeInBytes": 0.1,
      "UserDataConsumedSizeInBytes": 0.1,
      "UpperTierAllocatedSizeInBytes": 0.1,
      "UpperTierConsumedSizeInBytes": 0.1,
      "RetentionAllocatedSizeInBytes": 0.1,
      "RetentionConsumedSizeInBytes": 0.1,
      "VRAIDAllocatedSizeInBytes": 0.1,
      "VRAIDConsumedSizeInBytes": 0.1,
      "Iops": 0.1,
      "LatencyInMilliseconds": 0.1,
      "IoSizeInBytes": 0.1,
      "ThroughputInBytes": 0.1
    },
    "FileSystemInformation": {
      "MountState": "Mounted",
      "ReplicationMetadata": "None",
      "Profile": "string",
      "FilesystemState": "string",
      "InodeCount": "string",
      "FreeInodes": "string",
      "BlockSize": "string",
      "BlockCount": "string",
      "FreeBlocks": "string",
      "FilesystemCreated": "string",
      "LastMountTime": "string",
      "LastWriteTime": "string",
      "MountCount": "string",
      "LastChecked": "string",
      "LifeTimeWrites": "string"
    },
    "Object": {
      "Application": "string",
      "Volume": "string",
      "IP": "string",
      "FloatingIp": "string",
      "Port": 0,
      "EnableSsl": true,
      "AccessKeys": [
        "string"
      ],
      "ObjectProvider": "Minio"
    },
    "ConnectivityType": "None",
    "Replication": {
      "IpAddress": "string",
      "Port": 0,
      "Role": "Unknown",
      "InternalRole": "Unknown",
      "LocalDataStatus": "NotAvailable",
      "ReplicationPairs": [
        {
          "SyncInPercentage": 0.1,
          "ReplicationId": 0,
          "RemoteSystemName": "string",
          "RemoteSystemId": 0,
          "RemoteSystemRole": "Unknown",
          "IpAddress": "string",
          "Port": 0,
          "RemoteAppName": "string",
          "RemoteVolName": "string",
          "ReplicationProtocol": "None",
          "ConnectionStatus": "Initializing",
          "RemoteDataStatus": "NotAvailable",
          "RemoteDiskStatus": "Unknown"
        }
      ]
    },
    "Pool": "string",
    "StripedPools": [
      "string"
    ],
    "Log2StrideSectors": 0,
    "DataDegradationHistogram": [
      0
    ],
    "MetadataDegradationHistogram": [
      0
    ],
    "MetadataPool": "string",
    "StripedMetadataPools": [
      "string"
    ],
    "N": 0,
    "K": 0,
    "MetadataN": 0,
    "MetadataK": 0,
    "SectorSize": "string",
    "Cgid": 0,
    "GroupedVolume": "string",
    "DisableSpaceReclamation": true,
    "EncryptionKey": "string",
    "SaveEncryptedRecoveryKey": true,
    "Encrypted": true,
    "Uptime": "string",
    "ReadOnly": true,
    "Force": true
  },
  "datastore": {
    "Name": "string",
    "Type": "string",
    "Volume": [
      "string"
    ],
    "Details": [
      "string"
    ],
    "EsxiHosts": [
      "string"
    ],
    "Vms": [
      "string"
    ]
  },
  "SessionTokenVCP": "string",
  "VCenterAddress": "string"
}

Parameters

Name	In	Type	Required	Description
async	header	boolean	false	none
body	body	VolumeElementVcp	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Success	None

Schemas

AnomalyDetectionSettingsResult

{
  "TimeframeDays": 0,
  "AbnormalChangePercentage": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
TimeframeDays	integer(int64)	false	none	none
AbnormalChangePercentage	number(double)	false	none	none

ApplicationElement

{
  "Application": "string",
  "Template": "string",
  "Description": "string",
  "Volumes": [
    {
      "Application": "string",
      "Volume": "string",
      "VolumeEntityId": 0,
      "Id": 0,
      "MetadataVolumeEntityId": 0,
      "IsInternalVolume": true,
      "CapacityInBytes": 0,
      "SnapshotCapacityInBytes": 0,
      "Tiers": {
        "TierEntityIds": [
          0
        ],
        "TierPools": [
          "string"
        ],
        "TierN": [
          0
        ],
        "TierK": [
          0
        ],
        "TierSizesInBytes": [
          0
        ],
        "EvacuationThresholdsInPercentage": [
          0.1
        ],
        "LowerThresholdsInPercentage": [
          0.1
        ],
        "TierDataDegradationHistogram": [
          [
            0
          ]
        ],
        "TierMetadataDegradationHistogram": [
          [
            0
          ]
        ]
      },
      "IsRoot": true,
      "State": "Ok",
      "Vms": [
        "string"
      ],
      "Shares": [
        {
          "Application": "string",
          "Volume": "string",
          "Share": "string",
          "Path": "string",
          "Browsable": true,
          "RecycleBin": true,
          "ReadonlyAccess": true,
          "AllowedSubnets": [
            "string"
          ],
          "Smb": true,
          "Nfs": true
        }
      ],
      "Profile": "string",
      "Mapping": [
        {
          "Host": "string",
          "LunId": 0
        }
      ],
      "Naa": "string",
      "StatsInfo": {
        "UserDataAllocatedSizeInBytes": 0.1,
        "UserDataConsumedSizeInBytes": 0.1,
        "UpperTierAllocatedSizeInBytes": 0.1,
        "UpperTierConsumedSizeInBytes": 0.1,
        "RetentionAllocatedSizeInBytes": 0.1,
        "RetentionConsumedSizeInBytes": 0.1,
        "VRAIDAllocatedSizeInBytes": 0.1,
        "VRAIDConsumedSizeInBytes": 0.1,
        "Iops": 0.1,
        "LatencyInMilliseconds": 0.1,
        "IoSizeInBytes": 0.1,
        "ThroughputInBytes": 0.1
      },
      "FileSystemInformation": {
        "MountState": "Mounted",
        "ReplicationMetadata": "None",
        "Profile": "string",
        "FilesystemState": "string",
        "InodeCount": "string",
        "FreeInodes": "string",
        "BlockSize": "string",
        "BlockCount": "string",
        "FreeBlocks": "string",
        "FilesystemCreated": "string",
        "LastMountTime": "string",
        "LastWriteTime": "string",
        "MountCount": "string",
        "LastChecked": "string",
        "LifeTimeWrites": "string"
      },
      "Object": {
        "Application": "string",
        "Volume": "string",
        "IP": "string",
        "FloatingIp": "string",
        "Port": 0,
        "EnableSsl": true,
        "AccessKeys": [
          "string"
        ],
        "ObjectProvider": "Minio"
      },
      "ConnectivityType": "None",
      "Replication": {
        "IpAddress": "string",
        "Port": 0,
        "Role": "Unknown",
        "InternalRole": "Unknown",
        "LocalDataStatus": "NotAvailable",
        "ReplicationPairs": [
          {
            "SyncInPercentage": 0.1,
            "ReplicationId": 0,
            "RemoteSystemName": "string",
            "RemoteSystemId": 0,
            "RemoteSystemRole": "Unknown",
            "IpAddress": "string",
            "Port": 0,
            "RemoteAppName": "string",
            "RemoteVolName": "string",
            "ReplicationProtocol": "None",
            "ConnectionStatus": "Initializing",
            "RemoteDataStatus": "NotAvailable",
            "RemoteDiskStatus": "Unknown"
          }
        ]
      },
      "Pool": "string",
      "StripedPools": [
        "string"
      ],
      "Log2StrideSectors": 0,
      "DataDegradationHistogram": [
        0
      ],
      "MetadataDegradationHistogram": [
        0
      ],
      "MetadataPool": "string",
      "StripedMetadataPools": [
        "string"
      ],
      "N": 0,
      "K": 0,
      "MetadataN": 0,
      "MetadataK": 0,
      "SectorSize": "string",
      "Cgid": 0,
      "GroupedVolume": "string",
      "DisableSpaceReclamation": true,
      "EncryptionKey": "string",
      "SaveEncryptedRecoveryKey": true,
      "Encrypted": true,
      "Uptime": "string",
      "ReadOnly": true,
      "Force": true
    }
  ],
  "ConsistencyGroups": [
    {
      "Id": 0,
      "ParentConsistencyGroupId": 0,
      "ParentSnapshotId": 0,
      "SnapshotScheduler": [
        "string"
      ],
      "IsVssBasedSnapshotScheduler": true,
      "VssInitiators": [
        "string"
      ],
      "IsDirectVssMapping": true,
      "IsAvailable": true,
      "WorkerProcess": 0,
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "VolumeEntityId": 0,
          "Id": 0,
          "MetadataVolumeEntityId": 0,
          "IsInternalVolume": true,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "IsRoot": true,
          "State": "Ok",
          "Vms": [
            "string"
          ],
          "Shares": [
            {
              "Application": "string",
              "Volume": "string",
              "Share": "string",
              "Path": "string",
              "Browsable": true,
              "RecycleBin": true,
              "ReadonlyAccess": true,
              "AllowedSubnets": [
                "string"
              ],
              "Smb": true,
              "Nfs": true
            }
          ],
          "Profile": "string",
          "Mapping": [
            {
              "Host": "string",
              "LunId": 0
            }
          ],
          "Naa": "string",
          "StatsInfo": {
            "UserDataAllocatedSizeInBytes": 0.1,
            "UserDataConsumedSizeInBytes": 0.1,
            "UpperTierAllocatedSizeInBytes": 0.1,
            "UpperTierConsumedSizeInBytes": 0.1,
            "RetentionAllocatedSizeInBytes": 0.1,
            "RetentionConsumedSizeInBytes": 0.1,
            "VRAIDAllocatedSizeInBytes": 0.1,
            "VRAIDConsumedSizeInBytes": 0.1,
            "Iops": 0.1,
            "LatencyInMilliseconds": 0.1,
            "IoSizeInBytes": 0.1,
            "ThroughputInBytes": 0.1
          },
          "FileSystemInformation": {
            "MountState": "Mounted",
            "ReplicationMetadata": "None",
            "Profile": "string",
            "FilesystemState": "string",
            "InodeCount": "string",
            "FreeInodes": "string",
            "BlockSize": "string",
            "BlockCount": "string",
            "FreeBlocks": "string",
            "FilesystemCreated": "string",
            "LastMountTime": "string",
            "LastWriteTime": "string",
            "MountCount": "string",
            "LastChecked": "string",
            "LifeTimeWrites": "string"
          },
          "Object": {
            "Application": "string",
            "Volume": "string",
            "IP": "string",
            "FloatingIp": "string",
            "Port": 0,
            "EnableSsl": true,
            "AccessKeys": [
              "string"
            ],
            "ObjectProvider": "Minio"
          },
          "ConnectivityType": "None",
          "Replication": {
            "IpAddress": "string",
            "Port": 0,
            "Role": "Unknown",
            "InternalRole": "Unknown",
            "LocalDataStatus": "NotAvailable",
            "ReplicationPairs": [
              {
                "SyncInPercentage": 0.1,
                "ReplicationId": 0,
                "RemoteSystemName": "string",
                "RemoteSystemId": 0,
                "RemoteSystemRole": "Unknown",
                "IpAddress": "string",
                "Port": 0,
                "RemoteAppName": "string",
                "RemoteVolName": "string",
                "ReplicationProtocol": "None",
                "ConnectionStatus": "Initializing",
                "RemoteDataStatus": "NotAvailable",
                "RemoteDiskStatus": "Unknown"
              }
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "DataDegradationHistogram": [
            0
          ],
          "MetadataDegradationHistogram": [
            0
          ],
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string",
          "DisableSpaceReclamation": true,
          "EncryptionKey": "string",
          "SaveEncryptedRecoveryKey": true,
          "Encrypted": true,
          "Uptime": "string",
          "ReadOnly": true,
          "Force": true
        }
      ],
      "Snapshots": [
        {
          "Id": 0,
          "Date": "2019-08-24T14:15:22Z",
          "Owner": "None"
        }
      ]
    }
  ],
  "Vms": [
    {
      "Name": "string",
      "VolumeName": "string"
    }
  ]
}

List application instances.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	Limit results by the application instance name.
Template	string¦null	false	none	none
Description	string¦null	false	none	none
Volumes	[VolumeElement]¦null	false	none	[List volumes.]
ConsistencyGroups	[ConsistencyGroupElement]¦null	false	none	none
Vms	[VmElement]¦null	false	none	none

ApplicationElementApiResult

{
  "Data": [
    {
      "Application": "string",
      "Template": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "VolumeEntityId": 0,
          "Id": 0,
          "MetadataVolumeEntityId": 0,
          "IsInternalVolume": true,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "IsRoot": true,
          "State": "Ok",
          "Vms": [
            "string"
          ],
          "Shares": [
            {
              "Application": "string",
              "Volume": "string",
              "Share": "string",
              "Path": "string",
              "Browsable": true,
              "RecycleBin": true,
              "ReadonlyAccess": true,
              "AllowedSubnets": [
                "string"
              ],
              "Smb": true,
              "Nfs": true
            }
          ],
          "Profile": "string",
          "Mapping": [
            {
              "Host": "string",
              "LunId": 0
            }
          ],
          "Naa": "string",
          "StatsInfo": {
            "UserDataAllocatedSizeInBytes": 0.1,
            "UserDataConsumedSizeInBytes": 0.1,
            "UpperTierAllocatedSizeInBytes": 0.1,
            "UpperTierConsumedSizeInBytes": 0.1,
            "RetentionAllocatedSizeInBytes": 0.1,
            "RetentionConsumedSizeInBytes": 0.1,
            "VRAIDAllocatedSizeInBytes": 0.1,
            "VRAIDConsumedSizeInBytes": 0.1,
            "Iops": 0.1,
            "LatencyInMilliseconds": 0.1,
            "IoSizeInBytes": 0.1,
            "ThroughputInBytes": 0.1
          },
          "FileSystemInformation": {
            "MountState": "Mounted",
            "ReplicationMetadata": "None",
            "Profile": "string",
            "FilesystemState": "string",
            "InodeCount": "string",
            "FreeInodes": "string",
            "BlockSize": "string",
            "BlockCount": "string",
            "FreeBlocks": "string",
            "FilesystemCreated": "string",
            "LastMountTime": "string",
            "LastWriteTime": "string",
            "MountCount": "string",
            "LastChecked": "string",
            "LifeTimeWrites": "string"
          },
          "Object": {
            "Application": "string",
            "Volume": "string",
            "IP": "string",
            "FloatingIp": "string",
            "Port": 0,
            "EnableSsl": true,
            "AccessKeys": [
              "string"
            ],
            "ObjectProvider": "Minio"
          },
          "ConnectivityType": "None",
          "Replication": {
            "IpAddress": "string",
            "Port": 0,
            "Role": "Unknown",
            "InternalRole": "Unknown",
            "LocalDataStatus": "NotAvailable",
            "ReplicationPairs": [
              {
                "SyncInPercentage": 0.1,
                "ReplicationId": 0,
                "RemoteSystemName": "string",
                "RemoteSystemId": 0,
                "RemoteSystemRole": "Unknown",
                "IpAddress": "string",
                "Port": 0,
                "RemoteAppName": "string",
                "RemoteVolName": "string",
                "ReplicationProtocol": "None",
                "ConnectionStatus": "Initializing",
                "RemoteDataStatus": "NotAvailable",
                "RemoteDiskStatus": "Unknown"
              }
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "DataDegradationHistogram": [
            0
          ],
          "MetadataDegradationHistogram": [
            0
          ],
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string",
          "DisableSpaceReclamation": true,
          "EncryptionKey": "string",
          "SaveEncryptedRecoveryKey": true,
          "Encrypted": true,
          "Uptime": "string",
          "ReadOnly": true,
          "Force": true
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "ParentConsistencyGroupId": 0,
          "ParentSnapshotId": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "IsVssBasedSnapshotScheduler": true,
          "VssInitiators": [
            "string"
          ],
          "IsDirectVssMapping": true,
          "IsAvailable": true,
          "WorkerProcess": 0,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "VolumeEntityId": 0,
              "Id": 0,
              "MetadataVolumeEntityId": 0,
              "IsInternalVolume": true,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "IsRoot": true,
              "State": "Ok",
              "Vms": [
                "string"
              ],
              "Shares": [
                {
                  "Application": "string",
                  "Volume": "string",
                  "Share": "string",
                  "Path": "string",
                  "Browsable": true,
                  "RecycleBin": true,
                  "ReadonlyAccess": true,
                  "AllowedSubnets": [
                    "string"
                  ],
                  "Smb": true,
                  "Nfs": true
                }
              ],
              "Profile": "string",
              "Mapping": [
                {
                  "Host": "string",
                  "LunId": 0
                }
              ],
              "Naa": "string",
              "StatsInfo": {
                "UserDataAllocatedSizeInBytes": 0.1,
                "UserDataConsumedSizeInBytes": 0.1,
                "UpperTierAllocatedSizeInBytes": 0.1,
                "UpperTierConsumedSizeInBytes": 0.1,
                "RetentionAllocatedSizeInBytes": 0.1,
                "RetentionConsumedSizeInBytes": 0.1,
                "VRAIDAllocatedSizeInBytes": 0.1,
                "VRAIDConsumedSizeInBytes": 0.1,
                "Iops": 0.1,
                "LatencyInMilliseconds": 0.1,
                "IoSizeInBytes": 0.1,
                "ThroughputInBytes": 0.1
              },
              "FileSystemInformation": {
                "MountState": "Mounted",
                "ReplicationMetadata": "None",
                "Profile": "string",
                "FilesystemState": "string",
                "InodeCount": "string",
                "FreeInodes": "string",
                "BlockSize": "string",
                "BlockCount": "string",
                "FreeBlocks": "string",
                "FilesystemCreated": "string",
                "LastMountTime": "string",
                "LastWriteTime": "string",
                "MountCount": "string",
                "LastChecked": "string",
                "LifeTimeWrites": "string"
              },
              "Object": {
                "Application": "string",
                "Volume": "string",
                "IP": "string",
                "FloatingIp": "string",
                "Port": 0,
                "EnableSsl": true,
                "AccessKeys": [
                  "string"
                ],
                "ObjectProvider": "Minio"
              },
              "ConnectivityType": "None",
              "Replication": {
                "IpAddress": "string",
                "Port": 0,
                "Role": "Unknown",
                "InternalRole": "Unknown",
                "LocalDataStatus": "NotAvailable",
                "ReplicationPairs": [
                  {
                    "SyncInPercentage": 0.1,
                    "ReplicationId": 0,
                    "RemoteSystemName": "string",
                    "RemoteSystemId": 0,
                    "RemoteSystemRole": "Unknown",
                    "IpAddress": "string",
                    "Port": 0,
                    "RemoteAppName": "string",
                    "RemoteVolName": "string",
                    "ReplicationProtocol": "None",
                    "ConnectionStatus": "Initializing",
                    "RemoteDataStatus": "NotAvailable",
                    "RemoteDiskStatus": "Unknown"
                  }
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "DataDegradationHistogram": [
                0
              ],
              "MetadataDegradationHistogram": [
                0
              ],
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string",
              "DisableSpaceReclamation": true,
              "EncryptionKey": "string",
              "SaveEncryptedRecoveryKey": true,
              "Encrypted": true,
              "Uptime": "string",
              "ReadOnly": true,
              "Force": true
            }
          ],
          "Snapshots": [
            {
              "Id": 0,
              "Date": "2019-08-24T14:15:22Z",
              "Owner": "None"
            }
          ]
        }
      ],
      "Vms": [
        {
          "Name": "string",
          "VolumeName": "string"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[ApplicationElement]¦null	false	none	[List application instances.]

ApplicationElementCreate

{
  "Application": "string",
  "Template": "string",
  "Description": "string"
}

Create an application instance.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the template.
Template	string¦null	false	none	Create the application from a predefined template.
Description	string¦null	false	none	Application description.

ApplicationElementEdit

{
  "Application": "string",
  "Description": "string"
}

Edit an application instance.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	New name for the application.
Description	string¦null	false	none	New description for the application.

ApplicationsEncryptionSupplyEncryptionKey

{
  "Cgid": 0,
  "Application": "string",
  "Volume": "string",
  "EncryptionKey": "string"
}

Supply an encryption key to allow an encrypted consistency group to load.

Properties

Name	Type	Required	Restrictions	Description
Cgid	integer(int64)¦null	false	none	The id of the encrypted consistency group to open.
Application	string¦null	false	none	The application which contains the consistency group to open.
Volume	string¦null	false	none	The volume which contains the encrypted consistency group to open.
EncryptionKey	string¦null	false	none	Open the encrypted consistency group using the supplied key.

ApplicationsFilesystemsAdd

{
  "Application": "string",
  "Volumes": [
    "string"
  ],
  "Profile": "string",
  "AddReplicationMetadata": true,
  "Force": true
}

Create a file system on a volume (required for NAS/Object).

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application.
Volumes	[string]¦null	false	none	The name of the volumes you will assign to a NAS server.
Profile	string¦null	false	none	Profile for the volume. choose either Journal or Ordered.
AddReplicationMetadata	boolean¦null	false	none	Add replication metadata to the filesystem assignment. If this is set, starting a replication will not be disruptive.
Force	boolean¦null	false	none	Force Operation.

ApplicationsFilesystemsEdit

{
  "AddReplicationMetadata": true,
  "Force": true
}

Create a file system on a volume (required for NAS/Object).

Properties

Name	Type	Required	Restrictions	Description
AddReplicationMetadata	boolean¦null	false	none	Add replication metadata to the filesystem. If this is set, starting a replication will not be disruptive.
Force	boolean¦null	false	none	Do not ask for an approval.

ApplicationsFilesystemsFstrimRun

{
  "Application": "string",
  "Volume": "string"
}

Run fstrim on a file-system volume.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application.
Volume	string¦null	false	none	The name of the NAS volume.

ApplicationsFilesystemsMount

{
  "Application": "string",
  "Volume": "string"
}

Mount unmounted file-systems.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	Filter by application.
Volume	string¦null	false	none	Filter by volume name.

ApplicationsMappingsAdd

{
  "Application": "string",
  "Hosts": [
    "string"
  ],
  "Volumes": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

Add mapping between a volume and an iSCSi/FC/NVMeOF host.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application.
Hosts	[string]¦null	false	none	The name of the hosts to map the volume to.
Volumes	[string]¦null	false	none	The name of the volumes to map. if not specified, all volumes within the application will be mapped.
LunIds	[string]¦null	false	none	The Lun Id for each volume. Input * to use an available lun id.

ApplicationsObjectsStoresAccessKeysAdd

{
  "Application": "string",
  "Volume": "string",
  "AccessKeys": [
    "string"
  ]
}

Add access keys to an object store.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application that contains the object store.
Volume	string¦null	false	none	The name of the volume that contains the object store.
AccessKeys	[string]¦null	false	none	Access keys to access the object store.

ApplicationsSnapshotsRestore

{
  "Application": "string",
  "Volume": "string",
  "Suffix": "string"
}

Create a new volume from a snapshot.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application.
Volume	string¦null	false	none	The name of the volume.
Suffix	string¦null	false	none	A suffix for the newly created volume.

ApplicationsSnapshotsSchedule

{
  "Frequency": [
    "string"
  ],
  "Retention": [
    "string"
  ],
  "Enable_vss": true,
  "Force": true
}

Schedule snapshots.

Properties

Name	Type	Required	Restrictions	Description
Frequency	[string]¦null	false	none	Recovery point objective. This configures the frequency of the snapshots.
Retention	[string]¦null	false	none	The retention of a specific frequency.
Enable_vss	boolean¦null	false	none	Utilize VSS On this scheduler.
Force	boolean¦null	false	none	Force operation.

ApplicationsSnapshotsTake

{
  "All": true,
  "Application": "string",
  "Volume": "string",
  "Cgid": 0,
  "Vss": true,
  "Count": 0
}

Take a manual snapshot.

Properties

Name	Type	Required	Restrictions	Description
All	boolean¦null	false	none	Take a snapshot on all volumes within the system.
Application	string¦null	false	none	The name of the application.
Volume	string¦null	false	none	The name of the volume that the snapshots will be created for (it will be taken for the entire consistency group).
Cgid	integer(int64)¦null	false	none	The id of the consistency groups to take snapshots on.
Vss	boolean¦null	false	none	Take a VSS snapshot.
Count	integer(int64)¦null	false	none	Take multiply snapshots. this available for testing purposes only.

ApplicationsSnapshotsVss

{
  "VssInitiators": [
    "string"
  ],
  "DirectMapping": true,
  "Force": true
}

Configure VSS settings for volumes.

Properties

Name	Type	Required	Restrictions	Description
VssInitiators	[string]¦null	false	none	VSS initiators to utilize when taking snapshots on this volume/consistency group.
DirectMapping	boolean¦null	false	none	Select this if the volumes are directly connected to the initiator.
Force	boolean¦null	false	none	Force Operation.

AuthenticateElement

{
  "Username": "string",
  "Password": "string",
  "TwoFactorAuthenticationToken": "string",
  "EmailVerficationUpdatedEmailAddress": "string",
  "EmailVerificationToken": "string",
  "InactivityTimeoutInMinutes": 0
}

Properties

Name	Type	Required	Restrictions	Description
Username	string¦null	false	none	none
Password	string¦null	false	none	none
TwoFactorAuthenticationToken	string¦null	false	none	none
EmailVerficationUpdatedEmailAddress	string¦null	false	none	none
EmailVerificationToken	string¦null	false	none	none
InactivityTimeoutInMinutes	integer(int32)	false	none	none

AuthenticationResult

{
  "SessionToken": "string",
  "UserEmailAddress": "string",
  "Status": "Ok",
  "Details": "string"
}

Properties

Name	Type	Required	Restrictions	Description
SessionToken	string¦null	false	none	none
UserEmailAddress	string¦null	false	none	none
Status	Status	false	none	none
Details	string¦null	false	none	none

BasicCapacityElement

{
  "CapacityInBytes": 0.1,
  "CapacityUsageInBytes": 0.1,
  "ProvisioningStates": [
    "Ok"
  ],
  "PoolCapacity": [
    {
      "PoolName": "string",
      "CapacityInBytes": 0.1,
      "CapacityUsageInBytes": 0.1
    }
  ],
  "PoolCapacityVirtualRaidProvisioning": [
    {
      "Name": "string",
      "FreeSpaceInPercentage": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
CapacityInBytes	number(double)¦null	false	none	none
CapacityUsageInBytes	number(double)¦null	false	none	none
ProvisioningStates	[ThinProvisioningState]¦null	false	none	none
PoolCapacity	[PoolCapacity]¦null	false	none	none
PoolCapacityVirtualRaidProvisioning	[VraidProvisioning]¦null	false	none	none

BasicDriveElement

{
  "Name": "string",
  "Id": 0,
  "Type": "HDD",
  "CapacityInBytes": 0,
  "ApprovedState": "Approved",
  "ResourceSerial": "string",
  "ResourceStatus": "OK",
  "ErrMsg": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Type	DriveType	false	none	none
CapacityInBytes	integer(int64)¦null	false	none	none
ApprovedState	UsageState	false	none	none
ResourceSerial	string¦null	false	none	none
ResourceStatus	ResourceStatus	false	none	none
ErrMsg	string¦null	false	none	none

BasicNodeElement

{
  "Name": "string",
  "Id": 0,
  "Time": "2019-08-24T14:15:22Z",
  "State": "Running",
  "HAState": "Unknown",
  "CurrentManagementConnection": true
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Time	string(date-time)¦null	false	none	none
State	NodeStatus	false	none	none
HAState	HighAvailabilityState	false	none	none
CurrentManagementConnection	boolean¦null	false	none	none

BasicVolumeElement

{
  "Id": 0,
  "Application": "string",
  "Volume": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int64)¦null	false	none	none
Application	string¦null	false	none	Limit results by the application instance name.
Volume	string¦null	false	none	Limit results by the volume name.

CPUElement

{
  "Name": "string",
  "Id": 0,
  "Vendor": "string",
  "Brand": "string",
  "Model": "string",
  "Family": "string",
  "Stepping": "string",
  "CoreCount": "string",
  "LogicalCoresCount": "string",
  "ProcessorID": "string",
  "Sensors": [
    {
      "Name": "string",
      "Type": "Temperture",
      "Reading": "string",
      "EventMessage": "string",
      "Status": "OK",
      "State": "string",
      "LastReadingTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "ResourceSerial": "string",
  "ResourceStatus": "OK",
  "ErrMsg": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Vendor	string¦null	false	none	none
Brand	string¦null	false	none	none
Model	string¦null	false	none	none
Family	string¦null	false	none	none
Stepping	string¦null	false	none	none
CoreCount	string¦null	false	none	none
LogicalCoresCount	string¦null	false	none	none
ProcessorID	string¦null	false	none	none
Sensors	[SensorsElement]¦null	false	none	none
ResourceSerial	string¦null	false	none	none
ResourceStatus	ResourceStatus	false	none	none
ErrMsg	string¦null	false	none	none

CapacityHistoryElement

{
  "PoolName": "string",
  "Time": "2019-08-24T14:15:22Z",
  "TotalAllocatedSizeInBytes": 0.1,
  "TotalConsumedSizeInBytes": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
PoolName	string¦null	false	none	none
Time	string(date-time)	false	none	none
TotalAllocatedSizeInBytes	number(double)¦null	false	none	none
TotalConsumedSizeInBytes	number(double)¦null	false	none	none

CapacityUsageElement

{
  "PoolId": 0,
  "Name": "string",
  "RawSizeInBytes": 0.1,
  "TotalAllocatedSizeInBytes": 0.1,
  "TotalConsumedSizeInBytes": 0.1,
  "UserDataAllocatedSizeInBytes": 0.1,
  "UserDataConsumedSizeInBytes": 0.1,
  "UpperTierAllocatedSizeInBytes": 0.1,
  "UpperTierConsumedSizeInBytes": 0.1,
  "RetentionAllocatedSizeInBytes": 0.1,
  "RetentionConsumedSizeInBytes": 0.1,
  "VRAIDAllocationSizeInBytes": 0.1,
  "VRAIDConsumedSizeInBytes": 0.1,
  "MetadataSizeInBytes": 0.1,
  "ReserveSizeInBytes": 0.1,
  "OverAllocationSizeInBytes": 0.1,
  "FreeCapacityInBytes": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
PoolId	integer(int64)¦null	false	none	none
Name	string¦null	false	none	none
RawSizeInBytes	number(double)¦null	false	none	none
TotalAllocatedSizeInBytes	number(double)¦null	false	none	none
TotalConsumedSizeInBytes	number(double)¦null	false	none	none
UserDataAllocatedSizeInBytes	number(double)¦null	false	none	none
UserDataConsumedSizeInBytes	number(double)¦null	false	none	none
UpperTierAllocatedSizeInBytes	number(double)¦null	false	none	none
UpperTierConsumedSizeInBytes	number(double)¦null	false	none	none
RetentionAllocatedSizeInBytes	number(double)¦null	false	none	none
RetentionConsumedSizeInBytes	number(double)¦null	false	none	none
VRAIDAllocationSizeInBytes	number(double)¦null	false	none	none
VRAIDConsumedSizeInBytes	number(double)¦null	false	none	none
MetadataSizeInBytes	number(double)¦null	false	none	none
ReserveSizeInBytes	number(double)¦null	false	none	none
OverAllocationSizeInBytes	number(double)¦null	false	none	none
FreeCapacityInBytes	number(double)¦null	false	none	none

ChartFile

{
  "EntityIdentifier": "string",
  "ChartMeasure": "string",
  "Path": "string"
}

Properties

Name	Type	Required	Restrictions	Description
EntityIdentifier	string¦null	false	none	none
ChartMeasure	string¦null	false	none	none
Path	string¦null	false	none	none

ChassisElement

{
  "Name": "string",
  "Id": 0,
  "Sensors": [
    {
      "Name": "string",
      "Type": "Temperture",
      "Reading": "string",
      "EventMessage": "string",
      "Status": "OK",
      "State": "string",
      "LastReadingTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "ProductVendor": "string",
  "ProductName": "string",
  "ProductVersion": "string",
  "ProductSerial": "string",
  "ProductUUID": "string",
  "BoardVendor": "string",
  "BoardName": "string",
  "BoardVersion": "string",
  "BoardSerial": "string",
  "BiosVendor": "string",
  "BiosVersion": "string",
  "ChassisType": "string",
  "ChassisSerial": "string",
  "ChassisVendor": "string",
  "ServerVendor": "string",
  "IsVirtualMachine": true,
  "ResourceSerial": "string",
  "ResourceStatus": "OK",
  "ErrMsg": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Sensors	[SensorsElement]¦null	false	none	none
ProductVendor	string¦null	false	none	none
ProductName	string¦null	false	none	none
ProductVersion	string¦null	false	none	none
ProductSerial	string¦null	false	none	none
ProductUUID	string¦null	false	none	none
BoardVendor	string¦null	false	none	none
BoardName	string¦null	false	none	none
BoardVersion	string¦null	false	none	none
BoardSerial	string¦null	false	none	none
BiosVendor	string¦null	false	none	none
BiosVersion	string¦null	false	none	none
ChassisType	string¦null	false	none	none
ChassisSerial	string¦null	false	none	none
ChassisVendor	string¦null	false	none	none
ServerVendor	string¦null	false	none	none
IsVirtualMachine	boolean¦null	false	none	none
ResourceSerial	string¦null	false	none	none
ResourceStatus	ResourceStatus	false	none	none
ErrMsg	string¦null	false	none	none

ComponentVersion

{
  "Component": "string",
  "Version": "string",
  "BuildNumber": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Component	string¦null	false	none	none
Version	string¦null	false	none	none
BuildNumber	string¦null	false	none	none

ConfigType

"UnversionedConfig"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	UnversionedConfig
anonymous	VersionedConfig

ConfigurationElement

{
  "Id": 0,
  "System": "string",
  "PlatformVersion": 0,
  "ServiceConfigId": 0,
  "State": "Unknown",
  "Type": "UnversionedConfig",
  "Description": "string",
  "StartTime": "2019-08-24T14:15:22Z",
  "EndTime": "2019-08-24T14:15:22Z",
  "ErrorMessage": "string",
  "Async": true
}

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int64)¦null	false	none	none
System	string¦null	false	none	none
PlatformVersion	integer(int64)¦null	false	none	none
ServiceConfigId	integer(int64)¦null	false	none	none
State	ConfigurationState	false	none	none
Type	ConfigType	false	none	none
Description	string¦null	false	none	none
StartTime	string(date-time)¦null	false	none	none
EndTime	string(date-time)¦null	false	none	none
ErrorMessage	string¦null	false	none	none
Async	boolean¦null	false	none	none

ConfigurationElementApiResult

{
  "Data": [
    {
      "Id": 0,
      "System": "string",
      "PlatformVersion": 0,
      "ServiceConfigId": 0,
      "State": "Unknown",
      "Type": "UnversionedConfig",
      "Description": "string",
      "StartTime": "2019-08-24T14:15:22Z",
      "EndTime": "2019-08-24T14:15:22Z",
      "ErrorMessage": "string",
      "Async": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[ConfigurationElement]¦null	false	none	none

ConfigurationState

"Unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	Running
anonymous	Pending
anonymous	Failed
anonymous	Success

ConnectivityType

"Relay"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Relay
anonymous	Direct
anonymous	Disconnected

ConsistencyGroupElement

{
  "Id": 0,
  "ParentConsistencyGroupId": 0,
  "ParentSnapshotId": 0,
  "SnapshotScheduler": [
    "string"
  ],
  "IsVssBasedSnapshotScheduler": true,
  "VssInitiators": [
    "string"
  ],
  "IsDirectVssMapping": true,
  "IsAvailable": true,
  "WorkerProcess": 0,
  "Volumes": [
    {
      "Application": "string",
      "Volume": "string",
      "VolumeEntityId": 0,
      "Id": 0,
      "MetadataVolumeEntityId": 0,
      "IsInternalVolume": true,
      "CapacityInBytes": 0,
      "SnapshotCapacityInBytes": 0,
      "Tiers": {
        "TierEntityIds": [
          0
        ],
        "TierPools": [
          "string"
        ],
        "TierN": [
          0
        ],
        "TierK": [
          0
        ],
        "TierSizesInBytes": [
          0
        ],
        "EvacuationThresholdsInPercentage": [
          0.1
        ],
        "LowerThresholdsInPercentage": [
          0.1
        ],
        "TierDataDegradationHistogram": [
          [
            0
          ]
        ],
        "TierMetadataDegradationHistogram": [
          [
            0
          ]
        ]
      },
      "IsRoot": true,
      "State": "Ok",
      "Vms": [
        "string"
      ],
      "Shares": [
        {
          "Application": "string",
          "Volume": "string",
          "Share": "string",
          "Path": "string",
          "Browsable": true,
          "RecycleBin": true,
          "ReadonlyAccess": true,
          "AllowedSubnets": [
            "string"
          ],
          "Smb": true,
          "Nfs": true
        }
      ],
      "Profile": "string",
      "Mapping": [
        {
          "Host": "string",
          "LunId": 0
        }
      ],
      "Naa": "string",
      "StatsInfo": {
        "UserDataAllocatedSizeInBytes": 0.1,
        "UserDataConsumedSizeInBytes": 0.1,
        "UpperTierAllocatedSizeInBytes": 0.1,
        "UpperTierConsumedSizeInBytes": 0.1,
        "RetentionAllocatedSizeInBytes": 0.1,
        "RetentionConsumedSizeInBytes": 0.1,
        "VRAIDAllocatedSizeInBytes": 0.1,
        "VRAIDConsumedSizeInBytes": 0.1,
        "Iops": 0.1,
        "LatencyInMilliseconds": 0.1,
        "IoSizeInBytes": 0.1,
        "ThroughputInBytes": 0.1
      },
      "FileSystemInformation": {
        "MountState": "Mounted",
        "ReplicationMetadata": "None",
        "Profile": "string",
        "FilesystemState": "string",
        "InodeCount": "string",
        "FreeInodes": "string",
        "BlockSize": "string",
        "BlockCount": "string",
        "FreeBlocks": "string",
        "FilesystemCreated": "string",
        "LastMountTime": "string",
        "LastWriteTime": "string",
        "MountCount": "string",
        "LastChecked": "string",
        "LifeTimeWrites": "string"
      },
      "Object": {
        "Application": "string",
        "Volume": "string",
        "IP": "string",
        "FloatingIp": "string",
        "Port": 0,
        "EnableSsl": true,
        "AccessKeys": [
          "string"
        ],
        "ObjectProvider": "Minio"
      },
      "ConnectivityType": "None",
      "Replication": {
        "IpAddress": "string",
        "Port": 0,
        "Role": "Unknown",
        "InternalRole": "Unknown",
        "LocalDataStatus": "NotAvailable",
        "ReplicationPairs": [
          {
            "SyncInPercentage": 0.1,
            "ReplicationId": 0,
            "RemoteSystemName": "string",
            "RemoteSystemId": 0,
            "RemoteSystemRole": "Unknown",
            "IpAddress": "string",
            "Port": 0,
            "RemoteAppName": "string",
            "RemoteVolName": "string",
            "ReplicationProtocol": "None",
            "ConnectionStatus": "Initializing",
            "RemoteDataStatus": "NotAvailable",
            "RemoteDiskStatus": "Unknown"
          }
        ]
      },
      "Pool": "string",
      "StripedPools": [
        "string"
      ],
      "Log2StrideSectors": 0,
      "DataDegradationHistogram": [
        0
      ],
      "MetadataDegradationHistogram": [
        0
      ],
      "MetadataPool": "string",
      "StripedMetadataPools": [
        "string"
      ],
      "N": 0,
      "K": 0,
      "MetadataN": 0,
      "MetadataK": 0,
      "SectorSize": "string",
      "Cgid": 0,
      "GroupedVolume": "string",
      "DisableSpaceReclamation": true,
      "EncryptionKey": "string",
      "SaveEncryptedRecoveryKey": true,
      "Encrypted": true,
      "Uptime": "string",
      "ReadOnly": true,
      "Force": true
    }
  ],
  "Snapshots": [
    {
      "Id": 0,
      "Date": "2019-08-24T14:15:22Z",
      "Owner": "None"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int64)	false	none	none
ParentConsistencyGroupId	integer(int64)¦null	false	none	none
ParentSnapshotId	integer(int64)¦null	false	none	none
SnapshotScheduler	[string]¦null	false	none	none
IsVssBasedSnapshotScheduler	boolean¦null	false	none	none
VssInitiators	[string]¦null	false	none	none
IsDirectVssMapping	boolean¦null	false	none	none
IsAvailable	boolean	false	none	none
WorkerProcess	integer(int64)¦null	false	none	none
Volumes	[VolumeElement]¦null	false	none	[List volumes.]
Snapshots	[SnapshotElement]¦null	false	none	none

ConsistencyGroupTemplateElement

{
  "Id": 0,
  "SnapshotScheduler": [
    "string"
  ],
  "VolumeShadowCopySupport": true,
  "Volumes": [
    {
      "Application": "string",
      "Volume": "string",
      "Id": 0,
      "CapacityInBytes": 0,
      "SnapshotCapacityInBytes": 0,
      "Tiers": {
        "TierEntityIds": [
          0
        ],
        "TierPools": [
          "string"
        ],
        "TierN": [
          0
        ],
        "TierK": [
          0
        ],
        "TierSizesInBytes": [
          0
        ],
        "EvacuationThresholdsInPercentage": [
          0.1
        ],
        "LowerThresholdsInPercentage": [
          0.1
        ],
        "TierDataDegradationHistogram": [
          [
            0
          ]
        ],
        "TierMetadataDegradationHistogram": [
          [
            0
          ]
        ]
      },
      "Pool": "string",
      "StripedPools": [
        "string"
      ],
      "Log2StrideSectors": 0,
      "MetadataPool": "string",
      "StripedMetadataPools": [
        "string"
      ],
      "N": 0,
      "K": 0,
      "MetadataN": 0,
      "MetadataK": 0,
      "SectorSize": "string",
      "Cgid": 0,
      "GroupedVolume": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int64)	false	none	none
SnapshotScheduler	[string]¦null	false	none	none
VolumeShadowCopySupport	boolean	false	none	none
Volumes	[VolumeTemplateElement]¦null	false	none	none

DatastoreElement

{
  "Name": "string",
  "Type": "string",
  "Volume": [
    "string"
  ],
  "Details": [
    "string"
  ],
  "EsxiHosts": [
    "string"
  ],
  "Vms": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Type	string¦null	false	none	none
Volume	[string]¦null	false	none	none
Details	[string]¦null	false	none	none
EsxiHosts	[string]¦null	false	none	none
Vms	[string]¦null	false	none	none

DetailedSnapshotElement

{
  "Id": 0,
  "ConsistencyGroupId": 0,
  "Volumes": [
    {
      "Id": 0,
      "Application": "string",
      "Volume": "string"
    }
  ],
  "Date": "2019-08-24T14:15:22Z",
  "Owner": "None"
}

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int64)	false	none	none
ConsistencyGroupId	integer(int64)	false	none	none
Volumes	[BasicVolumeElement]¦null	false	none	none
Date	string(date-time)	false	none	none
Owner	SnapshotOwner	false	none	none

DetailedSnapshotElementApiResult

{
  "Data": [
    {
      "Id": 0,
      "ConsistencyGroupId": 0,
      "Volumes": [
        {
          "Id": 0,
          "Application": "string",
          "Volume": "string"
        }
      ],
      "Date": "2019-08-24T14:15:22Z",
      "Owner": "None"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[DetailedSnapshotElement]¦null	false	none	none

DiskPoolType

"UserDefined"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	UserDefined
anonymous	HDD
anonymous	SSD
anonymous	All
anonymous	NVMe

DriveElement

{
  "Name": "string",
  "Id": 0,
  "Device": "string",
  "UsedCapacityInBytes": 0,
  "ManualPool": "string",
  "DeviceName": "string",
  "PhysicalSector": "string",
  "LogicalSector": "string",
  "Vendor": "string",
  "Model": "string",
  "RotationRate": "string",
  "EnclosureIndex": "string",
  "OSName": "string",
  "Version": "string",
  "SelfEncryptingDrive": "NotSupported",
  "Sensors": [
    {
      "Name": "string",
      "Type": "Temperture",
      "Reading": "string",
      "EventMessage": "string",
      "Status": "OK",
      "State": "string",
      "LastReadingTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "LedState": "string",
  "Type": "HDD",
  "CapacityInBytes": 0,
  "ApprovedState": "Approved",
  "ResourceSerial": "string",
  "ResourceStatus": "OK",
  "ErrMsg": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Device	string¦null	false	none	none
UsedCapacityInBytes	integer(int64)¦null	false	none	none
ManualPool	string¦null	false	none	none
DeviceName	string¦null	false	none	none
PhysicalSector	string¦null	false	none	none
LogicalSector	string¦null	false	none	none
Vendor	string¦null	false	none	none
Model	string¦null	false	none	none
RotationRate	string¦null	false	none	none
EnclosureIndex	string¦null	false	none	none
OSName	string¦null	false	none	none
Version	string¦null	false	none	none
SelfEncryptingDrive	SelfEncryptingDriveSupport	false	none	none
Sensors	[SensorsElement]¦null	false	none	none
LedState	string¦null	false	none	none
Type	DriveType	false	none	none
CapacityInBytes	integer(int64)¦null	false	none	none
ApprovedState	UsageState	false	none	none
ResourceSerial	string¦null	false	none	none
ResourceStatus	ResourceStatus	false	none	none
ErrMsg	string¦null	false	none	none

DriveElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Device": "string",
      "UsedCapacityInBytes": 0,
      "ManualPool": "string",
      "DeviceName": "string",
      "PhysicalSector": "string",
      "LogicalSector": "string",
      "Vendor": "string",
      "Model": "string",
      "RotationRate": "string",
      "EnclosureIndex": "string",
      "OSName": "string",
      "Version": "string",
      "SelfEncryptingDrive": "NotSupported",
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "LedState": "string",
      "Type": "HDD",
      "CapacityInBytes": 0,
      "ApprovedState": "Approved",
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[DriveElement]¦null	false	none	none

DrivePoolElement

{
  "Name": "string",
  "TotalCapacityInBytes": 0.1,
  "UsedCapacityInBytes": 0.1,
  "Type": "UserDefined",
  "ManualPoolType": "Normal",
  "DriveCount": 0,
  "VolumesCount": 0,
  "Drives": [
    {
      "Name": "string",
      "Id": 0,
      "Type": "HDD",
      "CapacityInBytes": 0,
      "ApprovedState": "Approved",
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ],
  "Volumes": [
    {
      "Id": 0,
      "Application": "string",
      "Volume": "string"
    }
  ],
  "IsHdd": true,
  "IsSsd": true,
  "MaxSectorsKb": 0
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
TotalCapacityInBytes	number(double)¦null	false	none	none
UsedCapacityInBytes	number(double)¦null	false	none	none
Type	DiskPoolType	false	none	none
ManualPoolType	ManualPoolTypes	false	none	none
DriveCount	integer(int32)¦null	false	read-only	none
VolumesCount	integer(int32)¦null	false	read-only	none
Drives	[BasicDriveElement]¦null	false	none	none
Volumes	[BasicVolumeElement]¦null	false	none	none
IsHdd	boolean¦null	false	none	none
IsSsd	boolean¦null	false	none	none
MaxSectorsKb	integer(int32)¦null	false	none	none

DrivePoolElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "TotalCapacityInBytes": 0.1,
      "UsedCapacityInBytes": 0.1,
      "Type": "UserDefined",
      "ManualPoolType": "Normal",
      "DriveCount": 0,
      "VolumesCount": 0,
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Volumes": [
        {
          "Id": 0,
          "Application": "string",
          "Volume": "string"
        }
      ],
      "IsHdd": true,
      "IsSsd": true,
      "MaxSectorsKb": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[DrivePoolElement]¦null	false	none	none

DriveType

"HDD"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	HDD
anonymous	SSD
anonymous	NVME

EntityHistoryPerformanceStatsElement

{
  "Time": "2019-08-24T14:15:22Z",
  "EntityName": "string",
  "Iops": 0.1,
  "ReadIops": 0.1,
  "WriteIops": 0.1,
  "LatencyInMilliseconds": 0.1,
  "ReadLatencyInMilliseconds": 0.1,
  "WriteLatencyInMilliseconds": 0.1,
  "IoSizeInBytes": 0.1,
  "ReadIoSizeInBytes": 0.1,
  "WriteIoSizeInBytes": 0.1,
  "ThroughputInBytes": 0.1,
  "ReadThroughputInBytes": 0.1,
  "WriteThroughputInBytes": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
Time	string(date-time)	false	none	none
EntityName	string¦null	false	none	none
Iops	number(double)¦null	false	none	none
ReadIops	number(double)¦null	false	none	none
WriteIops	number(double)¦null	false	none	none
LatencyInMilliseconds	number(double)¦null	false	none	none
ReadLatencyInMilliseconds	number(double)¦null	false	none	none
WriteLatencyInMilliseconds	number(double)¦null	false	none	none
IoSizeInBytes	number(double)¦null	false	none	none
ReadIoSizeInBytes	number(double)¦null	false	none	none
WriteIoSizeInBytes	number(double)¦null	false	none	none
ThroughputInBytes	number(double)¦null	false	none	none
ReadThroughputInBytes	number(double)¦null	false	none	none
WriteThroughputInBytes	number(double)¦null	false	none	none

EntityPerformanceStatsElement

{
  "Time": "string",
  "Name": "string",
  "ReadIops": 0.1,
  "WriteIops": 0.1,
  "ReadLatencyInMilliseconds": 0.1,
  "WriteLatencyInMilliseconds": 0.1,
  "ReadIoSizeInBytes": 0.1,
  "WriteIoSizeInBytes": 0.1,
  "ReadThroughputInBytes": 0.1,
  "WriteThroughputInBytes": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
Time	string¦null	false	none	none
Name	string¦null	false	none	none
ReadIops	number(double)¦null	false	none	none
WriteIops	number(double)¦null	false	none	none
ReadLatencyInMilliseconds	number(double)¦null	false	none	none
WriteLatencyInMilliseconds	number(double)¦null	false	none	none
ReadIoSizeInBytes	number(double)¦null	false	none	none
WriteIoSizeInBytes	number(double)¦null	false	none	none
ReadThroughputInBytes	number(double)¦null	false	none	none
WriteThroughputInBytes	number(double)¦null	false	none	none

EntityPerformanceStatsElementApiResult

{
  "Data": [
    {
      "Time": "string",
      "Name": "string",
      "ReadIops": 0.1,
      "WriteIops": 0.1,
      "ReadLatencyInMilliseconds": 0.1,
      "WriteLatencyInMilliseconds": 0.1,
      "ReadIoSizeInBytes": 0.1,
      "WriteIoSizeInBytes": 0.1,
      "ReadThroughputInBytes": 0.1,
      "WriteThroughputInBytes": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[EntityPerformanceStatsElement]¦null	false	none	none

FileSystemInfoElement

{
  "MountState": "Mounted",
  "ReplicationMetadata": "None",
  "Profile": "string",
  "FilesystemState": "string",
  "InodeCount": "string",
  "FreeInodes": "string",
  "BlockSize": "string",
  "BlockCount": "string",
  "FreeBlocks": "string",
  "FilesystemCreated": "string",
  "LastMountTime": "string",
  "LastWriteTime": "string",
  "MountCount": "string",
  "LastChecked": "string",
  "LifeTimeWrites": "string"
}

Properties

Name	Type	Required	Restrictions	Description
MountState	VolumeMountState	false	none	none
ReplicationMetadata	ReplicationMetadata	false	none	none
Profile	string¦null	false	none	none
FilesystemState	string¦null	false	none	none
InodeCount	string¦null	false	none	none
FreeInodes	string¦null	false	none	none
BlockSize	string¦null	false	none	none
BlockCount	string¦null	false	none	none
FreeBlocks	string¦null	false	none	none
FilesystemCreated	string¦null	false	none	none
LastMountTime	string¦null	false	none	none
LastWriteTime	string¦null	false	none	none
MountCount	string¦null	false	none	none
LastChecked	string¦null	false	none	none
LifeTimeWrites	string¦null	false	none	none

FloatingIpElement

{
  "Name": "string",
  "Address": "string",
  "Mask": "string",
  "Gateway": "string",
  "OwnerNode": "string",
  "Nodes": [
    "string"
  ],
  "Interfaces": [
    "string"
  ],
  "NodeInterfaces": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ],
  "PairedFloatingIps": [
    {
      "Name": "string",
      "RemoteSystemId": 0,
      "RemoteSystemName": "string",
      "Address": "string"
    }
  ]
}

List all floating ips.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Filter floating ips by name.
Address	string¦null	false	none	none
Mask	string¦null	false	none	none
Gateway	string¦null	false	none	none
OwnerNode	string¦null	false	none	none
Nodes	[string]¦null	false	none	none
Interfaces	[string]¦null	false	none	none
NodeInterfaces	[NodeElement]¦null	false	none	none
PairedFloatingIps	[PairedFloatingIpElement]¦null	false	none	none

FloatingIpElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "Address": "string",
      "Mask": "string",
      "Gateway": "string",
      "OwnerNode": "string",
      "Nodes": [
        "string"
      ],
      "Interfaces": [
        "string"
      ],
      "NodeInterfaces": [
        {
          "Name": "string",
          "Id": 0,
          "Time": "2019-08-24T14:15:22Z",
          "State": "Running",
          "HAState": "Unknown",
          "CurrentManagementConnection": true,
          "Vols": 0,
          "Iqn": "string",
          "IsSEDPasswordSupplied": true,
          "Wwn": [
            "string"
          ],
          "Volumes": [
            "string"
          ],
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "Services": [
            "string"
          ],
          "Sessions": [
            "string"
          ],
          "SupportTunnelStatus": "string",
          "Drives": [
            {
              "Name": "string",
              "Id": 0,
              "Device": "string",
              "UsedCapacityInBytes": 0,
              "ManualPool": "string",
              "DeviceName": "string",
              "PhysicalSector": "string",
              "LogicalSector": "string",
              "Vendor": "string",
              "Model": "string",
              "RotationRate": "string",
              "EnclosureIndex": "string",
              "OSName": "string",
              "Version": "string",
              "SelfEncryptingDrive": "NotSupported",
              "Sensors": [
                {
                  "Name": "string",
                  "Type": "Temperture",
                  "Reading": "string",
                  "EventMessage": "string",
                  "Status": "OK",
                  "State": "string",
                  "LastReadingTimestamp": "2019-08-24T14:15:22Z"
                }
              ],
              "LedState": "string",
              "Type": "HDD",
              "CapacityInBytes": 0,
              "ApprovedState": "Approved",
              "ResourceSerial": "string",
              "ResourceStatus": "OK",
              "ErrMsg": "string"
            }
          ],
          "CPU": [
            {
              "Name": "string",
              "Id": 0,
              "Vendor": "string",
              "Brand": "string",
              "Model": "string",
              "Family": "string",
              "Stepping": "string",
              "CoreCount": "string",
              "LogicalCoresCount": "string",
              "ProcessorID": "string",
              "Sensors": [
                {
                  "Name": "string",
                  "Type": "Temperture",
                  "Reading": "string",
                  "EventMessage": "string",
                  "Status": "OK",
                  "State": "string",
                  "LastReadingTimestamp": "2019-08-24T14:15:22Z"
                }
              ],
              "ResourceSerial": "string",
              "ResourceStatus": "OK",
              "ErrMsg": "string"
            }
          ],
          "Memory": [
            {
              "Name": "string",
              "Id": 0,
              "Manufacturer": "string",
              "Capacity": "string",
              "MemoryType": "string",
              "Serial": "string",
              "Sensors": [
                {
                  "Name": "string",
                  "Type": "Temperture",
                  "Reading": "string",
                  "EventMessage": "string",
                  "Status": "OK",
                  "State": "string",
                  "LastReadingTimestamp": "2019-08-24T14:15:22Z"
                }
              ],
              "ResourceSerial": "string",
              "ResourceStatus": "OK",
              "ErrMsg": "string"
            }
          ],
          "NetworkInterfaceCards": [
            {
              "Name": "string",
              "Id": 0,
              "Interface": "string",
              "Device": "string",
              "Vendor": "string",
              "Slaves": [
                "string"
              ],
              "Ips": [
                {
                  "Ip": "string",
                  "IscsiEnabled": true,
                  "TcpNvmeofPorts": [
                    "string"
                  ],
                  "RdmaNvmeofPorts": [
                    "string"
                  ],
                  "TcpNvmeofEnabled": true,
                  "RdmaNvmeofEnabled": true
                }
              ],
              "SpeedGbs": 0,
              "Sensors": [
                {
                  "Name": "string",
                  "Type": "Temperture",
                  "Reading": "string",
                  "EventMessage": "string",
                  "Status": "OK",
                  "State": "string",
                  "LastReadingTimestamp": "2019-08-24T14:15:22Z"
                }
              ],
              "ResourceSerial": "string",
              "ResourceStatus": "OK",
              "ErrMsg": "string"
            }
          ],
          "FibreChannelHostBusAdapters": [
            {
              "Name": "string",
              "Id": 0,
              "Model": "string",
              "FirmwareVersion": "string",
              "DriverVersion": "string",
              "LinkState": "string",
              "Sensors": [
                {
                  "Name": "string",
                  "Type": "Temperture",
                  "Reading": "string",
                  "EventMessage": "string",
                  "Status": "OK",
                  "State": "string",
                  "LastReadingTimestamp": "2019-08-24T14:15:22Z"
                }
              ],
              "ResourceSerial": "string",
              "ResourceStatus": "OK",
              "ErrMsg": "string"
            }
          ],
          "Chassis": [
            {
              "Name": "string",
              "Id": 0,
              "Sensors": [
                {
                  "Name": "string",
                  "Type": "Temperture",
                  "Reading": "string",
                  "EventMessage": "string",
                  "Status": "OK",
                  "State": "string",
                  "LastReadingTimestamp": "2019-08-24T14:15:22Z"
                }
              ],
              "ProductVendor": "string",
              "ProductName": "string",
              "ProductVersion": "string",
              "ProductSerial": "string",
              "ProductUUID": "string",
              "BoardVendor": "string",
              "BoardName": "string",
              "BoardVersion": "string",
              "BoardSerial": "string",
              "BiosVendor": "string",
              "BiosVersion": "string",
              "ChassisType": "string",
              "ChassisSerial": "string",
              "ChassisVendor": "string",
              "ServerVendor": "string",
              "IsVirtualMachine": true,
              "ResourceSerial": "string",
              "ResourceStatus": "OK",
              "ErrMsg": "string"
            }
          ],
          "Pings": [
            {
              "PingType": "string",
              "Address": "string",
              "Error": "string",
              "Nics": [
                "string"
              ],
              "IsSuccessful": true
            }
          ],
          "IpAddresses": [
            "string"
          ],
          "TargetChap": {
            "ChapName": "string",
            "ChapSecret": "string"
          },
          "Isns": {
            "IsnsAddress": "string",
            "AccessControl": true
          }
        }
      ],
      "PairedFloatingIps": [
        {
          "Name": "string",
          "RemoteSystemId": 0,
          "RemoteSystemName": "string",
          "Address": "string"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[FloatingIpElement]¦null	false	none	[List all floating ips.]

FloatingIpElementCreate

{
  "Name": "string",
  "Address": "string",
  "Mask": "string",
  "Gateway": "string",
  "Nodes": [
    "string"
  ],
  "Interfaces": [
    "string"
  ]
}

Create a floating ip.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Give the floating ip a name.
Address	string¦null	false	none	The ip address of the floating ip.
Mask	string¦null	false	none	The subnet mask of the floating ip.
Gateway	string¦null	false	none	The gateway of the floating ip.
Nodes	[string]¦null	false	none	The node name to which you will provide the interface name in the next argument.
Interfaces	[string]¦null	false	none	The interface name of the corresponding node id.

FloatingIpElementEdit

{
  "Name": "string",
  "Address": "string",
  "Mask": "string",
  "Gateway": "string",
  "Nodes": [
    "string"
  ],
  "Interfaces": [
    "string"
  ]
}

Edit a floating ip.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	New name for the floating ip.
Address	string¦null	false	none	New ip address for floating ip.
Mask	string¦null	false	none	New subnet mask for the floating ip.
Gateway	string¦null	false	none	New gateway for the floating ip.
Nodes	[string]¦null	false	none	The node name to which you will provide the interface name in the next argument.
Interfaces	[string]¦null	false	none	The interface name of the corresponding node id.

FloatingipsPair

{
  "Name": "string",
  "TargetSystem": "string",
  "TargetFloatingIp": "string"
}

Pair a local floating ip to a remote floating ip. This is useful when replicating NAS/Object.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Local floating ip.
TargetSystem	string¦null	false	none	Target system for the floating ip pairing.
TargetFloatingIp	string¦null	false	none	Remote floating ip.

HardwareResourcesHealth

{
  "HardwareResourcesHealthInPercentage": 0.1,
  "UnhealthyResourceCount": {
    "property1": 0,
    "property2": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
HardwareResourcesHealthInPercentage	number(float)	false	none	none
UnhealthyResourceCount	object¦null	false	none	none
» additionalProperties	integer(int32)¦null	false	none	none

HardwareUtilizationElement

{
  "HardwareUtilizationInPercentage": 0.1,
  "CPUInPercentage": 0.1,
  "MemoryInPercentage": 0.1,
  "DriveInPercentage": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
HardwareUtilizationInPercentage	number(double)¦null	false	none	none
CPUInPercentage	number(double)¦null	false	none	none
MemoryInPercentage	number(double)¦null	false	none	none
DriveInPercentage	number(double)¦null	false	none	none

HbaElement

{
  "Name": "string",
  "Id": 0,
  "Model": "string",
  "FirmwareVersion": "string",
  "DriverVersion": "string",
  "LinkState": "string",
  "Sensors": [
    {
      "Name": "string",
      "Type": "Temperture",
      "Reading": "string",
      "EventMessage": "string",
      "Status": "OK",
      "State": "string",
      "LastReadingTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "ResourceSerial": "string",
  "ResourceStatus": "OK",
  "ErrMsg": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Model	string¦null	false	none	none
FirmwareVersion	string¦null	false	none	none
DriverVersion	string¦null	false	none	none
LinkState	string¦null	false	none	none
Sensors	[SensorsElement]¦null	false	none	none
ResourceSerial	string¦null	false	none	none
ResourceStatus	ResourceStatus	false	none	none
ErrMsg	string¦null	false	none	none

HighAvailabilityState

"Unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	Online
anonymous	WatchdogInit
anonymous	WitnessNotReady
anonymous	WitnessNotConnected
anonymous	None
anonymous	NoneToLocal
anonymous	Local
anonymous	LocalToAll
anonymous	AllToLocal
anonymous	All

HostElement

{
  "Name": "string",
  "Ip": "string",
  "Wwns": [
    "string"
  ],
  "Iqn": "string",
  "Nqn": "string",
  "ChapSecret": "string",
  "Mappings": [
    {
      "Application": "string",
      "Volume": "string",
      "LunId": 0
    }
  ],
  "Pairs": [
    {
      "RemoteSystem": "string",
      "RemoteHost": "string"
    }
  ]
}

List all available hosts.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Limit results by name.
Ip	string¦null	false	none	Show the IP of the hosts.
Wwns	[string]¦null	false	none	none
Iqn	string¦null	false	none	Show iSCSI qualified Name.
Nqn	string¦null	false	none	Show NVMe qualified names.
ChapSecret	string¦null	false	none	none
Mappings	[HostMappingElement]¦null	false	none	none
Pairs	[HostPairElement]¦null	false	none	none

HostElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "Ip": "string",
      "Wwns": [
        "string"
      ],
      "Iqn": "string",
      "Nqn": "string",
      "ChapSecret": "string",
      "Mappings": [
        {
          "Application": "string",
          "Volume": "string",
          "LunId": 0
        }
      ],
      "Pairs": [
        {
          "RemoteSystem": "string",
          "RemoteHost": "string"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[HostElement]¦null	false	none	[List all available hosts.]

HostElementCreate

{
  "Name": "string",
  "Ip": "string",
  "Wwns": [
    "string"
  ],
  "Iqn": "string",
  "ChapSecret": "string",
  "Nqn": "string"
}

Create a host.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	The name of the new initiator/host.
Ip	string¦null	false	none	The IP Address or DNS name of the initiator/host.
Wwns	[string]¦null	false	none	List of world wide names.
Iqn	string¦null	false	none	iSCSI qualified name.
ChapSecret	string¦null	false	none	iSCSI CHAP secret for mutual authentication.
Nqn	string¦null	false	none	NVMe qualified name.

HostElementEdit

{
  "Name": "string",
  "Ip": "string",
  "Wwns": [
    "string"
  ],
  "Iqn": "string",
  "ChapSecret": "string",
  "Nqn": "string"
}

Reconfigure host.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Edit name.
Ip	string¦null	false	none	Edit IP Address or DNS name.
Wwns	[string]¦null	false	none	Edit world wide names.
Iqn	string¦null	false	none	Edit iSCSI qualified name.
ChapSecret	string¦null	false	none	iSCSI CHAP secret for mutual authentication.
Nqn	string¦null	false	none	Edit NVMe qualified name.

HostMappingElement

{
  "Application": "string",
  "Volume": "string",
  "LunId": 0
}

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	none
Volume	string¦null	false	none	none
LunId	integer(int32)	false	none	none

HostPairElement

{
  "RemoteSystem": "string",
  "RemoteHost": "string"
}

Properties

Name	Type	Required	Restrictions	Description
RemoteSystem	string¦null	false	none	none
RemoteHost	string¦null	false	none	none

HostsMappingsAdd

{
  "Application": "string",
  "Hosts": [
    "string"
  ],
  "Volumes": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

Add mapping between a volume and an iSCSi/FC/NVMeOF host.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application.
Hosts	[string]¦null	false	none	The name of the hosts to map the volume to.
Volumes	[string]¦null	false	none	The name of the volumes to map. if not specified, all volumes within the application will be mapped.
LunIds	[string]¦null	false	none	The Lun Id for each volume. Input * to use an available lun id.

HostsPair

{
  "Name": "string",
  "TargetSystem": "string",
  "TargetHost": "string"
}

Pair a host to a host on a remote system.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Local host.
TargetSystem	string¦null	false	none	Target system.
TargetHost	string¦null	false	none	Remote host.

HostsWwnAdd

{
  "Name": "string",
  "Wwns": [
    "string"
  ]
}

Add wwns to an host.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	The name of the initiator.
Wwns	[string]¦null	false	none	List of FC world wide name to add.

IPElement

{
  "Ip": "string",
  "IscsiEnabled": true,
  "TcpNvmeofPorts": [
    "string"
  ],
  "RdmaNvmeofPorts": [
    "string"
  ],
  "TcpNvmeofEnabled": true,
  "RdmaNvmeofEnabled": true
}

Properties

Name	Type	Required	Restrictions	Description
Ip	string¦null	false	none	none
IscsiEnabled	boolean	false	none	none
TcpNvmeofPorts	[string]¦null	false	none	none
RdmaNvmeofPorts	[string]¦null	false	none	none
TcpNvmeofEnabled	boolean	false	read-only	none
RdmaNvmeofEnabled	boolean	false	read-only	none

IsnsElement

{
  "IsnsAddress": "string",
  "AccessControl": true
}

Properties

Name	Type	Required	Restrictions	Description
IsnsAddress	string¦null	false	none	none
AccessControl	boolean	false	none	none

LogEventLevel

0

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

ManualPoolTypes

"Normal"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Normal
anonymous	vJBOD

MappingElementHostPerspective

{
  "Application": "string",
  "Host": "string",
  "Volumes": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

List mappings.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	Application.
Host	string¦null	false	none	Host name.
Volumes	[string]¦null	false	none	none
LunIds	[string]¦null	false	none	none

MappingElementHostPerspectiveApiResult

{
  "Data": [
    {
      "Application": "string",
      "Host": "string",
      "Volumes": [
        "string"
      ],
      "LunIds": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[MappingElementHostPerspective]¦null	false	none	[List mappings.]

MappingElementHostPerspectiveEdit

{
  "Volumes": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

Add/Remove mapping between a volume and an iSCSi/FC/NVMeOF host.

Properties

Name	Type	Required	Restrictions	Description
Volumes	[string]¦null	false	none	The name of the volumes to map.
LunIds	[string]¦null	false	none	The Lun Ids for the mapping. Input * to use an available lun id.

MappingElementVolumePerspective

{
  "Application": "string",
  "Volume": "string",
  "Hosts": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

List mappings.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	Application.
Volume	string¦null	false	none	Volume name.
Hosts	[string]¦null	false	none	none
LunIds	[string]¦null	false	none	none

MappingElementVolumePerspectiveApiResult

{
  "Data": [
    {
      "Application": "string",
      "Volume": "string",
      "Hosts": [
        "string"
      ],
      "LunIds": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[MappingElementVolumePerspective]¦null	false	none	[List mappings.]

MappingElementVolumePerspectiveEdit

{
  "Hosts": [
    "string"
  ],
  "LunIds": [
    "string"
  ]
}

Add/Remove mapping between a volume and an iSCSi/FC/NVMeOF host.

Properties

Name	Type	Required	Restrictions	Description
Hosts	[string]¦null	false	none	The name of the hosts to which the volume will be mapped to.
LunIds	[string]¦null	false	none	The Lun Ids for the mapping. Input * to use an available lun id.

MemoryElement

{
  "Name": "string",
  "Id": 0,
  "Manufacturer": "string",
  "Capacity": "string",
  "MemoryType": "string",
  "Serial": "string",
  "Sensors": [
    {
      "Name": "string",
      "Type": "Temperture",
      "Reading": "string",
      "EventMessage": "string",
      "Status": "OK",
      "State": "string",
      "LastReadingTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "ResourceSerial": "string",
  "ResourceStatus": "OK",
  "ErrMsg": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Manufacturer	string¦null	false	none	none
Capacity	string¦null	false	none	none
MemoryType	string¦null	false	none	none
Serial	string¦null	false	none	none
Sensors	[SensorsElement]¦null	false	none	none
ResourceSerial	string¦null	false	none	none
ResourceStatus	ResourceStatus	false	none	none
ErrMsg	string¦null	false	none	none

MonitoringAluaElement

{
  "VolumeFullName": "string",
  "optimizedIops": 0,
  "unoptimizedIops": 0
}

Properties

Name	Type	Required	Restrictions	Description
VolumeFullName	string¦null	false	none	none
optimizedIops	integer(int64)	false	none	none
unoptimizedIops	integer(int64)	false	none	none

MonitoringAluaElementApiResult

{
  "Data": [
    {
      "VolumeFullName": "string",
      "optimizedIops": 0,
      "unoptimizedIops": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[MonitoringAluaElement]¦null	false	none	none

MonitoringCapacity

{
  "CapacityUsage": [
    {
      "PoolId": 0,
      "Name": "string",
      "RawSizeInBytes": 0.1,
      "TotalAllocatedSizeInBytes": 0.1,
      "TotalConsumedSizeInBytes": 0.1,
      "UserDataAllocatedSizeInBytes": 0.1,
      "UserDataConsumedSizeInBytes": 0.1,
      "UpperTierAllocatedSizeInBytes": 0.1,
      "UpperTierConsumedSizeInBytes": 0.1,
      "RetentionAllocatedSizeInBytes": 0.1,
      "RetentionConsumedSizeInBytes": 0.1,
      "VRAIDAllocationSizeInBytes": 0.1,
      "VRAIDConsumedSizeInBytes": 0.1,
      "MetadataSizeInBytes": 0.1,
      "ReserveSizeInBytes": 0.1,
      "OverAllocationSizeInBytes": 0.1,
      "FreeCapacityInBytes": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
CapacityUsage	[CapacityUsageElement]¦null	false	none	none
ChartsFileInfo	[ChartFile]¦null	false	none	none

MonitoringCapacityHistory

{
  "PerformanceStatstics": [
    {
      "PoolName": "string",
      "Time": "2019-08-24T14:15:22Z",
      "TotalAllocatedSizeInBytes": 0.1,
      "TotalConsumedSizeInBytes": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
PerformanceStatstics	[CapacityHistoryElement]¦null	false	none	none
ChartsFileInfo	[ChartFile]¦null	false	none	none

MonitoringHealth

{
  "Volumes": {
    "VolumesHealthInPercentage": 0.1,
    "HealthyVolumes": 0,
    "UnhealthyVolumes": 0,
    "UnhealthyStates": {
      "property1": "Ok",
      "property2": "Ok"
    }
  },
  "HardwareResources": {
    "HardwareResourcesHealthInPercentage": 0.1,
    "UnhealthyResourceCount": {
      "property1": 0,
      "property2": 0
    }
  },
  "HardwareUtilization": {
    "HardwareUtilizationInPercentage": 0.1,
    "CPUInPercentage": 0.1,
    "MemoryInPercentage": 0.1,
    "DriveInPercentage": 0.1
  },
  "CapacityUtilization": {
    "CapacityInBytes": 0.1,
    "CapacityUsageInBytes": 0.1,
    "ProvisioningStates": [
      "Ok"
    ],
    "PoolCapacity": [
      {
        "PoolName": "string",
        "CapacityInBytes": 0.1,
        "CapacityUsageInBytes": 0.1
      }
    ],
    "PoolCapacityVirtualRaidProvisioning": [
      {
        "Name": "string",
        "FreeSpaceInPercentage": 0.1
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
Volumes	VolumesHealthElement	false	none	none
HardwareResources	HardwareResourcesHealth	false	none	none
HardwareUtilization	HardwareUtilizationElement	false	none	none
CapacityUtilization	BasicCapacityElement	false	none	none

MonitoringPerformanceHistory

{
  "PerformanceStatstics": [
    {
      "Time": "2019-08-24T14:15:22Z",
      "EntityName": "string",
      "Iops": 0.1,
      "ReadIops": 0.1,
      "WriteIops": 0.1,
      "LatencyInMilliseconds": 0.1,
      "ReadLatencyInMilliseconds": 0.1,
      "WriteLatencyInMilliseconds": 0.1,
      "IoSizeInBytes": 0.1,
      "ReadIoSizeInBytes": 0.1,
      "WriteIoSizeInBytes": 0.1,
      "ThroughputInBytes": 0.1,
      "ReadThroughputInBytes": 0.1,
      "WriteThroughputInBytes": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
PerformanceStatstics	[EntityHistoryPerformanceStatsElement]¦null	false	none	none
ChartsFileInfo	[ChartFile]¦null	false	none	none

MonitoringTopVolumes

{
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ],
  "Statistics": [
    {
      "Name": "string",
      "Iops": 0,
      "CapacityInBytes": 0,
      "LatencyInMilliseconds": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
ChartsFileInfo	[ChartFile]¦null	false	none	none
Statistics	[VolumeStatisticElement]¦null	false	none	none

MonitoringUtilizationHistory

{
  "UtilizationHistoryStatstics": [
    {
      "Time": "2019-08-24T14:15:22Z",
      "NodeName": "string",
      "CpuInPercentage": 0.1,
      "MemoryInPercentage": 0.1,
      "SsdInPercentage": 0.1,
      "HddInPercentage": 0.1,
      "NvmeInPercentage": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
UtilizationHistoryStatstics	[UtilizationHistoryElement]¦null	false	none	none
ChartsFileInfo	[ChartFile]¦null	false	none	none

NasServerElement

{
  "Name": "string",
  "Workgroup": "string",
  "NisServer": "string",
  "NisDomain": "string",
  "FloatingIps": [
    "string"
  ],
  "ActiveDirectory": "string",
  "Username": "string",
  "Password": "string",
  "OverwriteExistingServer": true
}

Edit a NAS Server.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	The name of the NAS server to edit.
Workgroup	string¦null	false	none	The name of the workgroup the NAS server will reside on.
NisServer	string¦null	false	none	Network information service ip/hostname.
NisDomain	string¦null	false	none	Connect to a network information service domain.
FloatingIps	[string]¦null	false	none	The new floating ip name for the NAS server.
ActiveDirectory	string¦null	false	none	The name of the active directory realm which the NAS server will authenticate with.
Username	string¦null	false	none	Username of the user that will authenticate with the active directory.
Password	string¦null	false	none	Password for the user that will authenticate with the active directory.
OverwriteExistingServer	boolean¦null	false	none	none

NasServerElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "Workgroup": "string",
      "NisServer": "string",
      "NisDomain": "string",
      "FloatingIps": [
        "string"
      ],
      "ActiveDirectory": "string",
      "Username": "string",
      "Password": "string",
      "OverwriteExistingServer": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[NasServerElement]¦null	false	none	[Edit a NAS Server.]

NasServerElementCreate

{
  "Name": "string",
  "FloatingIps": [
    "string"
  ],
  "NisDomain": "string",
  "NisServer": "string",
  "Workgroup": "string",
  "ActiveDirectory": "string",
  "Username": "string",
  "Password": "string",
  "OverwriteExistingServer": true
}

Create a NAS server.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	The netbios name of the new NAS server.
FloatingIps	[string]¦null	false	none	The floating ips which will be used for this NAS server.
NisDomain	string¦null	false	none	Connect to a network information service domain.
NisServer	string¦null	false	none	Network information service ip/hostname.
Workgroup	string¦null	false	none	The name of the workgroup the NAS server will reside on.
ActiveDirectory	string¦null	false	none	The name of the active directory realm which the NAS server will authenticate with.
Username	string¦null	false	none	Username of the user that will authenticate with the active directory.
Password	string¦null	false	none	Password for the user that will authenticate with the active directory.
OverwriteExistingServer	boolean¦null	false	none	Whether to overwrite existing computer object in active directory with the same computer name.

NasServerElementEdit

{
  "Name": "string",
  "FloatingIps": [
    "string"
  ],
  "NisDomain": "string",
  "NisServer": "string",
  "Workgroup": "string",
  "ActiveDirectory": "string",
  "Username": "string",
  "Password": "string",
  "OverwriteExistingServer": true
}

Edit a NAS Server.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	The new netbios name of the new NAS server.
FloatingIps	[string]¦null	false	none	The new floating ip name for the NAS server.
NisDomain	string¦null	false	none	Connect to a network information service domain.
NisServer	string¦null	false	none	Network information service ip/hostname.
Workgroup	string¦null	false	none	The name of the workgroup the NAS server will reside on.
ActiveDirectory	string¦null	false	none	The name of the active directory realm which the NAS server will authenticate with.
Username	string¦null	false	none	Username of the user that will authenticate with the active directory.
Password	string¦null	false	none	Password for the user that will authenticate with the active directory.
OverwriteExistingServer	boolean¦null	false	none	Whether to overwrite existing computer object in active directory with the same computer name.

NicElement

{
  "Name": "string",
  "Id": 0,
  "Interface": "string",
  "Device": "string",
  "Vendor": "string",
  "Slaves": [
    "string"
  ],
  "Ips": [
    {
      "Ip": "string",
      "IscsiEnabled": true,
      "TcpNvmeofPorts": [
        "string"
      ],
      "RdmaNvmeofPorts": [
        "string"
      ],
      "TcpNvmeofEnabled": true,
      "RdmaNvmeofEnabled": true
    }
  ],
  "SpeedGbs": 0,
  "Sensors": [
    {
      "Name": "string",
      "Type": "Temperture",
      "Reading": "string",
      "EventMessage": "string",
      "Status": "OK",
      "State": "string",
      "LastReadingTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "ResourceSerial": "string",
  "ResourceStatus": "OK",
  "ErrMsg": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Interface	string¦null	false	none	none
Device	string¦null	false	none	none
Vendor	string¦null	false	none	none
Slaves	[string]¦null	false	none	none
Ips	[IPElement]¦null	false	none	none
SpeedGbs	integer(int64)¦null	false	none	none
Sensors	[SensorsElement]¦null	false	none	none
ResourceSerial	string¦null	false	none	none
ResourceStatus	ResourceStatus	false	none	none
ErrMsg	string¦null	false	none	none

NodeElement

{
  "Name": "string",
  "Id": 0,
  "Time": "2019-08-24T14:15:22Z",
  "State": "Running",
  "HAState": "Unknown",
  "CurrentManagementConnection": true,
  "Vols": 0,
  "Iqn": "string",
  "IsSEDPasswordSupplied": true,
  "Wwn": [
    "string"
  ],
  "Volumes": [
    "string"
  ],
  "Sensors": [
    {
      "Name": "string",
      "Type": "Temperture",
      "Reading": "string",
      "EventMessage": "string",
      "Status": "OK",
      "State": "string",
      "LastReadingTimestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "Services": [
    "string"
  ],
  "Sessions": [
    "string"
  ],
  "SupportTunnelStatus": "string",
  "Drives": [
    {
      "Name": "string",
      "Id": 0,
      "Device": "string",
      "UsedCapacityInBytes": 0,
      "ManualPool": "string",
      "DeviceName": "string",
      "PhysicalSector": "string",
      "LogicalSector": "string",
      "Vendor": "string",
      "Model": "string",
      "RotationRate": "string",
      "EnclosureIndex": "string",
      "OSName": "string",
      "Version": "string",
      "SelfEncryptingDrive": "NotSupported",
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "LedState": "string",
      "Type": "HDD",
      "CapacityInBytes": 0,
      "ApprovedState": "Approved",
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ],
  "CPU": [
    {
      "Name": "string",
      "Id": 0,
      "Vendor": "string",
      "Brand": "string",
      "Model": "string",
      "Family": "string",
      "Stepping": "string",
      "CoreCount": "string",
      "LogicalCoresCount": "string",
      "ProcessorID": "string",
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ],
  "Memory": [
    {
      "Name": "string",
      "Id": 0,
      "Manufacturer": "string",
      "Capacity": "string",
      "MemoryType": "string",
      "Serial": "string",
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ],
  "NetworkInterfaceCards": [
    {
      "Name": "string",
      "Id": 0,
      "Interface": "string",
      "Device": "string",
      "Vendor": "string",
      "Slaves": [
        "string"
      ],
      "Ips": [
        {
          "Ip": "string",
          "IscsiEnabled": true,
          "TcpNvmeofPorts": [
            "string"
          ],
          "RdmaNvmeofPorts": [
            "string"
          ],
          "TcpNvmeofEnabled": true,
          "RdmaNvmeofEnabled": true
        }
      ],
      "SpeedGbs": 0,
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ],
  "FibreChannelHostBusAdapters": [
    {
      "Name": "string",
      "Id": 0,
      "Model": "string",
      "FirmwareVersion": "string",
      "DriverVersion": "string",
      "LinkState": "string",
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ],
  "Chassis": [
    {
      "Name": "string",
      "Id": 0,
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "ProductVendor": "string",
      "ProductName": "string",
      "ProductVersion": "string",
      "ProductSerial": "string",
      "ProductUUID": "string",
      "BoardVendor": "string",
      "BoardName": "string",
      "BoardVersion": "string",
      "BoardSerial": "string",
      "BiosVendor": "string",
      "BiosVersion": "string",
      "ChassisType": "string",
      "ChassisSerial": "string",
      "ChassisVendor": "string",
      "ServerVendor": "string",
      "IsVirtualMachine": true,
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ],
  "Pings": [
    {
      "PingType": "string",
      "Address": "string",
      "Error": "string",
      "Nics": [
        "string"
      ],
      "IsSuccessful": true
    }
  ],
  "IpAddresses": [
    "string"
  ],
  "TargetChap": {
    "ChapName": "string",
    "ChapSecret": "string"
  },
  "Isns": {
    "IsnsAddress": "string",
    "AccessControl": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
Time	string(date-time)¦null	false	none	none
State	NodeStatus	false	none	none
HAState	HighAvailabilityState	false	none	none
CurrentManagementConnection	boolean¦null	false	none	none
Vols	integer(int32)¦null	false	none	none
Iqn	string¦null	false	none	none
IsSEDPasswordSupplied	boolean¦null	false	none	none
Wwn	[string]¦null	false	none	none
Volumes	[string]¦null	false	none	none
Sensors	[SensorsElement]¦null	false	none	none
Services	[string]¦null	false	none	none
Sessions	[string]¦null	false	none	none
SupportTunnelStatus	string¦null	false	none	none
Drives	[DriveElement]¦null	false	none	none
CPU	[CPUElement]¦null	false	none	none
Memory	[MemoryElement]¦null	false	none	none
NetworkInterfaceCards	[NicElement]¦null	false	none	none
FibreChannelHostBusAdapters	[HbaElement]¦null	false	none	none
Chassis	[ChassisElement]¦null	false	none	none
Pings	[PingElement]¦null	false	none	none
IpAddresses	[string]¦null	false	none	none
TargetChap	TargetChapElement	false	none	none
Isns	IsnsElement	false	none	none

NodeElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[NodeElement]¦null	false	none	none

NodeStatus

"Running"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Running
anonymous	Down

NodesChap

{
  "ChapName": "string",
  "ChapSecret": "string",
  "Force": true
}

ISCSI target chap settings.

Properties

Name	Type	Required	Restrictions	Description
ChapName	string¦null	false	none	iSCSI Target CHAP username.
ChapSecret	string¦null	false	none	iSCSI Target CHAP secret.
Force	boolean¦null	false	none	Perform operation without asking questions.

NodesConnect

{
  "Node": "string"
}

Switch connection to a different node.

Properties

Name	Type	Required	Restrictions	Description
Node	string¦null	false	none	Node name.

NodesEdit

{
  "Node": "string",
  "Newname": "string"
}

Edit node.

Properties

Name	Type	Required	Restrictions	Description
Node	string¦null	false	none	The name of the node to edit.
Newname	string¦null	false	none	new node name.

NodesGiveback

{
  "Force": true
}

Perform a giveback (changing HA state).

Properties

Name	Type	Required	Restrictions	Description
Force	boolean¦null	false	none	Force the operation, do not ask for approval.

NodesIsns

{
  "Address": "string",
  "AccessControl": true,
  "Force": true
}

ISNS settings.

Properties

Name	Type	Required	Restrictions	Description
Address	string¦null	false	none	iSNS address.
AccessControl	boolean¦null	false	none	enable iSNS access control.
Force	boolean¦null	false	none	Perform operation without asking questions.

NodesSupportTunnelDisable

{
  "Node": "string"
}

Disable support tunnel for node.

Properties

Name	Type	Required	Restrictions	Description
Node	string¦null	false	none	Node that we want to disable access using the support tunnel.

NodesSupportTunnelEnable

{
  "Node": "string"
}

Enable support tunnel for node.

Properties

Name	Type	Required	Restrictions	Description
Node	string¦null	false	none	Node that we want to access using the support tunnel.

NodesTakeover

{
  "Node": "string",
  "Force": true
}

Perform a takeover (changing HA state).

Properties

Name	Type	Required	Restrictions	Description
Node	string¦null	false	none	The name of the node that will take all volumes from the other node (The state of the specific node will change to 'All', while the state of the other node will change to 'None').
Force	boolean¦null	false	none	Force the operation, do not ask for approval.

NotificationElement

{
  "Timestamp": "2019-08-24T14:15:22Z",
  "Node": "string",
  "Id": 0,
  "Level": 0,
  "Module": "string",
  "Message": "string",
  "Exception": "string",
  "Properties": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
Timestamp	string(date-time)	false	none	none
Node	string¦null	false	none	none
Id	integer(int32)	false	none	none
Level	NotificationLevel	false	none	none
Module	string¦null	false	none	none
Message	string¦null	false	none	none
Exception	string¦null	false	read-only	none
Properties	object¦null	false	read-only	none
» additionalProperties	string¦null	false	none	none

NotificationElementApiResult

{
  "Data": [
    {
      "Timestamp": "2019-08-24T14:15:22Z",
      "Node": "string",
      "Id": 0,
      "Level": 0,
      "Module": "string",
      "Message": "string",
      "Exception": "string",
      "Properties": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[NotificationElement]¦null	false	none	none

NotificationLevel

0

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

NotificationTargetElement

{
  "Name": "string",
  "Type": 0,
  "MinEventLevel": 0,
  "ModulesListenedTo": [
    "string"
  ],
  "VisibleToCustomers": true,
  "IsEnabled": true
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Type	Subtypes	false	none	none
MinEventLevel	LogEventLevel	false	none	none
ModulesListenedTo	[string]¦null	false	none	none
VisibleToCustomers	boolean¦null	false	none	none
IsEnabled	boolean	false	none	none

NotificationTargetElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "Type": 0,
      "MinEventLevel": 0,
      "ModulesListenedTo": [
        "string"
      ],
      "VisibleToCustomers": true,
      "IsEnabled": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[NotificationTargetElement]¦null	false	none	none

NotificationsEmailSettingsAndNotificationTargetsResult

{
  "EmailSettings": {
    "MailServerAddress": "string",
    "MailServerPort": 0,
    "MailServerUsername": "string",
    "SendingEmailAddress": "string",
    "SecureSocketOption": 0,
    "ValidateCertificate": true
  },
  "NotificationTargets": [
    {
      "Name": "string",
      "Type": 0,
      "MinEventLevel": 0,
      "ModulesListenedTo": [
        "string"
      ],
      "VisibleToCustomers": true,
      "IsEnabled": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
EmailSettings	NotificationsEmailSettingsElement	false	none	none
NotificationTargets	[NotificationTargetElement]¦null	false	none	none

NotificationsEmailSettingsElement

{
  "MailServerAddress": "string",
  "MailServerPort": 0,
  "MailServerUsername": "string",
  "SendingEmailAddress": "string",
  "SecureSocketOption": 0,
  "ValidateCertificate": true
}

Properties

Name	Type	Required	Restrictions	Description
MailServerAddress	string¦null	false	none	none
MailServerPort	integer(int32)	false	none	none
MailServerUsername	string¦null	false	none	none
SendingEmailAddress	string¦null	false	none	none
SecureSocketOption	SecureSocketOptions	false	none	none
ValidateCertificate	boolean	false	none	none

NotificationsEmailSettingsResult

{
  "EmailSettings": {
    "MailServerAddress": "string",
    "MailServerPort": 0,
    "MailServerUsername": "string",
    "SendingEmailAddress": "string",
    "SecureSocketOption": 0,
    "ValidateCertificate": true
  },
  "Notes": "string"
}

Properties

Name	Type	Required	Restrictions	Description
EmailSettings	NotificationsEmailSettingsElement	false	none	none
Notes	string¦null	false	read-only	none

NotificationsSettingsEmailEdit

{
  "Server": "string",
  "Port": 0,
  "Username": "string",
  "Password": "string",
  "SendFromAddress": "string",
  "RemoveUsernameAndPassword": true,
  "RemoveSendFromAddress": true,
  "SecureSocketOption": "string",
  "DisableCertificateValidation": true,
  "EnableCertificateValidation": true
}

Edit email notifications settings.

Properties

Name	Type	Required	Restrictions	Description
Server	string¦null	false	none	Mail server address.
Port	integer(int64)¦null	false	none	Mail server port.
Username	string¦null	false	none	Mail server username.
Password	string¦null	false	none	Mail server password.
SendFromAddress	string¦null	false	none	The email address notifications will be sent from (in case it is different from the username, or a username is not provided).
RemoveUsernameAndPassword	boolean¦null	false	none	Remove username and password. This means no authentication will be used (anonymous).
RemoveSendFromAddress	boolean¦null	false	none	Remove send from address. The username will be used instead.
SecureSocketOption	string¦null	false	none	What encryption should be used: None: No SSL/TLS encryption should be used Auto: Allow the implementation to decide which SSL or TLS options to use (default). If the server does not support SSL or TLS, then the connection will continue without any encryption. SslOnConnect: The connection should use SSL or TLS encryption immediately. StartTls: Elevates the connection to use TLS encryption immediately after reading the greeting and capabilities of the server. StartTlsWhenAvailable: Elevates the connection to use TLS encryption immediately after reading the greeting and capabilities of the server, but only if the server supports the STARTTLS extension.
DisableCertificateValidation	boolean¦null	false	none	Do not validate the certificate presented by the server when establishing a secure connection. This allows the use of self-signed certificates. It is NOT secure. The certificate will be accepted even it is broken! Use this only if the server is a 100% trusted!.
EnableCertificateValidation	boolean¦null	false	none	Start validating the certificate presented by the server again (when establishing a secure connection).

NotificationsSettingsEmailReset

{
  "Force": true
}

Reset email settings to default values.

Properties

Name	Type	Required	Restrictions	Description
Force	boolean¦null	false	none	Do not ask for approval.

NotificationsTargetsDisable

{
  "Name": [
    "string"
  ],
  "Force": true
}

Temporarily disable notifications targets.

Properties

Name	Type	Required	Restrictions	Description
Name	[string]¦null	false	none	List of notification target names to disable.
Force	boolean¦null	false	none	Do not ask approval.

NotificationsTargetsEmailAdd

{
  "Email": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "HideForCustomers": true,
  "Force": true
}

Add e-mail notification target.

Properties

Name	Type	Required	Restrictions	Description
Email	string¦null	false	none	E-mail address.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
Name	string¦null	false	none	Name in the s1 system (must be unique for all targets).
HideForCustomers	boolean¦null	false	none	Hide the target for a user with the Customer permission level.
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsEmailEdit

{
  "Name": "string",
  "Address": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "HideForCustomers": true,
  "ShowForCustomers": true,
  "Force": true
}

Edit e-mail notification target.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Name in the S1 system.
Address	string¦null	false	none	New e-mail address.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
NewName	string¦null	false	none	New name in the S1 system.
Disable	boolean¦null	false	none	Temporarily disable the target.
Enable	boolean¦null	false	none	Enable the target (only necessary if it was manually disabled).
HideForCustomers	boolean¦null	false	none	Hide the target for a user with the Customer permission level.
ShowForCustomers	boolean¦null	false	none	Show the target for a user with the Customer permission level.
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsEnable

{
  "Name": [
    "string"
  ],
  "Force": true
}

Enable notifications targets.

Properties

Name	Type	Required	Restrictions	Description
Name	[string]¦null	false	none	List of notification target names to enable.
Force	boolean¦null	false	none	Do not ask approval.

NotificationsTargetsSeqAdd

{
  "ServerUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "Force": true
}

Add Seq server notification target.

Properties

Name	Type	Required	Restrictions	Description
ServerUrl	string¦null	false	none	Url address of the Seq server.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
Name	string¦null	false	none	Name in the s1 system (must be unique for all targets).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsSeqEdit

{
  "Name": "string",
  "ServerUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Edit Seq server notification target.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Name in the S1 system.
ServerUrl	string¦null	false	none	New Url address of the Seq server.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
NewName	string¦null	false	none	New name in the S1 system.
Disable	boolean¦null	false	none	Temporarily disable the target.
Enable	boolean¦null	false	none	Enable the target (only necessary if it was manually disabled).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsSlackAdd

{
  "WebhookUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "Force": true
}

Add Slack notification target.

Properties

Name	Type	Required	Restrictions	Description
WebhookUrl	string¦null	false	none	Slack Webhook Url.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
Name	string¦null	false	none	Name in the s1 system (must be unique for all targets).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsSlackEdit

{
  "Name": "string",
  "WebhookUrl": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Edit Slack notification target.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Name in the S1 system.
WebhookUrl	string¦null	false	none	New Slack Webhook Url.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
NewName	string¦null	false	none	New name in the S1 system.
Disable	boolean¦null	false	none	Temporarily disable the target.
Enable	boolean¦null	false	none	Enable the target (only necessary if it was manually disabled).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsSnmpAdd

{
  "Ip": "string",
  "ManagerPort": 0,
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "CommunityString": "string",
  "TrapVersion": "string",
  "V3Context": "string",
  "V3Username": "string",
  "V3AuthPhrase": "string",
  "V3PrivacyPhrase": "string",
  "Name": "string",
  "Force": true
}

Add SNMP notification target.

Properties

Name	Type	Required	Restrictions	Description
Ip	string¦null	false	none	Manager IP address.
ManagerPort	integer(int64)¦null	false	none	Manager port. Default is 162.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
CommunityString	string¦null	false	none	The community string to use when sending out a trap.
TrapVersion	string¦null	false	none	SNMP trap version to use. Possible values: (v1/v2/v3).
V3Context	string¦null	false	none	(Only for v3 traps) Context to use when sending out a trap.
V3Username	string¦null	false	none	(Only for v3 traps) Username when using the auth security levels.
V3AuthPhrase	string¦null	false	none	(Only for v3 traps) Pass phrase to use when using the authNoPriv/authPriv security levels.
V3PrivacyPhrase	string¦null	false	none	(Only for v3 traps) Pass phrase to use when using the authPriv security level.
Name	string¦null	false	none	Name in the s1 system (must be unique for all targets).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsSnmpEdit

{
  "Name": "string",
  "ManagerAddress": "string",
  "ManagerPort": 0,
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "CommunityString": "string",
  "TrapVersion": "string",
  "V3Context": "string",
  "V3Username": "string",
  "V3AuthPhrase": "string",
  "V3PrivacyPhrase": "string",
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Edit SNMP notification target.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Name in the S1 system.
ManagerAddress	string¦null	false	none	New manager IP address.
ManagerPort	integer(int64)¦null	false	none	Manager port.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
CommunityString	string¦null	false	none	The community string to use when sending out a trap.
TrapVersion	string¦null	false	none	SNMP trap version to use. Possible values: v1/v2/v3.
V3Context	string¦null	false	none	(Only for v3 traps) Context to use when sending out a trap.
V3Username	string¦null	false	none	(Only for v3 traps) Username when using the auth security levels.
V3AuthPhrase	string¦null	false	none	(Only for v3 traps) Pass phrase to use when using the authNoPriv/authPriv security levels.
V3PrivacyPhrase	string¦null	false	none	(Only for v3 traps) Pass phrase to use when using the authPriv security level.
NewName	string¦null	false	none	New name in the S1 system.
Disable	boolean¦null	false	none	Temporarily disable the target.
Enable	boolean¦null	false	none	Enable the target (only necessary if it was manually disabled).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsSyslogAdd

{
  "ConnectionType": "string",
  "ServerAddress": "string",
  "ServerPort": 0,
  "SslProtocol": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "Name": "string",
  "Force": true
}

Add Syslog notification target.

Properties

Name	Type	Required	Restrictions	Description
ConnectionType	string¦null	false	none	What Syslog to connect to (remote TCP or remote UDP).
ServerAddress	string¦null	false	none	Network address of the remote Syslog server.
ServerPort	integer(int64)¦null	false	none	Port on the remote Syslog server.
SslProtocol	string¦null	false	none	SSL protocols to use when establishing connection to the remote Syslog server.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
Name	string¦null	false	none	Name in the s1 system (must be unique for all targets).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTargetsSyslogEdit

{
  "Name": "string",
  "ConnectionType": "string",
  "ServerAddress": "string",
  "ServerPort": 0,
  "SslProtocol": "string",
  "MinLevel": "string",
  "Modules": [
    "string"
  ],
  "BatchPostingLimit": 0,
  "BatchPostingPeriod": 0,
  "NewName": "string",
  "Disable": true,
  "Enable": true,
  "Force": true
}

Edit Syslog notification target.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Name in the S1 system.
ConnectionType	string¦null	false	none	What Syslog to connect to (remote TCP or UDP).
ServerAddress	string¦null	false	none	Network address of a remote Syslog server.
ServerPort	integer(int64)¦null	false	none	Port on the remote Syslog server.
SslProtocol	string¦null	false	none	SSL protocol to use when establishing the connecting to the remote Syslog server.
MinLevel	string¦null	false	none	Minimum event level to notify about.
Modules	[string]¦null	false	none	List of module names to notify about.
BatchPostingLimit	integer(int64)¦null	false	none	The maximum number of events to post in a single batch. Must be greater than zero.
BatchPostingPeriod	integer(int64)¦null	false	none	The time to wait between checking for event batches (in seconds). Must be greater than zero.
NewName	string¦null	false	none	New name in the S1 system.
Disable	boolean¦null	false	none	Temporarily disable the target.
Enable	boolean¦null	false	none	Enable the target (only necessary if it was manually disabled).
Force	boolean¦null	false	none	Perform operation without validations.

NotificationsTest

{
  "Node": "string",
  "Level": "string",
  "Module": "string",
  "Message": "string"
}

Generate a test notification.

Properties

Name	Type	Required	Restrictions	Description
Node	string¦null	false	none	The name of the S1 node that will generate the notification.
Level	string¦null	false	none	Notification level.
Module	string¦null	false	none	Notification module name.
Message	string¦null	false	none	Notification message.

ObjectAccessKeyElement

{
  "AccessKey": "string",
  "Role": "string",
  "SecretKey": "string",
  "EncryptedSecretKey": "string",
  "Force": true
}

View all object access keys.

Properties

Name	Type	Required	Restrictions	Description
AccessKey	string¦null	false	none	Filter results by access key.
Role	string¦null	false	none	none
SecretKey	string¦null	false	none	none
EncryptedSecretKey	string¦null	false	none	none
Force	boolean¦null	false	none	none

ObjectAccessKeyElementApiResult

{
  "Data": [
    {
      "AccessKey": "string",
      "Role": "string",
      "SecretKey": "string",
      "EncryptedSecretKey": "string",
      "Force": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[ObjectAccessKeyElement]¦null	false	none	[View all object access keys.]

ObjectAccessKeyElementCreate

{
  "AccessKey": "string",
  "SecretKey": "string",
  "Role": "string"
}

Create an object access key.

Properties

Name	Type	Required	Restrictions	Description
AccessKey	string¦null	false	none	Object access key name.
SecretKey	string¦null	false	none	Object secret key.
Role	string¦null	false	none	Object user permissions. Admin (administrator) or Regular(r/w inside the permitted buckets only).

ObjectAccessKeyElementEdit

{
  "AccessKey": "string",
  "SecretKey": "string",
  "Role": "string",
  "Force": true
}

Edit object access key.

Properties

Name	Type	Required	Restrictions	Description
AccessKey	string¦null	false	none	New access key.
SecretKey	string¦null	false	none	New secret key.
Role	string¦null	false	none	New user permissions.
Force	boolean¦null	false	none	Force Edit volume even if it related to an object store.

ObjectStoreElement

{
  "Application": "string",
  "Volume": "string",
  "IP": "string",
  "FloatingIp": "string",
  "Port": 0,
  "EnableSsl": true,
  "AccessKeys": [
    "string"
  ],
  "ObjectProvider": "Minio"
}

View all object stores.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application that contains the object store.
Volume	string¦null	false	none	The name of the volume that contains the object store.
IP	string¦null	false	none	none
FloatingIp	string¦null	false	none	none
Port	integer(int64)¦null	false	none	none
EnableSsl	boolean¦null	false	none	none
AccessKeys	[string]¦null	false	none	none
ObjectProvider	SelectedObjectStoreProvider	false	none	none

ObjectStoreElementApiResult

{
  "Data": [
    {
      "Application": "string",
      "Volume": "string",
      "IP": "string",
      "FloatingIp": "string",
      "Port": 0,
      "EnableSsl": true,
      "AccessKeys": [
        "string"
      ],
      "ObjectProvider": "Minio"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[ObjectStoreElement]¦null	false	none	[View all object stores.]

ObjectStoreElementCreate

{
  "Application": "string",
  "Volume": "string",
  "FloatingIp": "string",
  "Port": 0,
  "AccessKeys": [
    "string"
  ],
  "EnableSsl": true
}

Create an object store on a specific volume.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application the object store will be created in.
Volume	string¦null	false	none	The name of the volume on which the object store will be created.ate.
FloatingIp	string¦null	false	none	The floating ip which will be used for this object store.
Port	integer(int64)¦null	false	none	TCP port for this object store.
AccessKeys	[string]¦null	false	none	Object access Keys to access the object store.
EnableSsl	boolean¦null	false	none	Enable using SSL.

ObjectStoreElementEdit

{
  "FloatingIp": "string",
  "Port": 0,
  "AccessKeys": [
    "string"
  ],
  "EnableSsl": true
}

Edit an object store.

Properties

Name	Type	Required	Restrictions	Description
FloatingIp	string¦null	false	none	The new floating ip which will be used for this object store.
Port	integer(int64)¦null	false	none	The new TCP port for this object store.
AccessKeys	[string]¦null	false	none	Access Keys to access the object store.
EnableSsl	boolean¦null	false	none	Enable using SSL.

PairedFloatingIpElement

{
  "Name": "string",
  "RemoteSystemId": 0,
  "RemoteSystemName": "string",
  "Address": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
RemoteSystemId	integer(int64)	false	none	none
RemoteSystemName	string¦null	false	none	none
Address	string¦null	false	none	none

PerformanceAnalyzerDriveElement

{
  "NodeName": "string",
  "PerformanceTestName": "string",
  "Entity": "string",
  "Status": "SystemPerformance",
  "PerformanceResult": {
    "IOPS": 0,
    "Throughput": "string",
    "LatencyInMilliseconds": 0.1,
    "DurationInSec": 0.1
  }
}

Properties

Name	Type	Required	Restrictions	Description
NodeName	string¦null	false	none	none
PerformanceTestName	string¦null	false	none	none
Entity	string¦null	false	none	none
Status	Result	false	none	none
PerformanceResult	SimplifiedPerformanceResult	false	none	none

PerformanceAnalyzerDriveElementApiResult

{
  "Data": [
    {
      "NodeName": "string",
      "PerformanceTestName": "string",
      "Entity": "string",
      "Status": "SystemPerformance",
      "PerformanceResult": {
        "IOPS": 0,
        "Throughput": "string",
        "LatencyInMilliseconds": 0.1,
        "DurationInSec": 0.1
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[PerformanceAnalyzerDriveElement]¦null	false	none	none

PingElement

{
  "PingType": "string",
  "Address": "string",
  "Error": "string",
  "Nics": [
    "string"
  ],
  "IsSuccessful": true
}

Properties

Name	Type	Required	Restrictions	Description
PingType	string¦null	false	none	none
Address	string¦null	false	none	none
Error	string¦null	false	none	none
Nics	[string]¦null	false	none	none
IsSuccessful	boolean	false	read-only	none

PoolCapacity

{
  "PoolName": "string",
  "CapacityInBytes": 0.1,
  "CapacityUsageInBytes": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
PoolName	string¦null	false	none	none
CapacityInBytes	number(double)¦null	false	none	none
CapacityUsageInBytes	number(double)¦null	false	none	none

PoolNPlusK

{
  "N": 0,
  "K": 0
}

Properties

Name	Type	Required	Restrictions	Description
N	integer(int32)	false	none	none
K	integer(int32)	false	none	none

PoolNPlusKThinProvisioningState

{
  "PoolName": "string",
  "VirtualRaidValues": [
    {
      "N": 0,
      "K": 0
    }
  ],
  "State": "Ok",
  "Reason": "None",
  "FreeSpaceInPercentage": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
PoolName	string¦null	false	none	none
VirtualRaidValues	[PoolNPlusK]¦null	false	none	none
State	ThinProvisioningState	false	none	none
Reason	ThinProvisioningStateReason	false	none	none
FreeSpaceInPercentage	number(double)¦null	false	none	none

PoolNPlusKThinProvisioningStateApiResult

{
  "Data": [
    {
      "PoolName": "string",
      "VirtualRaidValues": [
        {
          "N": 0,
          "K": 0
        }
      ],
      "State": "Ok",
      "Reason": "None",
      "FreeSpaceInPercentage": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[PoolNPlusKThinProvisioningState]¦null	false	none	none

ReplicationConnectionStatus

"Initializing"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Initializing
anonymous	Syncing
anonymous	Connected
anonymous	Disconnected
anonymous	Unknown

ReplicationDataStatus

"NotAvailable"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	NotAvailable
anonymous	UpToDate
anonymous	NotUpToDate
anonymous	Unknown

ReplicationDiskStatus

"Unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	UpToDate
anonymous	Outdated
anonymous	Diskless
anonymous	Inconsistent

ReplicationEdit

{
  "Application": "string",
  "Volume": "string",
  "TargetSystem": "string",
  "Synchronous": true,
  "Semisynchronous": true,
  "Asynchronous": true
}

Edit a replication pair.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The source app on which the volume you want to stop the replication.
Volume	string¦null	false	none	Source volume to stop replicating.
TargetSystem	string¦null	false	none	Stop replication for this target system.
Synchronous	boolean¦null	false	none	Change to synchronous replication.
Semisynchronous	boolean¦null	false	none	Change to semi-synchronous replication.
Asynchronous	boolean¦null	false	none	Change to asynchronous replication.

ReplicationElement

{
  "IpAddress": "string",
  "Port": 0,
  "Role": "Unknown",
  "InternalRole": "Unknown",
  "LocalDataStatus": "NotAvailable",
  "ReplicationPairs": [
    {
      "SyncInPercentage": 0.1,
      "ReplicationId": 0,
      "RemoteSystemName": "string",
      "RemoteSystemId": 0,
      "RemoteSystemRole": "Unknown",
      "IpAddress": "string",
      "Port": 0,
      "RemoteAppName": "string",
      "RemoteVolName": "string",
      "ReplicationProtocol": "None",
      "ConnectionStatus": "Initializing",
      "RemoteDataStatus": "NotAvailable",
      "RemoteDiskStatus": "Unknown"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
IpAddress	string¦null	false	none	none
Port	integer(int64)	false	none	none
Role	ReplicationRole	false	none	none
InternalRole	ReplicationRole	false	none	none
LocalDataStatus	ReplicationDataStatus	false	none	none
ReplicationPairs	[ReplicationPairElement]¦null	false	none	none

ReplicationFloatingipsCreate

{
  "Name": "string",
  "Nodes": [
    "string"
  ],
  "Interfaces": [
    "string"
  ],
  "Addresses": [
    "string"
  ],
  "Mask": "string",
  "Gateway": "string",
  "Force": true
}

Create a replication floating ip.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Give the replication floating ip a name.
Nodes	[string]¦null	false	none	Select one node for a single node or two for an HA pair.
Interfaces	[string]¦null	false	none	The interface name of the corresponding node id. Set an interface for each node.
Addresses	[string]¦null	false	none	The ip addresses of the replication floating ip. Set an IP for each node.
Mask	string¦null	false	none	The subnet mask of the replication floating ip.
Gateway	string¦null	false	none	The gateway of the replication floating ip.
Force	boolean¦null	false	none	Ignore validations and force creation of replication floating ip.

ReplicationFloatingipsEdit

{
  "Name": "string",
  "Newname": "string",
  "Nodes": [
    "string"
  ],
  "Interfaces": [
    "string"
  ],
  "Addresses": [
    "string"
  ],
  "Mask": "string",
  "Gateway": "string",
  "Force": true
}

Edit a replication floating ip.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Give the replication floating ip a name.
Newname	string¦null	false	none	New name for the replication floating ip.
Nodes	[string]¦null	false	none	Select one node for a single node or two for an HA pair.
Interfaces	[string]¦null	false	none	The interface name of the corresponding node id. Set an interface for each node.
Addresses	[string]¦null	false	none	The ip addresses of the replication floating ip. Set an IP for each node.
Mask	string¦null	false	none	The subnet mask of the replication floating ip.
Gateway	string¦null	false	none	The gateway of the replication floating ip.
Force	boolean¦null	false	none	Ignore validations and force update of replication floating ip.

ReplicationMetadata

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	Replicated
anonymous	PendingReplication
anonymous	WillBeRemovedWhenReplicationStops

ReplicationPairElement

{
  "SyncInPercentage": 0.1,
  "ReplicationId": 0,
  "RemoteSystemName": "string",
  "RemoteSystemId": 0,
  "RemoteSystemRole": "Unknown",
  "IpAddress": "string",
  "Port": 0,
  "RemoteAppName": "string",
  "RemoteVolName": "string",
  "ReplicationProtocol": "None",
  "ConnectionStatus": "Initializing",
  "RemoteDataStatus": "NotAvailable",
  "RemoteDiskStatus": "Unknown"
}

Properties

Name	Type	Required	Restrictions	Description
SyncInPercentage	number(float)¦null	false	none	none
ReplicationId	integer(int64)	false	none	none
RemoteSystemName	string¦null	false	none	none
RemoteSystemId	integer(int64)	false	none	none
RemoteSystemRole	ReplicationRole	false	none	none
IpAddress	string¦null	false	none	none
Port	integer(int64)	false	none	none
RemoteAppName	string¦null	false	none	none
RemoteVolName	string¦null	false	none	none
ReplicationProtocol	ReplicationProtocol	false	none	none
ConnectionStatus	ReplicationConnectionStatus	false	none	none
RemoteDataStatus	ReplicationDataStatus	false	none	none
RemoteDiskStatus	ReplicationDiskStatus	false	none	none

ReplicationPrimary

{
  "Application": "string",
  "Volume": [
    "string"
  ],
  "Cgids": [
    0
  ],
  "AllSecondaryVolumes": true,
  "InactiveFloatingToActivate": [
    "string"
  ],
  "ActivateAllInactiveFloatingIps": true,
  "Force": true
}

Promote secondary volumes to active/primary state.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	App on which the secondary volume resides.
Volume	[string]¦null	false	none	Secondary volumes to switch to primary (and the remote primary volume to secondary).
Cgids	[integer]¦null	false	none	Transition specific consistency groups by ids.
AllSecondaryVolumes	boolean¦null	false	none	Transition all secondary volumes to primary.
InactiveFloatingToActivate	[string]¦null	false	none	Migrate the IPs to all paired inactive floating IPs.
ActivateAllInactiveFloatingIps	boolean¦null	false	none	Migrate the IPs to all paired inactive floating IPs.
Force	boolean¦null	false	none	Allow transitioning even if the replication link is disconnected.

ReplicationProtocol

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	Synchronous
anonymous	SemiSynchronous
anonymous	Asynchronous

ReplicationRole

"Unknown"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	Primary
anonymous	Secondary
anonymous	Pairless
anonymous	Groupless
anonymous	NotReplicated

ReplicationStart

{
  "Application": "string",
  "Volume": "string",
  "TargetSystem": "string",
  "TargetApplication": "string",
  "TargetVolume": "string",
  "SourceFloatingIp": "string",
  "TargetFloatingIp": "string",
  "Synchronous": true,
  "Semisynchronous": true,
  "Asynchronous": true,
  "Force": true
}

Replicate a volume.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The app on which the volume you want to replicate resides.
Volume	string¦null	false	none	Volumes to replicate.
TargetSystem	string¦null	false	none	Target system to replicate to.
TargetApplication	string¦null	false	none	Specify an existing app with a non-initialized volume for the replication pairing.
TargetVolume	string¦null	false	none	An existing non-initialized target volume to replicate to.
SourceFloatingIp	string¦null	false	none	The floating ip for replication on the source system.
TargetFloatingIp	string¦null	false	none	The floating ip for replication on the target system.
Synchronous	boolean¦null	false	none	Synchronous replication.
Semisynchronous	boolean¦null	false	none	Semi-synchronous replication.
Asynchronous	boolean¦null	false	none	Asynchronous replication.
Force	boolean¦null	false	none	Do not ask for an approval.

ResetPasswordElement

{
  "Username": "string",
  "Email": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Username	string¦null	false	none	none
Email	string¦null	false	none	none

ResourceStatus

"OK"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	OK
anonymous	Error
anonymous	Degraded
anonymous	PredFail
anonymous	LinkDown
anonymous	Unknown
anonymous	NotReportingStatus
anonymous	Missing
anonymous	NotReady
anonymous	DuplicateIp
anonymous	LockedSed

ResourcesDrivesApprove

{
  "DriveIds": [
    0
  ],
  "All": true,
  "Patterns": [
    "string"
  ],
  "Count": 0,
  "ManualPool": "string",
  "Force": true
}

Approve new drives.

Properties

Name	Type	Required	Restrictions	Description
DriveIds	[integer]¦null	false	none	Approve newly added drives with these ids.
All	boolean¦null	false	none	Approve all drives.
Patterns	[string]¦null	false	none	Patterns to filter drives by either drive name, capacity, serial or type. Regex is supported.
Count	integer(int64)¦null	false	none	Number of drives to take that match the specified patterns.
ManualPool	string¦null	false	none	If specified, the drive will be allocated to this manual pool (instead of an automatic pool).
Force	boolean¦null	false	none	Do not ask for approval when approving drives.

ResourcesDrivesPoolsCreate

{
  "Name": "string",
  "MaxSectorsKb": 0
}

Create a manual pool.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Provide a name for the manual pool.
MaxSectorsKb	integer(int64)¦null	false	none	The maximum number of kilobytes that the block layer will allow for an IO request.

ResourcesDrivesPoolsEdit

{
  "Name": "string",
  "NewName": "string",
  "MaxSectorsKb": 0
}

Edit a manual pool.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	The name of the manual pool.
NewName	string¦null	false	none	The new name of the manual pool.
MaxSectorsKb	integer(int64)¦null	false	none	The maximum number of kilobytes that the block layer will allow for an IO request.

ResourcesDrivesSedInitialize

{
  "DriveIds": [
    0
  ],
  "All": true,
  "Password": "string",
  "ConfirmPassword": "string"
}

Initialize self-encrypting drives with a password. This should be done on new drives.

Properties

Name	Type	Required	Restrictions	Description
DriveIds	[integer]¦null	false	none	Initialize self-encrypting drives with these ids.
All	boolean¦null	false	none	Initialize all self-encrypting drives.
Password	string¦null	false	none	Password used to initialize the self-encrypting drives. (Must be the same password for all self-encrypting drives on this system).
ConfirmPassword	string¦null	false	none	Reinput the password.

ResourcesDrivesSedSupplyPassword

{
  "Password": "string"
}

Set password used to unlock the self-encrypting drives.

Properties

Name	Type	Required	Restrictions	Description
Password	string¦null	false	none	Password used to unlock the self-encrypting drives.

ResourcesNetworkIscsi

{
  "Enable": true,
  "Force": true
}

Enable/disable iscsi traffic on specific ips.

Properties

Name	Type	Required	Restrictions	Description
Enable	boolean¦null	false	none	Enable iscsi traffic.
Force	boolean¦null	false	none	Force operation.

ResourcesNetworkNvmeof

{
  "Port": 0,
  "Enable": true,
  "Rdma": true,
  "Tcp": true
}

Enable/disable nvmeof traffic on specific ips.

Properties

Name	Type	Required	Restrictions	Description
Port	integer(int64)¦null	false	none	The port to enable/disable NVMeOF traffic on.
Enable	boolean¦null	false	none	Enable NVMeOF traffic.
Rdma	boolean¦null	false	none	Use RDMA as the transport for NVMeOF traffic.
Tcp	boolean¦null	false	none	Use TCP as the transport for NVMeOF traffic.

Result

"SystemPerformance"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	SystemPerformance
anonymous	NormalRange
anonymous	SlightyLowerPerforming
anonymous	SubstantiallyLowerPerforming

S1Version

{
  "Versions": [
    {
      "Component": "string",
      "Version": "string",
      "BuildNumber": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Versions	[ComponentVersion]¦null	false	none	none

SecureSocketOptions

0

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4

SelectedObjectStoreProvider

"Minio"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Minio
anonymous	Swift

SelfEncryptingDriveSupport

"NotSupported"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	NotSupported
anonymous	Supported
anonymous	Locked

SensorsElement

{
  "Name": "string",
  "Type": "Temperture",
  "Reading": "string",
  "EventMessage": "string",
  "Status": "OK",
  "State": "string",
  "LastReadingTimestamp": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Type	SensorsType	false	none	none
Reading	string¦null	false	none	none
EventMessage	string¦null	false	none	none
Status	ResourceStatus	false	none	none
State	string¦null	false	none	none
LastReadingTimestamp	string(date-time)	false	none	none

SensorsType

"Temperture"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Temperture
anonymous	Fan
anonymous	Voltage
anonymous	PowerSupply
anonymous	Storage
anonymous	Memory
anonymous	General

SettingsAnomalyDetectionEdit

{
  "Timeframe_days": 0,
  "ChangeInPercentage": 0.1
}

Update anomaly detection settings.

Properties

Name	Type	Required	Restrictions	Description
Timeframe_days	integer(int64)¦null	false	none	Number of days to consider for historic statistics (1-60 days). Setting 0 disables the anomaly detection.
ChangeInPercentage	number(float)¦null	false	none	Percentage of capacity change to consider as 'abnormal' for notification. e.g. 300 means today's change is 3 times (or 300%) above the max or below the min in the timeframe. Setting 0 disables the anomaly detection.

SettingsAuthentication

{
  "EnableMultifactorAuthentication": true
}

Enable/disable two factor authentication.

Properties

Name	Type	Required	Restrictions	Description
EnableMultifactorAuthentication	boolean¦null	false	none	Enable multi factor authentication. Each login will require inputting authentication tokens that are sent to your email address.

SettingsCapacityUnits

{
  "BinaryUnits": true,
  "DecimalUnits": true
}

Change the capacity units used for drives, volumes and statistics.

Properties

Name	Type	Required	Restrictions	Description
BinaryUnits	boolean¦null	false	none	Use binary units (megabyte, gigabyte, terabyte, petabyte...).
DecimalUnits	boolean¦null	false	none	Use decimal units (mebibyte, gibibyte, tebibyte, pebibyte...).

ShareElement

{
  "Application": "string",
  "Volume": "string",
  "Share": "string",
  "Path": "string",
  "Browsable": true,
  "RecycleBin": true,
  "ReadonlyAccess": true,
  "AllowedSubnets": [
    "string"
  ],
  "Smb": true,
  "Nfs": true
}

List share.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	Filter by application.
Volume	string¦null	false	none	Filter by volume name.
Share	string¦null	false	none	none
Path	string¦null	false	none	none
Browsable	boolean¦null	false	none	none
RecycleBin	boolean¦null	false	none	none
ReadonlyAccess	boolean¦null	false	none	none
AllowedSubnets	[string]¦null	false	none	none
Smb	boolean¦null	false	none	none
Nfs	boolean¦null	false	none	none

ShareElementApiResult

{
  "Data": [
    {
      "Application": "string",
      "Volume": "string",
      "Share": "string",
      "Path": "string",
      "Browsable": true,
      "RecycleBin": true,
      "ReadonlyAccess": true,
      "AllowedSubnets": [
        "string"
      ],
      "Smb": true,
      "Nfs": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[ShareElement]¦null	false	none	[List share.]

ShareElementCreate

{
  "Application": "string",
  "Volume": "string",
  "Share": "string",
  "Smb": true,
  "Nfs": true,
  "Path": "string",
  "Browsable": true,
  "AllowedSubnets": [
    "string"
  ],
  "RecycleBin": true,
  "ReadonlyAccess": true
}

Create a SMB or NFS shares inside a volume.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application the share will be created in.
Volume	string¦null	false	none	The name of the volume on which the share will be created.
Share	string¦null	false	none	The name that will be given to the share.
Smb	boolean¦null	false	none	Choose SMB protocol for the share.
Nfs	boolean¦null	false	none	Choose NFS protocol for the share.
Path	string¦null	false	none	A path inside the volume to which the share will redirect to. If you choose not to input a value, the share will redirect to the root folder inside the volume.
Browsable	boolean¦null	false	none	Relevant only for SMB. this allows clients to browse the share.
AllowedSubnets	[string]¦null	false	none	Allows only specific IP subnets to access the share. the format to input the subnets is: ip/mask. for example, inputting 192.168.0.0/255.255.0.0 192.169.0.0/255.255.0.0 will allow only IPs 192.168.x.x and 192.169.x.x to access the share. input '*' to provide access to all IPs or do not input a value at all.
RecycleBin	boolean¦null	false	none	Support recycle bin.
ReadonlyAccess	boolean¦null	false	none	Allows read-only access to the share.

ShareElementEdit

{
  "Share": "string",
  "Smb": true,
  "Nfs": true,
  "Path": "string",
  "Browsable": true,
  "AllowedSubnets": [
    "string"
  ],
  "ReadonlyAccess": true,
  "RecycleBin": true
}

Edit SMB/NFS shares.

Properties

Name	Type	Required	Restrictions	Description
Share	string¦null	false	none	Give the share a new name.
Smb	boolean¦null	false	none	Choose SMB protocol for the share.
Nfs	boolean¦null	false	none	Choose NFS protocol for the share.
Path	string¦null	false	none	A path inside the volume to which the share will redirect to. If you choose not to input a value, the share will redirect to the root folder inside the volume.
Browsable	boolean¦null	false	none	Relevant only for SMB. This selection allows clients to browse the share.
AllowedSubnets	[string]¦null	false	none	Allows only specific IP subnets to access the share. the format to input the subnets is: ip/mask. for example, inputting 192.168.0.0/255.255.0.0 192.169.0.0/255.255.0.0 will allow only IPs 192.168.x.x and 192.169.x.x to access the share. input '*' to provide access to all IPs or do not input a value at all.
ReadonlyAccess	boolean¦null	false	none	Set read-only access to the share.
RecycleBin	boolean¦null	false	none	Enable recycle bin.

SimplifiedPerformanceResult

{
  "IOPS": 0,
  "Throughput": "string",
  "LatencyInMilliseconds": 0.1,
  "DurationInSec": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
IOPS	integer(int64)	false	none	none
Throughput	string¦null	false	none	none
LatencyInMilliseconds	number(double)	false	none	none
DurationInSec	number(double)	false	none	none

SnapshotElement

{
  "Id": 0,
  "Date": "2019-08-24T14:15:22Z",
  "Owner": "None"
}

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int64)	false	none	none
Date	string(date-time)	false	none	none
Owner	SnapshotOwner	false	none	none

SnapshotOwner

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	User
anonymous	Scheduler
anonymous	Vss
anonymous	LockManager
anonymous	ResizeVolume
anonymous	CreateReplication

Status

"Ok"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Ok
anonymous	Busy
anonymous	NotExist
anonymous	ReferecesExist
anonymous	Fail
anonymous	NodeAlreadyConnectedToCloud
anonymous	ComputeAlreadyInProgress
anonymous	ApplyAlreadyInProgress
anonymous	ApplyCompleted
anonymous	Irrelevant
anonymous	InvalidVolume
anonymous	Aborted
anonymous	ClientNotReady
anonymous	Duplicate
anonymous	InvalidRequest
anonymous	RepresentativeNotExist
anonymous	NotSynchronized
anonymous	Timeout
anonymous	UserNotAuthorized
anonymous	UserNotLoggedIn
anonymous	InvalidUsernamePassword
anonymous	InvalidUsernameVerificationCode
anonymous	InvalidPasswordExpired
anonymous	InvalidUsernameEmail
anonymous	EmailAlreadyVerified
anonymous	EmailAlreadyExist
anonymous	FailedSendingAuthenticationTokenViaEmail
anonymous	UserNameIsNotUnique
anonymous	ActionPolicyIsNotUnique
anonymous	VolumeNameIsNotUnique
anonymous	ApplicationNameIsNotUnique
anonymous	HostNameIsNotUnique
anonymous	EntityAlreayExist
anonymous	VolumeNotInitialized
anonymous	ConditionNotMet
anonymous	FailedToConnectToService
anonymous	EntityHasPendingChanges
anonymous	EntityChangedSinceVCVersion
anonymous	InvalidEntityName
anonymous	LocalPersist
anonymous	InvalidCommand
anonymous	UnsupportedCommand
anonymous	CommunicationError
anonymous	PluginFailure
anonymous	PluginOperationNotSupported
anonymous	Miscompare
anonymous	WriteProtect
anonymous	DataNotInitialized
anonymous	RequestNotExist
anonymous	RequestAlreadyExist
anonymous	ConfigurationNotValid
anonymous	AlreadyMounted
anonymous	OutOfDiskSpace
anonymous	REST_AuthorizationHeaderBadOrMissing
anonymous	REST_SessionTokenExpired
anonymous	REST_SessionTokenNotValid
anonymous	REST_HtmlErrorResponseReceived
anonymous	EnclosureNotExist
anonymous	CantSetStateUnkown
anonymous	ResourceCurrentlyNotAvailable
anonymous	DiskRegisteredInAnotherCloud
anonymous	SystemNotHighlyAvailable
anonymous	NotJoinedToDomain
anonymous	ActiveDirectoryNotAvailable
anonymous	BadNetbiosName
anonymous	DateClockSkew
anonymous	InsufficientAccess
anonymous	EmailNotVerified
anonymous	EmailVerificationRequired
anonymous	InvalidEmailVerificationToken
anonymous	Disconnected
anonymous	Readonly
anonymous	NotSupported
anonymous	ShuttingDown
anonymous	TwoFactorAuthenticationRequired
anonymous	InvalidTwoFactorAuthentication
anonymous	LoginIsTemporarilyDisabledDueToFailedAttempts
anonymous	NotAvailable
anonymous	MissingAuthenticationHeader
anonymous	SessionTokenDoesNotExist
anonymous	DisposedSession
anonymous	InvalidAuthorizationHeader
anonymous	InvalidJsonBody
anonymous	InvalidData
anonymous	FailedLogin
anonymous	WrongSyntax
anonymous	MissingCommand
anonymous	UserBlocked
anonymous	InvalidVersion
anonymous	TestValidationError
anonymous	SessionLimit
anonymous	RequiresForceFlag
anonymous	PendingAction
anonymous	CloudNotInitialized
anonymous	InvalidExternalSessionToken
anonymous	PendingActionFullyApproved
anonymous	VolumeRecycled
anonymous	ActionPolicyBlocks
anonymous	ClientCertificate

Subtypes

0

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int32)	false	none	none

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6

SystemElement

{
  "Id": 0,
  "Name": "string",
  "IsCurrentlyConnectedSystem": true,
  "Connectivity": "Relay",
  "ConnectedNodeAddress": "string",
  "RefreshedCachedQueryCount": 0,
  "Nodes": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true
    }
  ],
  "ReplicationTargetSystems": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Id	integer(int64)	false	none	none
Name	string¦null	false	none	none
IsCurrentlyConnectedSystem	boolean	false	none	none
Connectivity	ConnectivityType	false	none	none
ConnectedNodeAddress	string¦null	false	none	none
RefreshedCachedQueryCount	integer(int32)¦null	false	none	none
Nodes	[BasicNodeElement]¦null	false	none	none
ReplicationTargetSystems	[string]¦null	false	none	none

SystemsList

{
  "Systems": [
    {
      "Id": 0,
      "Name": "string",
      "IsCurrentlyConnectedSystem": true,
      "Connectivity": "Relay",
      "ConnectedNodeAddress": "string",
      "RefreshedCachedQueryCount": 0,
      "Nodes": [
        {
          "Name": "string",
          "Id": 0,
          "Time": "2019-08-24T14:15:22Z",
          "State": "Running",
          "HAState": "Unknown",
          "CurrentManagementConnection": true
        }
      ],
      "ReplicationTargetSystems": [
        "string"
      ]
    }
  ],
  "Message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Systems	[SystemElement]¦null	false	none	none
Message	string¦null	false	none	none

SystemsRename

{
  "Name": "string",
  "Id": 0,
  "Newname": "string"
}

Rename a system.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Select system to rename by name.
Id	integer(int64)¦null	false	none	Select system to rename by id.
Newname	string¦null	false	none	New name of the system.

TargetChapElement

{
  "ChapName": "string",
  "ChapSecret": "string"
}

Properties

Name	Type	Required	Restrictions	Description
ChapName	string¦null	false	none	none
ChapSecret	string¦null	false	none	none

TemplateElement

{
  "Application": "string",
  "Description": "string",
  "Volumes": [
    {
      "Application": "string",
      "Volume": "string",
      "Id": 0,
      "CapacityInBytes": 0,
      "SnapshotCapacityInBytes": 0,
      "Tiers": {
        "TierEntityIds": [
          0
        ],
        "TierPools": [
          "string"
        ],
        "TierN": [
          0
        ],
        "TierK": [
          0
        ],
        "TierSizesInBytes": [
          0
        ],
        "EvacuationThresholdsInPercentage": [
          0.1
        ],
        "LowerThresholdsInPercentage": [
          0.1
        ],
        "TierDataDegradationHistogram": [
          [
            0
          ]
        ],
        "TierMetadataDegradationHistogram": [
          [
            0
          ]
        ]
      },
      "Pool": "string",
      "StripedPools": [
        "string"
      ],
      "Log2StrideSectors": 0,
      "MetadataPool": "string",
      "StripedMetadataPools": [
        "string"
      ],
      "N": 0,
      "K": 0,
      "MetadataN": 0,
      "MetadataK": 0,
      "SectorSize": "string",
      "Cgid": 0,
      "GroupedVolume": "string"
    }
  ],
  "ConsistencyGroups": [
    {
      "Id": 0,
      "SnapshotScheduler": [
        "string"
      ],
      "VolumeShadowCopySupport": true,
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "Id": 0,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string"
        }
      ]
    }
  ]
}

List application templates.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	none
Description	string¦null	false	none	none
Volumes	[VolumeTemplateElement]¦null	false	none	none
ConsistencyGroups	[ConsistencyGroupTemplateElement]¦null	false	none	none

TemplateElementApiResult

{
  "Data": [
    {
      "Application": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "Id": 0,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string"
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "VolumeShadowCopySupport": true,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "Id": 0,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string"
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[TemplateElement]¦null	false	none	[List application templates.]

TemplateElementCreate

{
  "Application": "string",
  "Description": "string"
}

Create an application template.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application template to create.
Description	string¦null	false	none	Template description.

TemplateElementEdit

{
  "Application": "string",
  "Description": "string"
}

Edit an application template.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	New name for the application template.
Description	string¦null	false	none	New description for the application template.

TemplatesSnapshotsSchedule

{
  "Frequency": [
    "string"
  ],
  "Retention": [
    "string"
  ]
}

Schedule snapshots.

Properties

Name	Type	Required	Restrictions	Description
Frequency	[string]¦null	false	none	Recovery point objective. This configures the frequency of the snapshots.
Retention	[string]¦null	false	none	The retention of a specific frequency.

ThinProvisioningState

"Ok"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Ok
anonymous	SoftThresholdWarning
anonymous	SoftThresholdReadonly
anonymous	HardThresholdReadonly
anonymous	VolumeGeometryLimit

ThinProvisioningStateReason

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	NPlusK
anonymous	FreeSpace

TierElement

{
  "TierEntityIds": [
    0
  ],
  "TierPools": [
    "string"
  ],
  "TierN": [
    0
  ],
  "TierK": [
    0
  ],
  "TierSizesInBytes": [
    0
  ],
  "EvacuationThresholdsInPercentage": [
    0.1
  ],
  "LowerThresholdsInPercentage": [
    0.1
  ],
  "TierDataDegradationHistogram": [
    [
      0
    ]
  ],
  "TierMetadataDegradationHistogram": [
    [
      0
    ]
  ]
}

Properties

Name	Type	Required	Restrictions	Description
TierEntityIds	[integer]¦null	false	none	none
TierPools	[string]¦null	false	none	none
TierN	[integer]¦null	false	none	none
TierK	[integer]¦null	false	none	none
TierSizesInBytes	[integer]¦null	false	none	none
EvacuationThresholdsInPercentage	[number]¦null	false	none	none
LowerThresholdsInPercentage	[number]¦null	false	none	none
TierDataDegradationHistogram	[array]¦null	false	none	none
TierMetadataDegradationHistogram	[array]¦null	false	none	none

UsageState

"Approved"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Approved
anonymous	ApprovedEnclosureOut
anonymous	NotApprovedNewDisk
anonymous	NotApprovedDeadDisk
anonymous	IgnoredDeadDisk
anonymous	ApprovedFailedToOpen
anonymous	MountedOperatingSystemDrive

UserElement

{
  "Name": "string",
  "Password": "string",
  "Email": "string",
  "TwoStepAuthenticationEnabled": true,
  "Role": "string"
}

List all available users.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Filter users by name.
Password	string¦null	false	none	none
Email	string¦null	false	none	none
TwoStepAuthenticationEnabled	boolean	false	none	none
Role	string¦null	false	none	Filter by permissions.

UserElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "Password": "string",
      "Email": "string",
      "TwoStepAuthenticationEnabled": true,
      "Role": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[UserElement]¦null	false	none	[List all available users.]

UserElementCreate

{
  "Name": "string",
  "Password": "string",
  "Role": "string",
  "Email": "string"
}

Creating another user that can view and manage S1.

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	Give the user a name.
Password	string¦null	false	none	Give the user a password.
Role	string¦null	false	none	User permissions.
Email	string¦null	false	none	Email address.

UserElementEdit

{
  "Role": "string",
  "Password": "string",
  "Email": "string"
}

Edit a user.

Properties

Name	Type	Required	Restrictions	Description
Role	string¦null	false	none	New permissions.
Password	string¦null	false	none	New password.
Email	string¦null	false	none	New password.

UtilizationHistoryElement

{
  "Time": "2019-08-24T14:15:22Z",
  "NodeName": "string",
  "CpuInPercentage": 0.1,
  "MemoryInPercentage": 0.1,
  "SsdInPercentage": 0.1,
  "HddInPercentage": 0.1,
  "NvmeInPercentage": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
Time	string(date-time)	false	none	none
NodeName	string¦null	false	none	none
CpuInPercentage	number(double)¦null	false	none	none
MemoryInPercentage	number(double)¦null	false	none	none
SsdInPercentage	number(double)¦null	false	none	none
HddInPercentage	number(double)¦null	false	none	none
NvmeInPercentage	number(double)¦null	false	none	none

UtilizationLiveElement

{
  "Time": "string",
  "EntityName": "string",
  "CPUInPercentage": 0,
  "MemoryInPercentage": 0,
  "HDDInPercentage": 0,
  "HDDPoolsInPercentage": {
    "property1": 0,
    "property2": 0
  },
  "SSDInPercentage": 0,
  "SSDPoolsInPercentage": {
    "property1": 0,
    "property2": 0
  },
  "NvmeInPercentage": 0,
  "NvmePoolsInPercentage": {
    "property1": 0,
    "property2": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
Time	string¦null	false	none	none
EntityName	string¦null	false	none	none
CPUInPercentage	integer(int32)¦null	false	none	none
MemoryInPercentage	integer(int32)¦null	false	none	none
HDDInPercentage	integer(int32)¦null	false	none	none
HDDPoolsInPercentage	object¦null	false	none	none
» additionalProperties	integer(int32)¦null	false	none	none
SSDInPercentage	integer(int32)¦null	false	none	none
SSDPoolsInPercentage	object¦null	false	none	none
» additionalProperties	integer(int32)¦null	false	none	none
NvmeInPercentage	integer(int32)¦null	false	none	none
NvmePoolsInPercentage	object¦null	false	none	none
» additionalProperties	integer(int32)¦null	false	none	none

UtilizationLiveElementApiResult

{
  "Data": [
    {
      "Time": "string",
      "EntityName": "string",
      "CPUInPercentage": 0,
      "MemoryInPercentage": 0,
      "HDDInPercentage": 0,
      "HDDPoolsInPercentage": {
        "property1": 0,
        "property2": 0
      },
      "SSDInPercentage": 0,
      "SSDPoolsInPercentage": {
        "property1": 0,
        "property2": 0
      },
      "NvmeInPercentage": 0,
      "NvmePoolsInPercentage": {
        "property1": 0,
        "property2": 0
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[UtilizationLiveElement]¦null	false	none	none

VmElement

{
  "Name": "string",
  "VolumeName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
VolumeName	string¦null	false	none	none

VolumeChunkReserveSpaceElement

{
  "Name": "string",
  "UsedDataInBytes": 0.1,
  "TotalChunksInBytes": 0.1,
  "HddChunksInBytes": 0.1,
  "SsdChunksInBytes": 0.1,
  "NvmeChunksInBytes": 0.1,
  "ReserveSpaceInBytes": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
UsedDataInBytes	number(double)	false	none	none
TotalChunksInBytes	number(double)	false	none	none
HddChunksInBytes	number(double)	false	none	none
SsdChunksInBytes	number(double)	false	none	none
NvmeChunksInBytes	number(double)	false	none	none
ReserveSpaceInBytes	number(double)	false	read-only	none

VolumeChunkReserveSpaceElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "UsedDataInBytes": 0.1,
      "TotalChunksInBytes": 0.1,
      "HddChunksInBytes": 0.1,
      "SsdChunksInBytes": 0.1,
      "NvmeChunksInBytes": 0.1,
      "ReserveSpaceInBytes": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[VolumeChunkReserveSpaceElement]¦null	false	none	none

VolumeConnectivityType

"None"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	None
anonymous	Block
anonymous	FileAndObject

VolumeElement

{
  "Application": "string",
  "Volume": "string",
  "VolumeEntityId": 0,
  "Id": 0,
  "MetadataVolumeEntityId": 0,
  "IsInternalVolume": true,
  "CapacityInBytes": 0,
  "SnapshotCapacityInBytes": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  },
  "IsRoot": true,
  "State": "Ok",
  "Vms": [
    "string"
  ],
  "Shares": [
    {
      "Application": "string",
      "Volume": "string",
      "Share": "string",
      "Path": "string",
      "Browsable": true,
      "RecycleBin": true,
      "ReadonlyAccess": true,
      "AllowedSubnets": [
        "string"
      ],
      "Smb": true,
      "Nfs": true
    }
  ],
  "Profile": "string",
  "Mapping": [
    {
      "Host": "string",
      "LunId": 0
    }
  ],
  "Naa": "string",
  "StatsInfo": {
    "UserDataAllocatedSizeInBytes": 0.1,
    "UserDataConsumedSizeInBytes": 0.1,
    "UpperTierAllocatedSizeInBytes": 0.1,
    "UpperTierConsumedSizeInBytes": 0.1,
    "RetentionAllocatedSizeInBytes": 0.1,
    "RetentionConsumedSizeInBytes": 0.1,
    "VRAIDAllocatedSizeInBytes": 0.1,
    "VRAIDConsumedSizeInBytes": 0.1,
    "Iops": 0.1,
    "LatencyInMilliseconds": 0.1,
    "IoSizeInBytes": 0.1,
    "ThroughputInBytes": 0.1
  },
  "FileSystemInformation": {
    "MountState": "Mounted",
    "ReplicationMetadata": "None",
    "Profile": "string",
    "FilesystemState": "string",
    "InodeCount": "string",
    "FreeInodes": "string",
    "BlockSize": "string",
    "BlockCount": "string",
    "FreeBlocks": "string",
    "FilesystemCreated": "string",
    "LastMountTime": "string",
    "LastWriteTime": "string",
    "MountCount": "string",
    "LastChecked": "string",
    "LifeTimeWrites": "string"
  },
  "Object": {
    "Application": "string",
    "Volume": "string",
    "IP": "string",
    "FloatingIp": "string",
    "Port": 0,
    "EnableSsl": true,
    "AccessKeys": [
      "string"
    ],
    "ObjectProvider": "Minio"
  },
  "ConnectivityType": "None",
  "Replication": {
    "IpAddress": "string",
    "Port": 0,
    "Role": "Unknown",
    "InternalRole": "Unknown",
    "LocalDataStatus": "NotAvailable",
    "ReplicationPairs": [
      {
        "SyncInPercentage": 0.1,
        "ReplicationId": 0,
        "RemoteSystemName": "string",
        "RemoteSystemId": 0,
        "RemoteSystemRole": "Unknown",
        "IpAddress": "string",
        "Port": 0,
        "RemoteAppName": "string",
        "RemoteVolName": "string",
        "ReplicationProtocol": "None",
        "ConnectionStatus": "Initializing",
        "RemoteDataStatus": "NotAvailable",
        "RemoteDiskStatus": "Unknown"
      }
    ]
  },
  "Pool": "string",
  "StripedPools": [
    "string"
  ],
  "Log2StrideSectors": 0,
  "DataDegradationHistogram": [
    0
  ],
  "MetadataDegradationHistogram": [
    0
  ],
  "MetadataPool": "string",
  "StripedMetadataPools": [
    "string"
  ],
  "N": 0,
  "K": 0,
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "Cgid": 0,
  "GroupedVolume": "string",
  "DisableSpaceReclamation": true,
  "EncryptionKey": "string",
  "SaveEncryptedRecoveryKey": true,
  "Encrypted": true,
  "Uptime": "string",
  "ReadOnly": true,
  "Force": true
}

List volumes.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	Limit results by the application instance name.
Volume	string¦null	false	none	Limit results by the volume name.
VolumeEntityId	integer(int64)¦null	false	none	none
Id	integer(int64)¦null	false	none	none
MetadataVolumeEntityId	integer(int64)¦null	false	none	none
IsInternalVolume	boolean¦null	false	none	none
CapacityInBytes	integer(int64)¦null	false	none	none
SnapshotCapacityInBytes	integer(int64)¦null	false	none	none
Tiers	TierElement	false	none	none
IsRoot	boolean¦null	false	none	none
State	VolumeState	false	none	none
Vms	[string]¦null	false	none	none
Shares	[ShareElement]¦null	false	none	[List share.]
Profile	string¦null	false	none	none
Mapping	[VolumeMappingElement]¦null	false	none	none
Naa	string¦null	false	none	none
StatsInfo	VolumeStatsElement	false	none	none
FileSystemInformation	FileSystemInfoElement	false	none	none
Object	ObjectStoreElement	false	none	View all object stores.
ConnectivityType	VolumeConnectivityType	false	none	none
Replication	ReplicationElement	false	none	none
Pool	string¦null	false	none	none
StripedPools	[string]¦null	false	none	none
Log2StrideSectors	integer(int64)¦null	false	none	none
DataDegradationHistogram	[integer]¦null	false	none	none
MetadataDegradationHistogram	[integer]¦null	false	none	none
MetadataPool	string¦null	false	none	none
StripedMetadataPools	[string]¦null	false	none	none
N	integer(int64)¦null	false	none	none
K	integer(int64)¦null	false	none	none
MetadataN	integer(int64)¦null	false	none	none
MetadataK	integer(int64)¦null	false	none	none
SectorSize	string¦null	false	none	none
Cgid	integer(int64)¦null	false	none	none
GroupedVolume	string¦null	false	none	none
DisableSpaceReclamation	boolean¦null	false	none	none
EncryptionKey	string¦null	false	none	none
SaveEncryptedRecoveryKey	boolean¦null	false	none	none
Encrypted	boolean¦null	false	none	none
Uptime	string¦null	false	none	none
ReadOnly	boolean¦null	false	none	none
Force	boolean¦null	false	none	none

VolumeElementCreate

{
  "Application": "string",
  "Volume": "string",
  "CapacityInBytes": 0,
  "Pool": "string",
  "N": 0,
  "K": 0,
  "MetadataPool": "string",
  "MetadataN": 0,
  "MetadataK": 0,
  "GroupedVolume": "string",
  "Cgid": 0,
  "EncryptionKey": "string",
  "SaveEncryptedRecoveryKey": true,
  "SectorSize": "string",
  "StripedPools": [
    "string"
  ],
  "StripedMetadataPools": [
    "string"
  ],
  "Log2StrideSectors": 0,
  "SnapshotCapacityInBytes": 0,
  "DisableSpaceReclamation": true,
  "Force": true,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Create a volume.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application on which the volume will be created.
Volume	string¦null	false	none	Volume name.
CapacityInBytes	integer(int64)¦null	false	none	Capacity for the new volume.
Pool	string¦null	false	none	The drive pool on the which the volume will be created.
N	integer(int64)¦null	false	none	The data fragments of the volume.
K	integer(int64)¦null	false	none	The redundancy fragments of the volume.
MetadataPool	string¦null	false	none	The drive pool on the which the volume metadata will be created.
MetadataN	integer(int64)¦null	false	none	The data fragments of the metadata.
MetadataK	integer(int64)¦null	false	none	The redundancy fragments of the metadata.
GroupedVolume	string¦null	false	none	The new volume will be created in the same consistency group as this volume.
Cgid	integer(int64)¦null	false	none	Create this volume in this consistency group.
EncryptionKey	string¦null	false	none	Encrypt the volume using the supplied key.
SaveEncryptedRecoveryKey	boolean¦null	false	none	Encrypt the encryption key with asymmetric encryption and save it for recovery purposes.
SectorSize	string¦null	false	none	The sector sizes of the volumes (type either 512B or 4KB).
StripedPools	[string]¦null	false	none	Create a striped volume by adding additional pools.
StripedMetadataPools	[string]¦null	false	none	Add additional metadata pools for the striped volume.
Log2StrideSectors	integer(int64)¦null	false	none	Stride settings for striped volume.
SnapshotCapacityInBytes	integer(int64)¦null	false	none	Snapshot capacity threshold.
DisableSpaceReclamation	boolean¦null	false	none	Disable Space Reclamation (UNMAP) on this volume.
Force	boolean¦null	false	none	Force operation.
Tiers	TierElement	false	none	none

VolumeElementEdit

{
  "Volume": "string",
  "CapacityInBytes": 0,
  "SnapshotCapacityInBytes": 0,
  "DisableSpaceReclamation": true,
  "ReadOnly": true,
  "Force": true,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Change the parameters of a volume within an application instance.

Properties

Name	Type	Required	Restrictions	Description
Volume	string¦null	false	none	The new name of the volume.
CapacityInBytes	integer(int64)¦null	false	none	Capacity for the volume.
SnapshotCapacityInBytes	integer(int64)¦null	false	none	Snapshot capacity threshold.
DisableSpaceReclamation	boolean¦null	false	none	Disable Space Reclamation (UNMAP) on this volume.
ReadOnly	boolean¦null	false	none	Make the volume read-only.
Force	boolean¦null	false	none	Force operation.
Tiers	TierElement	false	none	none

VolumeElementVcp

{
  "volume": {
    "Application": "string",
    "Volume": "string",
    "VolumeEntityId": 0,
    "Id": 0,
    "MetadataVolumeEntityId": 0,
    "IsInternalVolume": true,
    "CapacityInBytes": 0,
    "SnapshotCapacityInBytes": 0,
    "Tiers": {
      "TierEntityIds": [
        0
      ],
      "TierPools": [
        "string"
      ],
      "TierN": [
        0
      ],
      "TierK": [
        0
      ],
      "TierSizesInBytes": [
        0
      ],
      "EvacuationThresholdsInPercentage": [
        0.1
      ],
      "LowerThresholdsInPercentage": [
        0.1
      ],
      "TierDataDegradationHistogram": [
        [
          0
        ]
      ],
      "TierMetadataDegradationHistogram": [
        [
          0
        ]
      ]
    },
    "IsRoot": true,
    "State": "Ok",
    "Vms": [
      "string"
    ],
    "Shares": [
      {
        "Application": "string",
        "Volume": "string",
        "Share": "string",
        "Path": "string",
        "Browsable": true,
        "RecycleBin": true,
        "ReadonlyAccess": true,
        "AllowedSubnets": [
          "string"
        ],
        "Smb": true,
        "Nfs": true
      }
    ],
    "Profile": "string",
    "Mapping": [
      {
        "Host": "string",
        "LunId": 0
      }
    ],
    "Naa": "string",
    "StatsInfo": {
      "UserDataAllocatedSizeInBytes": 0.1,
      "UserDataConsumedSizeInBytes": 0.1,
      "UpperTierAllocatedSizeInBytes": 0.1,
      "UpperTierConsumedSizeInBytes": 0.1,
      "RetentionAllocatedSizeInBytes": 0.1,
      "RetentionConsumedSizeInBytes": 0.1,
      "VRAIDAllocatedSizeInBytes": 0.1,
      "VRAIDConsumedSizeInBytes": 0.1,
      "Iops": 0.1,
      "LatencyInMilliseconds": 0.1,
      "IoSizeInBytes": 0.1,
      "ThroughputInBytes": 0.1
    },
    "FileSystemInformation": {
      "MountState": "Mounted",
      "ReplicationMetadata": "None",
      "Profile": "string",
      "FilesystemState": "string",
      "InodeCount": "string",
      "FreeInodes": "string",
      "BlockSize": "string",
      "BlockCount": "string",
      "FreeBlocks": "string",
      "FilesystemCreated": "string",
      "LastMountTime": "string",
      "LastWriteTime": "string",
      "MountCount": "string",
      "LastChecked": "string",
      "LifeTimeWrites": "string"
    },
    "Object": {
      "Application": "string",
      "Volume": "string",
      "IP": "string",
      "FloatingIp": "string",
      "Port": 0,
      "EnableSsl": true,
      "AccessKeys": [
        "string"
      ],
      "ObjectProvider": "Minio"
    },
    "ConnectivityType": "None",
    "Replication": {
      "IpAddress": "string",
      "Port": 0,
      "Role": "Unknown",
      "InternalRole": "Unknown",
      "LocalDataStatus": "NotAvailable",
      "ReplicationPairs": [
        {
          "SyncInPercentage": 0.1,
          "ReplicationId": 0,
          "RemoteSystemName": "string",
          "RemoteSystemId": 0,
          "RemoteSystemRole": "Unknown",
          "IpAddress": "string",
          "Port": 0,
          "RemoteAppName": "string",
          "RemoteVolName": "string",
          "ReplicationProtocol": "None",
          "ConnectionStatus": "Initializing",
          "RemoteDataStatus": "NotAvailable",
          "RemoteDiskStatus": "Unknown"
        }
      ]
    },
    "Pool": "string",
    "StripedPools": [
      "string"
    ],
    "Log2StrideSectors": 0,
    "DataDegradationHistogram": [
      0
    ],
    "MetadataDegradationHistogram": [
      0
    ],
    "MetadataPool": "string",
    "StripedMetadataPools": [
      "string"
    ],
    "N": 0,
    "K": 0,
    "MetadataN": 0,
    "MetadataK": 0,
    "SectorSize": "string",
    "Cgid": 0,
    "GroupedVolume": "string",
    "DisableSpaceReclamation": true,
    "EncryptionKey": "string",
    "SaveEncryptedRecoveryKey": true,
    "Encrypted": true,
    "Uptime": "string",
    "ReadOnly": true,
    "Force": true
  },
  "datastore": {
    "Name": "string",
    "Type": "string",
    "Volume": [
      "string"
    ],
    "Details": [
      "string"
    ],
    "EsxiHosts": [
      "string"
    ],
    "Vms": [
      "string"
    ]
  },
  "SessionTokenVCP": "string",
  "SessionTokenClone": "string",
  "VCenterAddress": "string"
}

Properties

Name	Type	Required	Restrictions	Description
volume	VolumeElement	false	none	List volumes.
datastore	DatastoreElement	false	none	none
SessionTokenVCP	string¦null	false	none	none
SessionTokenClone	string¦null	false	read-only	none
VCenterAddress	string¦null	false	none	none

VolumeEvacuationsStatsElement

{
  "Name": "string",
  "LowerTierPoolNames": [
    "string"
  ],
  "UpperTierPoolName": "string",
  "UpperTierUsedSizeInBytes": 0.1,
  "UpperTierAllocatedSizeInBytes": 0.1,
  "UpperTierLowerThresholdSizeInBytes": 0.1,
  "UpperTierHigherThresholdSizeInBytes": 0.1,
  "TierUsageChangePerSecondInBytes": 0.1,
  "IsEvacuating": true,
  "IsInBypass": true,
  "WasEvacuating": true,
  "TierMinUsageChangeInBytes": 0.1,
  "TierUsageChangeInBytes_90thPrecentile": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
LowerTierPoolNames	[string]¦null	false	none	none
UpperTierPoolName	string¦null	false	none	none
UpperTierUsedSizeInBytes	number(double)¦null	false	none	none
UpperTierAllocatedSizeInBytes	number(double)¦null	false	none	none
UpperTierLowerThresholdSizeInBytes	number(double)¦null	false	none	none
UpperTierHigherThresholdSizeInBytes	number(double)¦null	false	none	none
TierUsageChangePerSecondInBytes	number(double)¦null	false	none	none
IsEvacuating	boolean¦null	false	none	none
IsInBypass	boolean¦null	false	none	none
WasEvacuating	boolean¦null	false	none	none
TierMinUsageChangeInBytes	number(double)¦null	false	none	none
TierUsageChangeInBytes_90thPrecentile	number(double)¦null	false	none	none

VolumeEvacuationsStatsElementApiResult

{
  "Data": [
    {
      "Name": "string",
      "LowerTierPoolNames": [
        "string"
      ],
      "UpperTierPoolName": "string",
      "UpperTierUsedSizeInBytes": 0.1,
      "UpperTierAllocatedSizeInBytes": 0.1,
      "UpperTierLowerThresholdSizeInBytes": 0.1,
      "UpperTierHigherThresholdSizeInBytes": 0.1,
      "TierUsageChangePerSecondInBytes": 0.1,
      "IsEvacuating": true,
      "IsInBypass": true,
      "WasEvacuating": true,
      "TierMinUsageChangeInBytes": 0.1,
      "TierUsageChangeInBytes_90thPrecentile": 0.1
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[VolumeEvacuationsStatsElement]¦null	false	none	none

VolumeFstrimStatus

{
  "Application": "string",
  "Volume": "string",
  "IsFstrimRunning": true
}

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	none
Volume	string¦null	false	none	none
IsFstrimRunning	boolean	false	none	none

VolumeFstrimStatusApiResult

{
  "Data": [
    {
      "Application": "string",
      "Volume": "string",
      "IsFstrimRunning": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[VolumeFstrimStatus]¦null	false	none	none

VolumeMappingElement

{
  "Host": "string",
  "LunId": 0
}

Properties

Name	Type	Required	Restrictions	Description
Host	string¦null	false	none	none
LunId	integer(int32)	false	none	none

VolumeMountState

"Mounted"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Mounted
anonymous	NotMounted
anonymous	Unknown

VolumeState

"Ok"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Ok
anonymous	Degraded
anonymous	NotAvailable
anonymous	OutOfSpace
anonymous	ReadOnly
anonymous	NotInitialized
anonymous	Timeout
anonymous	DeletingSnapshots
anonymous	RequiresEncryptionKey
anonymous	EvacuationInProgress

VolumeStatisticElement

{
  "Name": "string",
  "Iops": 0,
  "CapacityInBytes": 0,
  "LatencyInMilliseconds": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
Iops	integer(int64)¦null	false	none	none
CapacityInBytes	integer(int64)¦null	false	none	none
LatencyInMilliseconds	number(double)¦null	false	none	none

VolumeStatsElement

{
  "UserDataAllocatedSizeInBytes": 0.1,
  "UserDataConsumedSizeInBytes": 0.1,
  "UpperTierAllocatedSizeInBytes": 0.1,
  "UpperTierConsumedSizeInBytes": 0.1,
  "RetentionAllocatedSizeInBytes": 0.1,
  "RetentionConsumedSizeInBytes": 0.1,
  "VRAIDAllocatedSizeInBytes": 0.1,
  "VRAIDConsumedSizeInBytes": 0.1,
  "Iops": 0.1,
  "LatencyInMilliseconds": 0.1,
  "IoSizeInBytes": 0.1,
  "ThroughputInBytes": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
UserDataAllocatedSizeInBytes	number(double)¦null	false	none	none
UserDataConsumedSizeInBytes	number(double)¦null	false	none	none
UpperTierAllocatedSizeInBytes	number(double)¦null	false	none	none
UpperTierConsumedSizeInBytes	number(double)¦null	false	none	none
RetentionAllocatedSizeInBytes	number(double)¦null	false	none	none
RetentionConsumedSizeInBytes	number(double)¦null	false	none	none
VRAIDAllocatedSizeInBytes	number(double)¦null	false	none	none
VRAIDConsumedSizeInBytes	number(double)¦null	false	none	none
Iops	number(double)¦null	false	none	none
LatencyInMilliseconds	number(double)¦null	false	none	none
IoSizeInBytes	number(double)¦null	false	none	none
ThroughputInBytes	number(double)¦null	false	none	none

VolumeTemplateElement

{
  "Application": "string",
  "Volume": "string",
  "Id": 0,
  "CapacityInBytes": 0,
  "SnapshotCapacityInBytes": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  },
  "Pool": "string",
  "StripedPools": [
    "string"
  ],
  "Log2StrideSectors": 0,
  "MetadataPool": "string",
  "StripedMetadataPools": [
    "string"
  ],
  "N": 0,
  "K": 0,
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "Cgid": 0,
  "GroupedVolume": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	none
Volume	string¦null	false	none	none
Id	integer(int64)¦null	false	none	none
CapacityInBytes	integer(int64)¦null	false	none	none
SnapshotCapacityInBytes	integer(int64)¦null	false	none	none
Tiers	TierElement	false	none	none
Pool	string¦null	false	none	none
StripedPools	[string]¦null	false	none	none
Log2StrideSectors	integer(int64)¦null	false	none	none
MetadataPool	string¦null	false	none	none
StripedMetadataPools	[string]¦null	false	none	none
N	integer(int64)¦null	false	none	none
K	integer(int64)¦null	false	none	none
MetadataN	integer(int64)¦null	false	none	none
MetadataK	integer(int64)¦null	false	none	none
SectorSize	string¦null	false	none	none
Cgid	integer(int64)¦null	false	none	none
GroupedVolume	string¦null	false	none	none

VolumeTemplateElementCreate

{
  "Application": "string",
  "Volume": "string",
  "CapacityInBytes": 0,
  "Pool": "string",
  "N": 0,
  "K": 0,
  "MetadataPool": "string",
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "StripedPools": [
    "string"
  ],
  "StripedMetadataPools": [
    "string"
  ],
  "SnapshotCapacityInBytes": 0,
  "GroupedVolume": "string",
  "Cgid": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Create a new volume template.

Properties

Name	Type	Required	Restrictions	Description
Application	string¦null	false	none	The name of the application template on which the volume template will be created.
Volume	string¦null	false	none	Volume name.
CapacityInBytes	integer(int64)¦null	false	none	Capacity for the new volume.
Pool	string¦null	false	none	The drive pool/pools on the which the volumes will be created.
N	integer(int64)¦null	false	none	The data fragments of the volume.
K	integer(int64)¦null	false	none	The redundancy fragments of the volume.
MetadataPool	string¦null	false	none	The drive pool on the which the volume metadata will be created.
MetadataN	integer(int64)¦null	false	none	The data fragments of the metadata.
MetadataK	integer(int64)¦null	false	none	The redundancy fragments of the metadata.
SectorSize	string¦null	false	none	The sector sizes of the volumes (type either 512B or 4KB).
StripedPools	[string]¦null	false	none	Create a striped volume by adding additional pools.
StripedMetadataPools	[string]¦null	false	none	Add additional metadata pools for the striped volume.
SnapshotCapacityInBytes	integer(int64)¦null	false	none	Snapshot capacity threshold.
GroupedVolume	string¦null	false	none	The new volume will be created in the same consistency group as this volume.
Cgid	integer(int64)¦null	false	none	Create this volume in this consistency group.
Tiers	TierElement	false	none	none

VolumeTemplateElementEdit

{
  "Volume": "string",
  "CapacityInBytes": 0,
  "Pool": "string",
  "N": 0,
  "K": 0,
  "MetadataPool": "string",
  "MetadataN": 0,
  "MetadataK": 0,
  "SectorSize": "string",
  "StripedPools": [
    "string"
  ],
  "StripedMetadataPools": [
    "string"
  ],
  "SnapshotCapacityInBytes": 0,
  "GroupedVolume": "string",
  "Cgid": 0,
  "Tiers": {
    "TierEntityIds": [
      0
    ],
    "TierPools": [
      "string"
    ],
    "TierN": [
      0
    ],
    "TierK": [
      0
    ],
    "TierSizesInBytes": [
      0
    ],
    "EvacuationThresholdsInPercentage": [
      0.1
    ],
    "LowerThresholdsInPercentage": [
      0.1
    ],
    "TierDataDegradationHistogram": [
      [
        0
      ]
    ],
    "TierMetadataDegradationHistogram": [
      [
        0
      ]
    ]
  }
}

Change the parameters of a volume within an application template.

Properties

Name	Type	Required	Restrictions	Description
Volume	string¦null	false	none	New name for the volume.
CapacityInBytes	integer(int64)¦null	false	none	The capacity of the volume.
Pool	string¦null	false	none	The drive pool on the which the volume will be created.
N	integer(int64)¦null	false	none	The data fragments of the volume.
K	integer(int64)¦null	false	none	The redundancy fragments of the volume.
MetadataPool	string¦null	false	none	The drive pool/pools on the which the volume metadata will be created.
MetadataN	integer(int64)¦null	false	none	The data fragments of the metadata.
MetadataK	integer(int64)¦null	false	none	The redundancy fragments of the metadata.
SectorSize	string¦null	false	none	The sector sizes of the volumes (type either 512B or 4KB).
StripedPools	[string]¦null	false	none	Edit the additional pools for a striped volume.
StripedMetadataPools	[string]¦null	false	none	Edit metadata pools for the striped volume.
SnapshotCapacityInBytes	integer(int64)¦null	false	none	Snapshot capacity threshold.
GroupedVolume	string¦null	false	none	The edited volume will use the same consistency group as this volume.
Cgid	integer(int64)¦null	false	none	Place this volume in this consistency group.
Tiers	TierElement	false	none	none

VolumesHealthElement

{
  "VolumesHealthInPercentage": 0.1,
  "HealthyVolumes": 0,
  "UnhealthyVolumes": 0,
  "UnhealthyStates": {
    "property1": "Ok",
    "property2": "Ok"
  }
}

Properties

Name	Type	Required	Restrictions	Description
VolumesHealthInPercentage	number(float)	false	none	none
HealthyVolumes	integer(int32)¦null	false	none	none
UnhealthyVolumes	integer(int32)¦null	false	none	none
UnhealthyStates	object¦null	false	none	none
» additionalProperties	VolumeState	false	none	none

VraidProvisioning

{
  "Name": "string",
  "FreeSpaceInPercentage": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
Name	string¦null	false	none	none
FreeSpaceInPercentage	number(double)¦null	false	none	none

WorkflowCommand

{
  "Command": "string",
  "DisplayName": "string",
  "AllowSkipping": true,
  "AllowRecurrentOperations": true
}

Properties

Name	Type	Required	Restrictions	Description
Command	string¦null	false	none	none
DisplayName	string¦null	false	none	none
AllowSkipping	boolean	false	none	none
AllowRecurrentOperations	boolean	false	none	none

WorkflowElement

{
  "Path": "string",
  "DisplayName": "string",
  "RedirectPathOnSuccess": "string",
  "TitleForChildrenSelection": "string",
  "OrderedCommands": [
    {
      "Command": "string",
      "DisplayName": "string",
      "AllowSkipping": true,
      "AllowRecurrentOperations": true
    }
  ],
  "Children": [
    {
      "Path": "string",
      "DisplayName": "string",
      "RedirectPathOnSuccess": "string",
      "TitleForChildrenSelection": "string",
      "OrderedCommands": [
        {
          "Command": "string",
          "DisplayName": "string",
          "AllowSkipping": true,
          "AllowRecurrentOperations": true
        }
      ],
      "Children": []
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Path	string¦null	false	none	none
DisplayName	string¦null	false	none	none
RedirectPathOnSuccess	string¦null	false	none	none
TitleForChildrenSelection	string¦null	false	none	none
OrderedCommands	[WorkflowCommand]¦null	false	none	none
Children	[WorkflowElement]¦null	false	none	none