Skip to content

Latest commit

 

History

History
545 lines (535 loc) · 106 KB

endpoints-support.md

File metadata and controls

545 lines (535 loc) · 106 KB

Legend

Item Meaning
Endpoint implemented in the Ruby SDK for this API version 🎉
✖️ Endpoint considered as 'out-of-scope' for the Ruby SDK
Endpoint not available for this API Version

Notes

  • If an endpoint is not marked as implemented for a specific API, it can still be used in compatibility mode for the supported API versions.
  • If an example is not working on a supported API version, verify the HPE OneView REST API Documentation for the API version being used, since the expected attributes for that resource might have changed.
  • For DELETE endpoints which remove multiple resources at once using a filter, that functionality is considered as implemented so long as a DELETE by {id} is implemented for that resource. The user may then call the method find_by to filter the resources and use a looping function to remove all matching results, similarly to the following example:
OneviewSDK::Datacenter.find_by(@client, width: 11000).map(&:remove)

HPE OneView

Endpoints Verb V300 V500 V600 V800 V1000 V1200 V1600
Alerts
/rest/alerts GET
/rest/alerts DELETE ✖️ ✖️ ✖️
/rest/alerts/{id} GET
/rest/alerts/{id} PUT
/rest/alerts/{id} DELETE
/rest/alerts/AlertChangeLog/{id} DELETE
Connection Templates
/rest/connection-templates GET
/rest/connection-templates/defaultConnectionTemplate GET
/rest/connection-templates/{id} GET
/rest/connection-templates/{id} PUT
Datacenters
/rest/datacenters GET
/rest/datacenters POST
/rest/datacenters DELETE
/rest/datacenters/{id} GET
/rest/datacenters/{id} PUT
/rest/datacenters/{id} DELETE
/rest/datacenters/{id}/visualContent GET
Drive Enclosures
/rest/drive-enclosures GET
/rest/drive-enclosures/{id} GET
/rest/drive-enclosures/{id} PATCH
/rest/drive-enclosures/{id}/port-map GET
/rest/drive-enclosures/{id}/refreshState PUT
Enclosure Groups
/rest/enclosure-groups GET
/rest/enclosure-groups POST
/rest/enclosure-groups/{id} GET
/rest/enclosure-groups/{id} PUT
/rest/enclosure-groups/{id} DELETE
/rest/enclosure-groups/{id}/script GET
/rest/enclosure-groups/{id}/script PUT
Enclosures
/rest/enclosures GET
/rest/enclosures POST
/rest/enclosures/{id} GET
/rest/enclosures/{id} PATCH
/rest/enclosures/{id} DELETE
/rest/enclosures/{id}/configuration PUT
/rest/enclosures/{id}/environmentalConfiguration GET
/rest/enclosures/{id}/environmentalConfiguration PUT
/rest/enclosures/{id}/refreshState PUT
/rest/enclosures/{id}/script GET
/rest/enclosures/{id}/sso GET
/rest/enclosures/{id}/utilization GET
/rest/enclosures/{id}/https/certificaterequest POST
/rest/enclosures/{id}/https/certificaterequest GET
/rest/enclosures/{id}/https/certificaterequest PUT
Ethernet Networks
/rest/ethernet-networks GET
/rest/ethernet-networks POST
/rest/ethernet-networks/bulk POST
/rest/ethernet-networks/{id} GET
/rest/ethernet-networks/{id} PUT
/rest/ethernet-networks/{id} PATCH
/rest/ethernet-networks/{id} DELETE
/rest/ethernet-networks/{id}/associatedProfiles GET
/rest/ethernet-networks/{id}/associatedUplinkGroups GET
Events
/rest/events GET
/rest/events POST
/rest/events/{id} GET
Fabrics
/rest/fabrics GET
/rest/fabrics/{id} GET
/rest/fabrics/{id}/reserved-vlan-range GET
/rest/fabrics/{id}/reserved-vlan-range PUT
FC Networks
/rest/fc-networks GET
/rest/fc-networks POST
/rest/fc-networks/{id} GET
/rest/fc-networks/{id} PATCH
/rest/fc-networks/{id} PUT
/rest/fc-networks/{id} DELETE
FCoE Networks
/rest/fcoe-networks GET
/rest/fcoe-networks POST
/rest/fcoe-networks/{id} GET
/rest/fcoe-networks/{id} PATCH
/rest/fcoe-networks/{id} PUT
/rest/fcoe-networks/{id} DELETE
Firmware Bundles
/rest/firmware-bundles POST
Firmware Drivers
/rest/firmware-drivers GET
/rest/firmware-drivers POST ✖️ ✖️ ✖️ ✖️
/rest/firmware-drivers/{id} GET
/rest/firmware-drivers/{id} DELETE ✖️ ✖️ ✖️ ✖️
Hypervisor Managers
/rest/hypervisor-managers GET
/rest/hypervisor-managers POST
/rest/hypervisor-managers/{id} GET
/rest/hypervisor-managers/{id} PUT
/rest/hypervisor-managers/{id} DELETE
Hypervisor Cluster Profiles
/rest/hypervisor-cluster-profiles GET
/rest/hypervisor-cluster-profiles POST
/rest/hypervisor-cluster-profiles/{id} GET
/rest/hypervisor-cluster-profiles/{id} PUT
/rest/hypervisor-cluster-profiles/{id}/compliance-preview GET
/rest/hypervisor-cluster-profiles/{id} DELETE
ID Pools
/rest/id-pools/{poolType} GET
/rest/id-pools/{poolType} PUT
/rest/id-pools/{poolType}/allocator PUT
/rest/id-pools/{poolType}/checkrangeavailability GET
/rest/id-pools/{poolType}/collector PUT
/rest/id-pools/{poolType}/generate GET
/rest/id-pools/{poolType}/validate GET
/rest/id-pools/{poolType}/validate PUT
Interconnect Link Topologies
/rest/interconnect-link-topologies GET
/rest/interconnect-link-topologies/{id} GET
Interconnect Types
/rest/interconnect-types GET
/rest/interconnect-types/{id} GET
Interconnects
/rest/interconnects GET
/rest/interconnects/{id} GET
/rest/interconnects/{id} PATCH
/rest/interconnects/{id}/configuration PUT
/rest/interconnects/{id}/pluggableModuleInformation GET
/rest/interconnects/{id}/ports GET ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/interconnects/{id}/ports PUT
/rest/interconnects/{id}/ports/{portId:.+} GET ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/interconnects/{id}/resetportprotection PUT
/rest/interconnects/{id}/statistics GET
/rest/interconnects/{id}/statistics/{portName:.+} GET
/rest/interconnects/{id}/statistics/{portName:.+}/subport/{subportNum} GET
/rest/interconnects/{id}/update-ports PUT
/rest/interconnects/{id}/nameServers GET
Internal Link Sets
/rest/internal-link-sets GET
/rest/internal-link-sets/{id} GET
Logical Downlinks
/rest/logical-downlinks GET
/rest/logical-downlinks/{id} GET
/rest/logical-downlinks/withoutEthernet GET
/rest/logical-downlinks/{id}/withoutEthernet GET
Logical Enclosures
/rest/logical-enclosures GET
/rest/logical-enclosures POST
/rest/logical-enclosures/{id} GET
/rest/logical-enclosures/{id} PUT
/rest/logical-enclosures/{id} PATCH
/rest/logical-enclosures/{id} DELETE
/rest/logical-enclosures/{id}/configuration PUT
/rest/logical-enclosures/{id}/script GET
/rest/logical-enclosures/{id}/script PUT
/rest/logical-enclosures/{id}/support-dumps POST
/rest/logical-enclosures/{id}/updateFromGroup PUT
Logical Interconnect Groups
/rest/logical-interconnect-groups GET
/rest/logical-interconnect-groups POST
/rest/logical-interconnect-groups/defaultSettings GET
/rest/logical-interconnect-groups/{id} GET
/rest/logical-interconnect-groups/{id} PUT
/rest/logical-interconnect-groups/{id} PATCH
/rest/logical-interconnect-groups/{id} DELETE
/rest/logical-interconnect-groups/{id}/settings GET
Logical Interconnects
/rest/logical-interconnects GET
/rest/logical-interconnects/locations/interconnects POST
/rest/logical-interconnects/locations/interconnects DELETE
/rest/logical-interconnects/{id} GET
/rest/logical-interconnects/{id}/compliance PUT
/rest/logical-interconnects/{id}/ethernetSettings GET ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/ethernetSettings PUT
/rest/logical-interconnects/{id}/firmware GET
/rest/logical-interconnects/{id}/firmware PUT
/rest/logical-interconnects/{id}/forwarding-information-base GET ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/forwarding-information-base POST ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/forwarding-information-base/{dumpFileName}.{suffix} GET ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/internalNetworks PUT
/rest/logical-interconnects/{id}/internalVlans GET
/rest/logical-interconnects/{id}/qos-aggregated-configuration GET
/rest/logical-interconnects/{id}/qos-aggregated-configuration PUT
/rest/logical-interconnects/{id}/settings PUT
/rest/logical-interconnects/{id}/snmp-configuration GET
/rest/logical-interconnects/{id}/snmp-configuration PUT
/rest/logical-interconnects/{id}/support-dumps POST ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id}/unassignedUplinkPortsForPortMonitor GET
/rest/logical-interconnects/{id}/configuration PUT
/rest/logical-interconnects/{id}/port-monitor GET
/rest/logical-interconnects/{id}/port-monitor PUT
/rest/logical-interconnects/{id}/telemetry-configurations/{tcId} GET
/rest/logical-interconnects/{id}/telemetry-configurations/{tcId} PUT
/rest/logical-interconnects/compliance PUT ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/logical-interconnects/{id} PATCH
Logical Switch Groups
/rest/logical-switch-groups GET
/rest/logical-switch-groups POST
/rest/logical-switch-groups/{id} GET
/rest/logical-switch-groups/{id} PATCH
/rest/logical-switch-groups/{id} PUT
/rest/logical-switch-groups/{id} DELETE
Logical Switches
/rest/logical-switches GET
/rest/logical-switches POST
/rest/logical-switches/{id} GET
/rest/logical-switches/{id} PATCH
/rest/logical-switches/{id} PUT
/rest/logical-switches/{id} DELETE
/rest/logical-switches/{id}/refresh PUT
Login Details
/rest/logindetails GET
Managed SANs
/rest/fc-sans/managed-sans GET
/rest/fc-sans/managed-sans/{id} GET
/rest/fc-sans/managed-sans/{id} PUT
/rest/fc-sans/managed-sans/{id}/endpoints GET
/rest/fc-sans/managed-sans/{id}/endpoints POST ✖️ ✖️ ✖️
/rest/fc-sans/managed-sans/{id}/issues POST
/rest/fc-sans/managed-sans/WWN+ GET
Network Sets
/rest/network-sets GET
/rest/network-sets POST
/rest/network-sets/withoutEthernet GET
/rest/network-sets/{id} GET
/rest/network-sets/{id} PUT
/rest/network-sets/{id} DELETE
/rest/network-sets/{id}/withoutEthernet GET
/rest/network-sets/{id} PATCH
OS Deployment Plans
/rest/os-deployment-plans/ GET
/rest/os-deployment-plans/{id} GET
Power Devices
/rest/power-devices GET
/rest/power-devices POST
/rest/power-devices DELETE
/rest/power-devices/discover POST
/rest/power-devices/{id} GET
/rest/power-devices/{id} PUT
/rest/power-devices/{id} DELETE
/rest/power-devices/{id}/powerState GET
/rest/power-devices/{id}/powerState PUT
/rest/power-devices/{id}/refreshState PUT
/rest/power-devices/{id}/synchronous DELETE ✖️ ✖️
/rest/power-devices/{id}/uidState GET
/rest/power-devices/{id}/uidState PUT
/rest/power-devices/{id}/utilization GET
Providers
/rest/fc-sans/providers GET
/rest/fc-sans/providers/{id} GET
/rest/fc-sans/providers/{id}/device-managers POST
Racks
/rest/racks GET
/rest/racks POST
/rest/racks DELETE
/rest/racks/{id} GET
/rest/racks/{id} PUT
/rest/racks/{id} DELETE
/rest/racks/{id}/deviceTopology GET
SAN Managers
/rest/fc-sans/device-managers GET
/rest/fc-sans/device-managers/{id} GET
/rest/fc-sans/device-managers/{id} PUT
/rest/fc-sans/device-managers/{id} DELETE
/rest/fc-sans/providers/{id}/device-managers POST
SAS Interconnect Types
/rest/sas-interconnect-types GET
/rest/sas-interconnect-types/{id} GET
SAS Interconnects
/rest/sas-interconnects GET
/rest/sas-interconnects/{id} GET
/rest/sas-interconnects/{id} PATCH
/rest/sas-interconnects/{id}/refreshState PUT
SAS Logical Interconnect Groups
/rest/sas-logical-interconnect-groups POST
/rest/sas-logical-interconnect-groups GET
/rest/sas-logical-interconnect-groups/{id} GET
/rest/sas-logical-interconnect-groups/{id} PUT
/rest/sas-logical-interconnect-groups/{id} DELETE
SAS Logical Interconnects
/rest/sas-logical-interconnects GET
/rest/sas-logical-interconnects/{id} GET
/rest/sas-logical-interconnects/{id}/firmware GET
/rest/sas-logical-interconnects/{id}/firmware PUT
/rest/sas-logical-interconnects/compliance PUT
/rest/sas-logical-interconnects/{id}/compliance PUT
/rest/sas-logical-interconnects/{lsId}/configuration PUT
/rest/sas-logical-interconnects/{id}/replaceDriveEnclosure POST
SAS Logical JBOD Attachments
/rest/sas-logical-jbod-attachments GET
/rest/sas-logical-jbod-attachments/{id} GET
SAS Logical JBODs
/rest/sas-logical-jbods GET
/rest/sas-logical-jbods/{id} GET
/rest/sas-logical-jbods/{id}/drives GET
Scopes
/rest/scopes POST
/rest/scopes GET
/rest/scopes/{id} GET
/rest/scopes/{id} PUT
/rest/scopes/{id} PATCH
/rest/scopes/{id} DELETE
/rest/scopes/{id}/resource-assignments PATCH
/rest/scopes/resources/{resource_uri} GET
/rest/scopes/resources/{resource_uri} PUT
/rest/scopes/resources/{resource_uri} PATCH
Server Certificate
/rest/certificates/https/remote/{address} GET
/rest/certificates/servers POST
/rest/certificates/servers/{aliasName} GET
/rest/certificates/servers/{aliasName} PUT
/rest/certificates/servers/{aliasName} DELETE
Server Hardware
/rest/server-hardware GET
/rest/server-hardware POST
/rest/server-hardware/{id} GET
/rest/server-hardware/{id} DELETE
/rest/server-hardware/{id}/bios GET
/rest/server-hardware/{id}/environmentalConfiguration GET
/rest/server-hardware/{id}/environmentalConfiguration PUT ✖️ ✖️ ✖️ ✖️ ✖️ ✖️ ✖️
/rest/server-hardware/{id}/iloSsoUrl GET
/rest/server-hardware/{id}/javaRemoteConsoleUrl GET
/rest/server-hardware/{id}/mpFirmwareVersion PUT
/rest/server-hardware/{id}/physicalServerHardware GET
/rest/server-hardware/{id}/powerState PUT
/rest/server-hardware/{id}/refreshState PUT
/rest/server-hardware/{id}/remoteConsoleUrl GET
/rest/server-hardware/{id}/utilization GET
/rest/server-hardware/{id} PATCH
/rest/server-hardware/*/firmware GET
/rest/server-hardware/{id}/firmware GET
/rest/server-hardware/discovery POST
Server Hardware Types
/rest/server-hardware-types GET
/rest/server-hardware-types/{id} GET
/rest/server-hardware-types/{id} PUT
/rest/server-hardware-types/{id} DELETE
Server Profile Templates
/rest/server-profile-templates GET
/rest/server-profile-templates POST
/rest/server-profile-templates/{id} GET
/rest/server-profile-templates/{id} PUT
/rest/server-profile-templates/{id} DELETE
/rest/server-profile-templates/{id}/new-profile GET
/rest/server-profile-templates/{id}/transformation GET
/rest/server-profile-templates/available-networks GET
Server Profiles
/rest/server-profiles GET
/rest/server-profiles POST
/rest/server-profiles DELETE
/rest/server-profiles/available-networks GET
/rest/server-profiles/available-servers GET
/rest/server-profiles/available-storage-system GET
/rest/server-profiles/available-storage-systems GET
/rest/server-profiles/available-targets GET
/rest/server-profiles/profile-ports GET
/rest/server-profiles/{id} GET
/rest/server-profiles/{id} PUT
/rest/server-profiles/{id} DELETE
/rest/server-profiles/{id} PATCH
/rest/server-profiles/{id}/compliance-preview GET
/rest/server-profiles/{id}/new-profile-template GET
/rest/server-profiles/{id}/messages GET
/rest/server-profiles/{id}/transformation GET
Storage Pools
/rest/storage-pools GET
/rest/storage-pools POST
/rest/storage-pools/reachable-storage-pools GET
/rest/storage-pools/{id} GET
/rest/storage-pools/{id} PUT
/rest/storage-pools/{id} DELETE
Storage Systems
/rest/storage-systems GET
/rest/storage-systems POST
/rest/storage-systems/host-types GET
/rest/storage-systems/{arrayId}/storage-pools GET
/rest/storage-systems/{id} GET
/rest/storage-systems/{id} PUT
/rest/storage-systems/{id} DELETE
/rest/storage-systems/{id}/managedPorts GET
/rest/storage-systems/{id}/managedPorts/{portId} GET
/rest/storage-systems/{id}/reachable-ports GET
/rest/storage-systems/{id}/templates GET
Storage Volume Attachments
/rest/storage-volume-attachments GET
/rest/storage-volume-attachments/{id} GET
/rest/storage-volume-attachments/repair GET
/rest/storage-volume-attachments/repair POST
/rest/storage-volume-attachments/{attachmentId}/paths GET
/rest/storage-volume-attachments/{attachmentId)/paths/{id} GET
Storage Volume Templates
/rest/storage-volume-templates GET
/rest/storage-volume-templates POST
/rest/storage-volume-templates/connectable-volume-templates GET
/rest/storage-volume-templates/reachable-volume-templates GET
/rest/storage-volume-templates/{id} GET
/rest/storage-volume-templates/{id} PUT
/rest/storage-volume-templates/{id} DELETE
/rest/storage-volume-templates/{id}/compatible-systems GET
Switch Types
/rest/switch-types GET
/rest/switch-types/{id} GET
Switches
/rest/switches GET
/rest/switches/{id} GET
/rest/switches/{id} PATCH
/rest/switches/{id} DELETE
/rest/switches/{id}/environmentalConfiguration GET
/rest/switches/{id}/statistics GET
/rest/switches/{id}/statistics/{portName:.+} GET
/rest/switches/{id}/update-ports PUT
Tasks
/rest/tasks GET
/rest/tasks/{id} GET
Unmanaged Devices
/rest/unmanaged-devices GET
/rest/unmanaged-devices POST
/rest/unmanaged-devices DELETE
/rest/unmanaged-devices/{id} GET
/rest/unmanaged-devices/{id} PUT
/rest/unmanaged-devices/{id} DELETE
/rest/unmanaged-devices/{id}/environmentalConfiguration GET
Uplink Sets
/rest/uplink-sets GET
/rest/uplink-sets POST
/rest/uplink-sets/{id} GET
/rest/uplink-sets/{id} PUT
/rest/uplink-sets/{id} DELETE
Users
/rest/users GET
/rest/users POST
/rest/users POST
/rest/users PUT
/rest/users DELETE
/rest/users/administrator/resetPassword PUT ✖️ ✖️
/rest/users/changePassword POST ✖️ ✖️
/rest/users/role/{userName} GET
/rest/users/roles DELETE
/rest/users/roles/users/{role} GET
/rest/users/validateLoginName/{userName} POST
/rest/users/validateUserName/{fullName} POST
/rest/users/{userName} GET
/rest/users/{userName} DELETE
/rest/users/{userName}/roles POST
/rest/users/{userName}/roles PUT
Version
/rest/version GET
Volumes
/rest/storage-volumes GET
/rest/storage-volumes POST
/rest/storage-volumes/attachable-volumes GET
/rest/storage-volumes/from-existing POST
/rest/storage-volumes/from-snapshot POST
/rest/storage-volumes/repair GET
/rest/storage-volumes/repair POST
/rest/storage-volumes/{id} GET
/rest/storage-volumes/{id} PUT
/rest/storage-volumes/{id} DELETE
/rest/storage-volumes/{id}/snapshots GET
/rest/storage-volumes/{id}/snapshots POST
/rest/storage-volumes/{id}/snapshots/{snapshotId} GET
/rest/storage-volumes/{id}/snapshots/{snapshotId} DELETE

HPE Synergy Image Streamer

Endpoints Verb V300 V500 V600 V800 V1000 V1020 V1600
Artifacts Bundle
/rest/artifact-bundles GET
/rest/artifact-bundles POST(create)
/rest/artifact-bundles POST(upload)
/rest/artifact-bundles/backups GET
/rest/artifact-bundles/backups POST(create)
/rest/artifact-bundles/backups/archive POST(upload)
/rest/artifact-bundles/backups/archive/{id} GET
/rest/artifact-bundles/backups/{id} GET
/rest/artifact-bundles/backups/{id} PUT
/rest/artifact-bundles/download/{id} GET
/rest/artifact-bundles/{id} GET
/rest/artifact-bundles/{id} PUT(extract)
/rest/artifact-bundles/{id} PUT(update attr)
/rest/artifact-bundles/{id} DELETE
/rest/artifact-bundles/{id}/stopArtifactCreate PUT
Deployment Groups
/rest/deployment-groups GET
/rest/deployment-groups/{id} GET
Deployment Plans
/rest/deployment-plans POST
/rest/deployment-plans GET
/rest/deployment-plans/{id} GET
/rest/deployment-plans/{id} PUT
/rest/deployment-plans/{id} DELETE
/rest/deployment-plans/{id}/osdp GET
/rest/deployment-plans/{id}/usedby GET
Golden Images
/rest/golden-images POST(create)
/rest/golden-images POST(upload)
/rest/golden-images GET
/rest/golden-images/{id} GET
/rest/golden-images/archive/{id} GET
/rest/golden-images/download/{id} GET
/rest/golden-images/{id} PUT
/rest/golden-images/{id} DELETE
OS Build Plan
/rest/build-plans POST
/rest/build-plans GET
/rest/build-plans/{id} GET
/rest/build-plans/{id} PUT
/rest/build-plans/{id} DELETE
OS Volumes
/rest/os-volumes GET
/rest/os-volumes/{id} GET
/rest/os-volumes/archive/{id} GET
/rest/os-volumes/{id}/storage GET
Plan Scripts
/rest/plan-scripts POST
/rest/plan-scripts/differences/{id} POST
/rest/plan-scripts GET
/rest/plan-scripts/{id} GET
/rest/plan-scripts/{id} PUT
/rest/plan-scripts/{id} DELETE
/rest/plan-scripts/{id}/usedby/readonly GET