VSP One Object S Series Node API Reference

Version: 4.2.x
Audience: anonymous
Part Number: MK-HCPS023-05

Introduction to VSP One Object S Series nodes
VSP One Object S Series nodes
S11 and S31 node hardware components
S32 node hardware components
User accounts
User account credentials
Usernames
Passwords
User account properties
User roles
Considerations for working with user accounts
S Series objects
Buckets
Bucket names
Bucket owners
Considerations for working with buckets
Networking
S11 and S31 node server-module Ethernet ports
S32 node server-module Ethernet ports
Access network
Access network IP addresses
Access network properties
Management network
Management network IP addresses
Management network properties
Server interconnect network
Considerations for working with networks
Considerations for working with networks
Transport Layer Security (TLS)
S Series node identification
Licensing
Client access
Management Console configuration
Management API configuration
Data access protocol configuration
Access control list
SSL server certificates
Security settings
Ping
SSH
User account-security
Password requirements and user-account management rules
Options for password requirements
Options for user-account management rules
Common-password dictionary
SSH keys
DNS servers
Time servers
Resource load
Resource-load statistics collection
Resource-load statistics
System load
System-load statistics collection
System-load statistics
Historical system-load statistics
Event log
Alerts
Syslog logging
Configuring syslog logging
Testing syslog server connections
Internal logs
S Series OS and software maintenance
S Series node update files
Considerations for OS and software updates
S Series node hardware maintenance
S Series management API overview
What you can do with the management API
Who can use the management API
Resources and properties
Supported methods for the management API
Management API input and output format
Management API query parameters
prettyprint query parameter
Management API error response body
X-HCPS-API-VERSION request and response headers
HTTP Server response header
X-HCPS-Domain-Name response header
X-HCPS-Server-Module-Number response header
X-HCPS-ErrorMessage response header
Management API access and authentication
URLs for S Series node access through the management API
Considerations for resource URLs
Management API access using Basic Authentication
Management API access using OAuth authorization
Management API resources
Alerts resource
Beaconing resources
Bucket resources
Certificate resources
Console resources
DNS resource
Events resource
Hardware resources
Identification resources
Initial configuration resources
Irreparables resources
License resource
Log resources
Login resource
Maintenance resources
Management API resource
Metrics resources
Miscellaneous settings resource
Network resources
Power resources
Protocol resources
Security resources
SSH keys resource
Status resources
Syslog resources
Time resource
TLS resource
Update resources
User account resources
Versions resource
Management API resource details
Resource property usage
Managing resource lists
count query parameter
maxCount query parameter
marker query parameter
owner query parameter
prefix query parameter
/alerts
/alerts properties
/‍alerts query parameters
/alerts example
/buckets
/buckets properties
/buckets example
/buckets/<bucket-name>
/buckets/<bucket-name> properties
/buckets/<bucket-name> example
/buckets/<bucket-name>/irreparables
/buckets/<bucket-name>/irreparables properties
/buckets/<bucket-name>/irreparables examples
/buckets/<bucket-name>/irreparables GET example
/buckets/<bucket-name>/irreparables HEAD example
/configuration/certificates/system
/configuration/certificates/system properties
/configuration/certificates/system ‑‑form parameters
/configuration/certificates/system examples
/configuration/certificates/system GET example
/configuration/certificates/system POST example
/configuration/certificates/system/csr/generate
/configuration/certificates/system/csr/generate properties
/configuration/certificates/system/csr/generate example
/configuration/certificates/system/generate
/configuration/certificates/system/generate properties
/configuration/certificates/system/generate example
/configuration/console
/configuration/console properties
/configuration/console example
/configuration/console/message
/configuration/console/message property
/configuration/console/message example
/configuration/dns
/configuration/dns properties
/configuration/dns example
/configuration/ident
/configuration/ident properties
/configuration/ident example
/configuration/ident/console
configuration-ident-console properties
/configuration/ident/console example
/configuration/mapi
/configuration/mapi properties
/configuration/mapi example
/configuration/networks/builtin
/configuration/networks/builtin property
/configuration/networks/builtin example
/configuration/networks/builtin/access/ports
/configuration/networks/builtin/access/ports properties
/configuration/networks/builtin/access/ports query parameter
/configuration/networks/builtin/access/ports example
/configuration/networks/builtin/access/ports/<port-number>
/configuration/networks/builtin/access/ports/<port-number> properties
/‍configuration‌‌/‍networks‌‌/‍builtin‌‌/‍access‌‌/‍ports‌/‍<port-number> query parameters
/configuration/networks/builtin/access/ports/<port-number> examples
/configuration/networks/builtin/access/ports/<port-number> GET example
/configuration/networks/builtin/access/ports/<port-number> POST example
/configuration/networks/builtin/<network-name>
/configuration/networks/builtin/<network-name> properties
/configuration/networks/builtin/<network-name> example
/configuration/protocols
/configuration/protocols property
/configuration/protocols example
/configuration/protocols/hs3
/configuration/protocols/hs3 properties
/configuration/protocols/hs3 example
/configuration/security
/configuration/security properties
/configuration/security example
/configuration/security/common_passwords
/configuration/security/common_passwords request header
/configuration/security/common_passwords examples
/configuration/security/common_passwords PUT example
/configuration/security/common_passwords GET example
/configuration/security/common_passwords/dictionary_details
/configuration/security/common_passwords/dictionary_details properties
/configuration/security/common_passwords/dictionary_details example
/configuration/security/password_rules
/configuration/security/password_rules properties
/configuration/security/password_rules example
/configuration/setup
/configuration/setup properties
Validating /configuration/setup property values
/configuration/setup examples
/configuration/setup POST example
/configuration/setup GET example
/configuration/setup/status
/configuration/setup/status property
/configuration/setup/status example
/configuration/syslog
/configuration/syslog properties
/configuration/syslog example
/configuration/syslog/test/<local-facility>
/configuration/time
/configuration/time properties
/configuration/time example
/configuration/tls
/configuration/tls property
/configuration/tls example
/events
/events properties
/events query parameters
maxEvents query parameter
eventsAfter and eventsBefore query parameters
severity query parameter
major query parameter
scopes, scopeRefs, and scopeSubRefs query parameters
/events example
/hardware
/hardware properties
/hardware example
/hardware/beacon/enclosure/<enclosure-number>
/‍hardware‌/‍beacon‌/‍enclosure‌/‍<enclosure-number> query parameters
/hardware/beacon/enclosure/<enclosure-number> example
/hardware/beacon/enclosure/<enclosure-number>/iom/<io-module-id>
/hardware‌/‍beacon‌/‍enclosure‌/‍<enclosure-number>‌/‍iom‌/‍<io-module-id> query parameters
/hardware/beacon/enclosure/<enclosure-number>/iom/<io-module-id> example
/hardware/beacon/server_module/<server-module-number>
/‍hardware‌/‍beacon‌/‍server_module‌/‍<server-module-number> query parameters
/hardware/beacon/server_module/server-module-number example
/hardware/enclosures
/hardware/enclosures/<enclosure-number>
/hardware/enclosures/<enclosure-number> properties
Enclosure: alarm properties
Enclosure: current properties
Enclosure: detail properties
Enclosure: door properties
Enclosure: fan properties
Enclosure: LED properties
Enclosure: power-supply properties
Enclosure: SAS-connector properties
Enclosure: SAS-expander properties
Enclosure: service properties
Enclosure: sideplane properties
Enclosure: temperature properties
Enclosure: voltage properties
/hardware/enclosures/<enclosure-number> examples
/hardware/enclosures/<enclosure-number> S32 node base-enclosure example
/hardware/enclosures/<enclosure-number> expansion-enclosure example
/hardware/enclosures/<enclosure-number>/slots
/hardware/enclosures/<enclosure-number>/slots/<slot-number>
/hardware/enclosures/<enclosure-number>/slots/<slot-number> properties
/hardware/enclosures/<enclosure-number>/slots/<slot-number> example
/hardware/maintenance
/hardware/maintenance request body property
/hardware/maintenance response body properties
Maintenance procedure: common response body properties
Maintenance procedure: drive properties
Maintenance procedure: enclosure or slot properties
Maintenance procedure: target component list property
Maintenance procedure: target component properties
/hardware/maintenance example
/hardware/maintenance/active
/hardware/maintenance/active property
/hardware/maintenance/active example
/hardware/maintenance/history
/hardware/maintenance/history properties
/hardware/maintenance/history example
/hardware/maintenance/<procedure-id>
/hardware/maintenance/<procedure-id> properties
/hardware/maintenance/<procedure-id> example
/hardware/maintenance/<procedure-id>/cancel
/hardware/maintenance/<procedure-id>/cancel properties
/hardware/maintenance/<procedure-id>/cancel example
/hardware/maintenance/<procedure-id>/candidates
/hardware/maintenance/<procedure-id>/candidates property
/hardware/maintenance/<procedure-id>/candidates example
/hardware/maintenance/<procedure-id>/complete
/hardware/maintenance/<procedure-id>/complete properties
/hardware/maintenance/<procedure-id>/complete example
/hardware/maintenance/<procedure-id>/confirm
/hardware/maintenance/<procedure-id>/confirm request body properties
/hardware/maintenance/<procedure-id>/confirm response body properties
/hardware/maintenance/<procedure-id>/confirm example
/hardware/maintenance/<procedure-id>/done
/hardware/maintenance/<procedure-id>/done properties
/hardware/maintenance/<procedure-id>/done example
/hardware/maintenance/<procedure-id>/perform
/hardware/maintenance/<procedure-id>/perform properties
/hardware/maintenance/<procedure-id>/perform example
/hardware/maintenance/<procedure-id>/select
/hardware/maintenance/<procedure-id>/select request body properties
/hardware/maintenance/<procedure-id>/select response body properties
/hardware/maintenance/<procedure-id>/select example
/hardware/maintenance/<procedure-id>/update
/hardware/maintenance/<procedure-id>/update request body property
/hardware/maintenance/<procedure-id>/update response body properties
/hardware/maintenance/<procedure-id>/update example
/hardware/maintenance/<procedure-id>/verify
/hardware/maintenance/<procedure-id>/verify properties
/hardware/maintenance/<procedure-id>/verify example
/hardware/power/node
/hardware/power/node properties
/‍hardware‌/‍power‌/‍node query parameters
/hardware/power/node examples
/hardware/power/node GET example
/hardware/power/node POST example
/hardware/power/<server-module-number>
/hardware/power/<server-module-number> properties
/‍hardware ‌/‍power ‌/‍<server-module-number> query parameters
/hardware/power/<server-module-number> examples
/hardware/power/<server-module-number> GET example
/hardware/power/<server-module-number> POST example
/hardware/server_modules
/hardware/server_modules/<server-module-number>
/hardware/server_module/<server-module-number> properties
Server module: bonded-network-interface properties
Server module: core-hardware properties
Server module: disk properties
Server module: Ethernet-interface properties
Server module: file-system properties
Server module: IPMI properties
Server module: IPMI-sensor properties
Server module: LED properties
Server module: mirror-set properties
Server module: mirror-state property
Server module: network-interface properties
Server module: peer properties
Server module: peer-state property
Server module: SAS-card properties
Server module: SAS-controller properties
Server module: SAS-port properties
/hardware/server_modules/<server-module-number> example
/login/oauth
/login/oauth request body properties
/login/oauth response body properties
/login/oauth request and response headers
/login/oauth example
/metrics/buckets
/metrics/buckets properties
/metrics/buckets example
/metrics/gateways
/metrics/gateways properties
/metrics/gateways example
/metrics/protection
/metrics/protection property
/metrics/protection example
/metrics/resourceLoad
/metrics/resourceLoad properties
/metrics/resourceLoad example
/metrics/system
/metrics/system properties
/metrics/system example
/metrics/system/history
/metrics/system/history properties
/metrics/system/history query parameters
/metrics/system/history examples
Requesting daily values for all properties
Requesting only total, used, and available storage values
/metrics/system/history/data_points
/metrics/system/history/data_points properties
/metrics/system/history/data_points query parameters
/metrics/system/history/data_points example
/metrics/systemLoad
/metrics/systemLoad properties
System load: CPU-load properties
System load: I/O-threads-percent-used properties
System load: I/O-threads-total properties
System load: I/O-threads-used properties
System load: I/O-wait properties
System load: memory-percent-used properties
System load: memory-total properties
System load: memory-used properties
System load: network-bandwidth-percent-used properties
System load: network-bandwidth-total properties
System load: network-bandwidth-used properties
System load: OS-uptime properties
System load: S3-error-percent properties
System load: S3-latency properties
System load: S3-success-percent properties
System load: S3-throughput-bytes properties
System load: S3-throughput-operations properties
/metrics/systemLoad example
/metrics/systemLoad/history
/metrics/systemLoad/history properties
/metrics/systemLoad/history query parameters
/metrics/systemLoad/history examples
Requesting only network bandwidth statistics
Omitting S3 compatible API statistics and server-module-specific statistics
/system/database/update
/system/database/update property
/system/database/update example
/system/irreparables
/system/irreparables properties
/system/irreparables examples
/system/irreparables GET example
/system/irreparables HEAD example
/system/license
/system/license properties
/system/license example
/system/logs/cancel
/system/logs/download
/system/logs/mark
/‍system‌/logs‌/mark query parameter
/system/logs/mark example
/system/logs/prepare
/‍system‌‌/‍logs‌‌/‍prepare query parameters
/system/logs/prepare example
/system/logs/status
/system/logs/status properties
/system/logs/status example
/system/misc/settings/network/management/monitor
/system/misc/settings/network/management/monitor property
/‍system‌‌/‍misc‌‌/‍settings‌‌/‍network‌‌/‍management‌‌/‍monitor query parameter
/system/misc/settings/network/management/monitor examples
/system/misc/settings/network/management/monitor GET example
/system/misc/settings/network/management/monitor POST example
/system/ssh_keys
/system/ssh_keys properties
/system/ssh_keys examples
/system/ssh_keys PUT example
/system/ssh_keys GET example with exclusive SSH keys active
/system/ssh_keys GET example with default SSH keys active
/system/status/full
/system/status/full properties
/system/status/full example
/system/status/health
/system/status/health properties
/system/status/health example
/system/status/notice
/system/status/notice properties
/system/status/notice example
/system/update/apply
/system/update/history
/system/update/history properties
/system/update/history example
/system/update/manifest
/system/update/manifest properties
/system/update/manifest example
/system/update/prechecks
/system/update/prechecks properties
/system/update/prechecks examples
/system/update/prechecks example with successful prechecks
/system/update/prechecks example with a failed precheck
/system/update/progress
/system/update/progress properties
/system/update/progress example
/system/update/reset
/system/update/restart
/system/update/status
/system/update/status property
/system/update/status example
/system/update/upload/software
/system/update/upload/software properties
/system/update/upload/software example
/user_accounts
/user_accounts properties
/user_accounts examples
/user_accounts PUT example
/user_accounts GET example
/user_accounts/<username>
/user_accounts/<username> properties
/user_accounts/<username> example
/user_accounts/<username>/access_key
/user_accounts/<username>/access_key property
/user_accounts/<username>/access_key example
/user_accounts/<username>/access_key/generate
/user_accounts/<username>/access_key/generate properties
/user_accounts/<username>/access_key/generate example
/user_accounts/<username>/password
/user_accounts/<username>/password properties
/user_accounts/<username>/password example
/versions
/versions GET properties
/versions POST query parameter and properties
/versions examples
/versions GET example
/versions POST example
Management API procedures
Downloading the internal logs
Considerations for downloading the internal logs
Performing a log download operation
Updating the S Series software
Considerations for software updates with the management API
Performing a software upgrade
Performing a hardware maintenance procedure
Maintenance procedure steps
Replacing a data drive using the management API
Management API HTTP status codes

Back to home page