Virtual Storage Platform One SDS Block and SDS Cloud CLI Reference

Version: 1.19.x
Audience: anonymous
Part Number: MK-24VSP1SDS006-08

Overview
System overview
Basic system configuration
Prerequisites
Execution conditions
Command format
Master command options
Environment Variables
Option parameters
Roles
Return values
Output format
Command execution example
Audit log management
audit_log_setting_show
audit_log_setting_set
audit_log_create_file
audit_log_download
Common information management
version_show
job_list
job_show
Compute node connection management
chap_user_list
chap_user_create
chap_user_delete
chap_user_show
chap_user_set
port_auth_setting_show
port_auth_setting_set
port_auth_setting_chap_user_list
port_auth_setting_chap_user_create
port_auth_setting_chap_user_delete
port_auth_setting_chap_user_show
port_list
port_show
port_set
port_switch_protocol
Compute node management
server_list
server_create
server_delete
server_show
server_set
hba_list
hba_create
hba_delete
hba_show
path_list
path_create
path_delete
path_show
volume_server_connection_list
volume_server_connection_create
volume_server_connection_delete
volume_server_connection_show
volume_server_connection_release_connections
Drive management
drive_list
drive_show
drive_control_locator_led
drive_remove
Event log management
event_log_setting_show
event_log_setting_set
event_log_list
event_log_show
smtp_server_root_certificate_import
smtp_server_root_certificate_download
Failure analysis
dump_file_create_file
dump_file_download
dump_file_delete
dump_status_list
dump_status_show
ticket_create
ticket_revoke_all
Login message management
login_message_show
login_message_set
High resolution monitor
control_port_detail_performance_list
control_port_detail_performance_show
drive_detail_performance_list
drive_detail_performance_show
internode_port_detail_performance_list
internode_port_detail_performance_show
journal_detail_performance_list
journal_detail_performance_show
port_detail_performance_list
port_detail_performance_show
storage_node_detail_performance_list
storage_node_detail_performance_show
volume_detail_performance_list
volume_detail_performance_show
License management
license_setting_show
license_setting_set
license_list
license_install
license_uninstall
license_show
Low resolution monitor
control_port_performance_list
control_port_performance_show
drive_performance_list
drive_performance_show
internode_port_performance_list
internode_port_performance_show
journal_performance_list
journal_performance_show
pool_capacity_performance_list
pool_capacity_performance_show
pool_performance_list
pool_performance_show
port_performance_list
port_performance_show
storage_performance_show
storage_node_performance_list
storage_node_performance_show
volume_capacity_performance_list
volume_capacity_performance_show
volume_performance_list
volume_performance_show
Power management
storage_shutdown
Secure communication management
server_certificate_import
web_server_access_setting_show
web_server_access_setting_set
Session management
session_list
session_create
session_delete
session_show
Snapshot management
master_volume_show
snapshot_volume_list
volume_create_snapshot
volume_delete_snapshot
volume_restore_snapshot
Software update
storage_stop_software_update
storage_update_software
storage_upload_software_update_file
storage_software_update_file_show
Storage cluster management
fault_domain_list
fault_domain_show
health_status_show
snmp_setting_set
protection_domain_list
protection_domain_show
protection_domain_set
protection_domain_resume_drive_data_relocation
protection_domain_suspend_drive_data_relocation
snmp_setting_show
storage_show
bmc_root_certificate_delete
bmc_root_certificate_import
bmc_root_certificate_download
spare_node_list
spare_node_create
spare_node_delete
spare_node_show
spare_node_set
storage_write_back_mode_with_cache_protection_set
storage_metadata_drive_write_reduction_mode_set
Storage controller management
storage_controller_list
storage_controller_show
storage_controller_configure
Storage node management
storage_stop_removing_storage_node
storage_node_list
storage_node_delete
storage_node_show
storage_node_block_for_maintenance
storage_node_recover
storage_node_replace
storage_node_replace_with_configuration_file
storage_add_node
storage_node_bmc_access_setting_list
storage_node_bmc_access_setting_show
storage_node_bmc_access_setting_set
Storage pool management
pool_list
pool_show
pool_set
pool_expand
estimated_capacity_for_specified_configuration_show
estimated_capacity_for_updated_configuration_show
storage_node_capacity_setting_list
storage_node_capacity_setting_show
storage_node_capacity_setting_set
capacity_setting_list
capacity_setting_set
single_volume_overprovisioning_setting_list
single_volume_overprovisioning_setting_set_all
single_volume_overprovisioning_setting_show
single_volume_overprovisioning_setting_set
System management
storage_master_node_primary_flag_show
control_port_list
control_port_show
internode_port_list
internode_port_show
storage_resume_suppressed_start_processing
storage_auto_recovery_setting_show
storage_auto_recovery_setting_set
storage_network_setting_show
storage_node_network_setting_list
storage_node_network_setting_show
storage_time_setting_show
system_requirements_file_import
configuration_file_create
configuration_file_download
storage_configuration_summary_show
configuration_backup_file_create
configuration_parameter_setting_mode (Bare metal)
configuration_parameter_setting_mode_status
storage_restore_from_configuration_backup_file
storage_restoration_status_show
set_stationary_point
configuration_modify
User role management
external_auth_server_root_certificate_import
external_auth_server_root_certificate_download
external_auth_server_setting_show
external_auth_server_setting_set
external_auth_server_setting_verify_connectivity
user_auth_setting_show
user_auth_setting_set
user_group_list
user_group_create
user_group_delete
user_group_show
user_group_set
user_list
user_create
user_delete
user_show
user_set
user_add_user_group
user_delete_user_group
user_password_set
Virtual Private Storage (VPS) management
vps_list
vps_create
vps_delete
vps_show
vps_set
Volume management
volume_list
volume_create
volume_delete
volume_show
volume_set
volume_expand
volume_discard_zero_page
volume_stop_discard_zero_page
Encryption management
encryption_key_list
encryption_key_create
encryption_key_delete
encryption_key_show
encryption_key_count_show
encryption_setting_show
encryption_setting_set
encryption_unit_pool_set
Remote iSCSI port management
remote_iscsi_port_list
remote_iscsi_port_create
remote_iscsi_port_delete
remote_iscsi_port_show
Remote path group management
remotepath_group_list
remotepath_group_create
remotepath_group_delete
remotepath_group_show
remotepath_group_set
remote_path_add
remote_path_delete
Journal management
journal_list
journal_create
journal_delete
journal_show
journal_set
journal_expand
journal_shrink
Response definitions
HTTP status code 200
HTTP status code 202
HTTP status code 204
HTTP status code 400
HTTP status code 401
HTTP status code 403
HTTP status code 404
HTTP status code 406
HTTP status code 409
HTTP status code 411
HTTP status code 412
HTTP status code 413
HTTP status code 415
HTTP status code 417
HTTP status code 431
HTTP status code 500
HTTP status code 502
HTTP status code 503
HTTP status code 504
Schema definitions
allowlistSettingOfWebServerAccessSetting: object
approvedChapUser: object
auditLogSetting: object
capacitiesExcludingSystemDataOfStorageController: object
capacityBalancingSetting: object
capacitySettings: object
chapUser: object
chapUserSummary: object
controlPort: object
controlPortPerformance: object
controlPortPerformanceListResponse: object
controlPortPerformanceListResponseData: object
cpuPerformance: object
cpuSummaryPerformance: object
createdSession: object
dataReductionEffectOfVolume: object
dataReductionEffectOfVolumeSummary: object
drive: object
drivePerformance: object
drivePerformanceListResponse: object
drivePerformanceListResponseData: object
dumpStatus: object
dumpStatusList: object
emailReportSettingOfEventLogSetting: object
encryptionKey: object
encryptionKeyCounts: object
encryptionSettings: object
errorInformationOfLdapServerConnectionVerification: object
errorResponse: object
estimatedCapacityForSpecifiedConfiguration: object
estimatedCapacityForUpdatedConfiguration: object
eventLog: object
eventLogSetting: object
externalAuthServerConnectionVerification: object
externalAuthServerSetting: object
faultDomain: object
faultDomainSummary: object
fcPortPerformance: object
fcTarget: object
fcTargetPortPerformance: object
hba: object
healthStatus: object
internodePort: object
internodePortPerformance: object
internodePortPerformanceListResponse: object
internodePortPerformanceListResponseData: object
ipv4InformationOfControlPort: object
ipv4InformationOfInternodePort: object
ipv4InformationOfNvmeTcpTarget: object
ipv4InformationOfUniversal: object
ipv4RouteOfStorageNodeNetworkSetting: object
ipv6InformationOfNvmeTcpTarget: object
ipv6InformationOfUniversal: object
iscsiInitiatorPortPerformance: object
iscsiPortPerformance: object
iscsiTargetPortPerformance: object
iscsiUniversal: object
isnsServerOfIscsiUniversal: object
job: object
journal: object
journalPerformance: object
journalPerformanceListResponse: object
journalPerformanceListResponseData: object
ldapServerConnectionVerification: object
ldapSettingOfExternalAuthServerSetting: object
license: object
licenseSetting: object
lockoutSettingOfUserAuthSetting: object
loginMessage: object
masterVolume: object
memoryPerformance: object
mirrorUnit: object
nvmeTcpPortPerformance: object
nvmeTcpTarget: object
nvmeTcpTargetPortPerformance: object
passwordAgeSettingOfUserAuthSetting: object
passwordComplexitySettingOfUserAuthSetting: object
path: object
pathOfServer: object
pinInformationOfStorageController: object
pool: object
poolCapacity: object
poolCapacityListResponseData: object
poolPerformance: object
poolPerformanceListResponseData: object
port: object
portAuthSetting: object
portPerformance: object
portPerformanceListResponse: object
portPerformanceListResponseData: object
portSummary: object
primaryServerOfLdapServerConnectionVerificationError: object
primaryServerOfLdapServerConnectionVerificationResult: object
protectionDomain: object
protectionDomainSummary: object
rebuildableResourcesOfPool: object
rebuildableResourcesOfStorageNode: object
remoteIscsiPort: object
remotePathGroup: object
remotePathGroupSummary: object
request: object
requestAuthenticationSettingOfSnmpSetting: object
resourceStatusOfHealthStatus: object
resultOfLdapServerConnectionVerification: object
savingEffectOfPool: object
savingEffectOfStorage: object
secondaryServerOfLdapServerConnectionVerificationError: object
secondaryServerOfLdapServerConnectionVerificationResult: object
sendingTrapSettingOfSnmpSetting: object
server: object
serverSummary: object
session: object
sessionSettingOfUserAuthSetting: object
singleVolumeOverprovisioningSetting: object
smtpSettingOfEventLogSetting: object
snapshotVolume: object
snmpSetting: object
snmpv2cSettingOfRequestAuthenticationSetting: object
snmpv2cSettingOfSendingTrapSetting: object
softwareUpdateFile: object
spareNode: object
spareNodeList: object
storage: object
storageAutoRecoverySetting: object
storageClusterCapacitySetting: object
storageConfigurationSummary: object
storageController: object
storageControllerCapacitySetting: object
storageMasterNodePrimaryFlag: object
storageNetworkSetting: object
storageNode: object
storageNodeBmcAccessSetting: object
storageNodeBmcAccessSettingList: object
storageNodeCapacitySetting: object
storageNodeNetworkSetting: object
storageNodePerformance: object
storageNodePerformanceListResponse: object
storageNodePerformanceListResponseData: object
storagePerformance: object
storagePerformanceListResponseData: object
storageTimeSetting: object
syslogForwardingSettingOfAuditLogSetting: object
syslogForwardingSettingOfEventLogSetting: object
syslogServerSettingOfAuditLogSetting: object
syslogServerSettingOfEventLogSetting: object
systemGroupInformationOfSnmpSetting: object
teamingOfControlPort: object
teamingOfInternodePort: object
ticket: object
user: object
userAuthSetting: object
userGroup: object
userGroupSummary: object
userPrivileges: object
version: object
virtualPrivateStorage: object
virtualPrivateStorageList: object
virtualPrivateStorageSummaryInformation: object
volume: object
volumeCapacity: object
volumeCapacityListResponseData: object
volumePath: object
volumePerformance: object
volumePerformanceListResponse: object
volumePerformanceListResponseData: object
volumeSummary: object
warningThresholdSettingOfLicenseSetting: object
webServerAccessSetting: object
whitelistSettingOfWebServerAccessSetting: object

Back to home page