Skip to content

Latest commit

 

History

History
343 lines (336 loc) · 124 KB

endpoints-support.md

File metadata and controls

343 lines (336 loc) · 124 KB

Legend

Item Meaning
Endpoint implemented in the Puppet SDK for this API version 🎉
✖️ Endpoint considered as 'out-of-scope' for the Puppet 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.

HPE OneView

Endpoints Verb V200 V300 V500 V600 V800 V1000 V1200 V1600 V1800 V2000 V2200 V2400 V2600 V2800 V3000
Connection Templates
/rest/connection-templates GET
/rest/connection-templates/defaultConnectionTemplate GET
/rest/connection-templates/{id} GET
/rest/connection-templates/{id} 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
/rest/ethernet-networks/bulk-delete POST
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
/rest/fc-networks/bulk-delete POST
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
/rest/fcoe-networks/bulk-delete POST
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
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
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}/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}/nameServers 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 Interconnects
/rest/logical-interconnects GET
/rest/logical-interconnects/bulk-inconsistency-validation POST
/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}/igmpSettings GET
/rest/logical-interconnects/{id}/igmpSettings PUT
/rest/logical-interconnects/{id}/portFlapSettings 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 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
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
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
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
/rest/server-hardware/{id}/localStorage GET
/rest/server-hardware/{id}/localStorageV2 GET
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
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
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 V2000 V2010 V2020
Artifacts Bundle
/rest/artifact-bundles POST(create)
/rest/artifact-bundles POST(upload)
/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
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