Contents

home

HPE OneView REST API scripting help
Where to find HPE OneView documentation
Enable off-appliance browsing of UI help and REST API help
Understanding the security features of HPE OneView
Securing the appliance
Best practices for maintaining a secure appliance
Creating a login session
Authentication for appliance access
Controlling access for authorized users
Specifying user accounts and roles
Mapping of SSO roles for iLO and OA
Mapping appliance interactions with iLO, OA, and iPDU
Protecting credentials
Understanding the audit log
Appliance access over SSL
Managing certificates from a browser
Self-signed certificate
Using a certificate authority
Nonbrowser clients
Ports required for HPE OneView
Controlling access to the appliance console
Enable or disable authorized services access
Restricting console access
Algorithms for securing the appliance
Files you can download from the appliance
Using a message bus to send data to subscribers
About accessing HPE OneView message buses
Using the State-Change Message Bus (SCMB)
Connect to the SCMB
Set up a queue to connect to the HPE OneView SCMB exchange
JSON structure of message received from the SCMB
Example to connect and subscribe to SCMB using .NET C#
Example to connect and subscribe to SCMB using Java
Examples to connect and subscribe to SCMB using Python
Installation
Pika
AMQP
Re-create the AMQP client certificate
Using the Metric Streaming Message Bus (MSMB)
Connect to the MSMB
Set up a queue to connect to the HPE OneView MSMB exchange
JSON structure of message received from the MSMB
Example to connect and subscribe to MSMB using .NET C#
Example to connect and subscribe to MSMB using Java
Examples to connect and subscribe to MSMB using Python
Installation
Pika
AMQP
Re-create the AMQP client certificate
Learning about REST APIs
Start working with REST APIs
Log in to the appliance using REST APIs
URI format
Resource model format
Resource operations
Asynchronous versus synchronous operations
REST API version and backward compatibility
Return codes
Querying resources and pagination using common REST API parameters
Task resource
Error handling
Error message format
Concurrency control using etags
Developer tools in a web browser
PowerShell and Python code sample libraries
REST API reference
What can I do with HPE OneView REST APIs?
Quick Start: Initial configuration using REST APIs
Appliance
About backing up the appliance
About restoring the appliance
Backup the appliance
Configure the appliance
Accept the End User License Agreement (EULA)
Change the default administrator password
Configure the network
Update the SNMP read community string
Create a certificate signing request
Create a self-signed certificate
Create a support dump for authorized technical support
Enable or disable authorized support access
Import a certificate
Read the public key
Restore the appliance from a backup file
Update the appliance
Update the public key
Upload a backup file to the appliance
Activity
About activities
Assign an owner to an alert
Download audit logs
Filter alerts by health and status
Read alerts for a physical resource type
Read the status of a task
Update an alert
Activity notification
About email notification of alert messages
Configure the appliance to send email notification of alerts
Add an email recipient and filter pair
Edit an email recipient and filter pair
Delete an email recipient and filter
Enable or disable email notification of alerts
Send test email
Addresses and Identifiers
About ID pools
Create an automatically generated ID range for virtual MAC addresses, WWNs, or serial numbers
Create a custom ID range for virtual MAC addresses, virtual WWNs, or virtual serial numbers
Read active ID pools and their properties
Update the allocated IDs in a range for virtual MAC addresses
Update the IDs returned in a range for virtual MAC addresses
Best practices
Best practices for monitoring health
Best practices for backing up an appliance
Best practices for restoring an appliance
Data Centers
About data centers
Create a data center
Create a data center layout
Update a data center
Delete a data center
Data services
About data services
About metric streaming
About log forwarding to a remote syslog server
Enable metric streaming
Fetch metric streaming capability
Fetch metric streaming configuration
Update metric streaming configuration
Using remoteSyslog
Fetch remoteSyslog configuration
Update remoteSyslog configuration
Enclosures
About enclosures
About c7000 enclosures
About managed c7000 enclosures
Before adding an enclosure for management
About monitored c7000 enclosures
About migrating c7000 enclosures managed by other management systems
About offline or in-service migration
About migrating partially stacked domains
About VCM settings that will not be migrated
Before migrating c7000 enclosures
About c7000 migration and firmware
About blocking issues during migration
About unassigned VCM server profile connections during migration
About migration acknowledgments
VCM configuration backup acknowledgment
Resource modification acknowledgment
Redundant hardware and software configuration acknowledgment for in-service migration
BIOS acknowledgment for in-service migration
SR-IOV acknowledgment for in-service migration
Server profile acknowledgment
About unmanaged and unsupported c7000 enclosures
Connectivity and synchronization with HPE OneView
Add an enclosure to manage its content
Add a c7000 enclosure to monitor the hardware
Edit an enclosure
Delete a c7000 enclosure from management
Migrate a c7000 VCM enclosure using REST API
Prerequisites
Migrating a VCM enclosure using REST APIs
Perform post-migration tasks
Resolve compatibility issues
Move a monitored c7000 enclosure to managed status
Prepare a VCEM enclosure for migration into HPE OneView
Refresh the connection between an enclosure and the appliance
Replace a c7000 enclosure OA and midplane
Enclosure Groups
About enclosure groups
Enclosure groups and logical interconnect groups
Create an enclosure group
Update an enclosure group
Prerequisites
Updating an enclosure group using REST APIs
Delete an enclosure group
Fabrics
About fabrics
Read a fabric
Firmware
About firmware bundles
About unsupported firmware
About updating firmware
About managing firmware manually
Delete a firmware bundle from the firmware repository
Install a firmware bundle using a server profile
Read the firmware repository for firmware bundles
Update enclosure firmware
Upload a firmware bundle
Upload a hotfix
Update logical interconnect firmware
Update the interconnect firmware for HPE Virtual Connect Fibre Channel interconnects
Index
Read resource information published to the index
Read associated resource information published to the index
Read resource tree information published to the index
Interconnects
About interconnects
About managed and monitored interconnects
About unmanaged and unsupported interconnects
FIP snooping
Connectivity and synchronization with the appliance
Read interconnect statistics
Reapply interconnect configuration
Labels
About labels
Add labels to a resource model
Read labels
Add or delete individual labels for a specific resource model
Delete all labels for a specific resource model
Licensing
About licensing
License types
Server hardware licenses
EULA
About HPE OneView Advanced licensing for managing server hardware
Server blade licensing at the enclosure level
About rack mount server licensing
About HPE OneView Standard licensing for monitoring server hardware
Purchasing or obtaining licenses
Server hardware licenses
License delivery
License key format
Licensing and utilization statistics
Licensing scenarios
License reporting
Add a license key to the appliance license pool
Delete a license key
View all licenses
View license status
View server hardware without an assigned license
Logical Enclosures
About logical enclosures
About inconsistent logical enclosures
About updating firmware from a logical enclosure
Update the firmware in a logical enclosure
Update enclosures in the logical enclosure from the enclosure group
Prerequisites
Updating enclosures in the logical enclosure from the group using REST APIs
Configure an enclosure with an OA configuration script
About OA configuration scripts
Extract a script from a configured OA
Copy an OA configuration script
View or download OA command documentation
Disallowed OA commands
Sample OA configuration script
Download a logical enclosure support dump
Logical Interconnects
About logical interconnects
About uplink sets
About internal networks
About stacking links and stacking health
Creating or deleting a logical interconnect
About firmware associated with a logical interconnect
About updating firmware for logical interconnects
About activating firmware options
About active/active and active/standby configurations
About active/standby configurations
About active/active configurations
Requirements for an active/active configuration
Sample active/active configuration for single logical interconnect group
About loop protection
About pause flood protection
About SNMP settings
About the Virtual Connect FlexFabric–20/40 F8 interconnect module
Create an uplink set
Create and download a logical interconnect MAC address table file
Enable or disable LLDP tagging using REST APIs
Enable or disable enhanced TLV support using REST APIs
Find noncompliant logical interconnects
Read a logical interconnect MAC address table
Read the internal networks in a logical interconnect
Reapply a logical interconnect group to bring a logical interconnect into compliance
Set up logical interconnect port monitoring
Update internal networks on a logical interconnect
Update logical interconnect SNMP settings
Update a logical interconnect Link Aggregation Control Protocol (LACP) timer
Update logical interconnect settings
Configure Quality of Service settings for a logical interconnect
Logical Interconnect Groups
About logical interconnect groups
About multiple logical interconnect groups in an enclosure group
When to create a logical interconnect group
About copying a logical interconnect group
About uplink sets in a logical interconnect group
About Link Layer Discovery Protocol (LLDP) tagging
About enhanced type-length-value (TLV) structure
Enhanced TLV values
About Quality of Service for network traffic
Create a logical interconnect group
Update a logical interconnect group
Update logical interconnect group SNMP settings
Enable or disable LLDP tagging using REST APIs
Prerequisites
Enabling LLDP tagging using REST APIs
Disabling LLDP tagging using REST APIs
Enable or disable enhanced TLV support using REST APIs
Prerequisites
Enabling enhanced TLV support using REST APIs
Disabling enhanced TLV support using REST APIs
Configure Quality of Service settings for a logical interconnect group
Prerequisites
Configuring Quality of Service settings for a logical interconnect group using REST APIs
Logical Switches
About logical switches
Managed logical switches
Monitored logical switches
Logical switch configuration guidelines
Create a logical switch
Edit a logical switch
Update a logical switch from group
Change a logical switch operational mode
Refresh a logical switch
Delete a logical switch
Logical Switch Groups
About logical switch groups
Create a logical switch group
Edit a logical switch group
Delete a logical switch group
Networks
About networks
About Fibre Channel networks
Fibre Channel network types
Fabric-attach Fibre Channel networks
Direct-attach Fibre Channel networks
About Fibre Channel over Ethernet (FCoE) networks
About Ethernet networks
About tagged Ethernet networks
About untagged Ethernet networks
About tunnel Ethernet networks
About Smart Link
Data center switch port requirements
Create an Ethernet network
Create multiple Ethernet networks using a single POST operation
Create a Fibre Channel network
Create an FCoE network
Update a connection template
Quick Start: Add an active/active network configuration
Adding an active/active network configuration for single or multiple logical interconnect groups
Quick Start: Migrate from an active/standby to an active/active network configuration
Migrating from an active/standby to an active/active configuration
Network Sets
About network sets
Create a network set
Create or delete a network in a network set
Read a network set
Update a network set
Delete a network set
Power Delivery Devices
About power delivery devices
Add an iPDU
Resolve connectivity issues between an iPDU and the appliance
Change the locator light state of a power delivery device to on or off
Control power to a power delivery device outlet
Add a non-iPDU power delivery device
Read a power device
Read the power utilization of a power device
Update a power delivery device
Update enclosure capacity settings
Update server hardware capacity settings
Delete a power delivery device
Racks
About racks
Changing a rack name
Add a rack
Read a rack
Read the power configuration of a rack
Update a rack
Delete a rack
Reports
About reports
Save a report
Remote Support
About remote support
About channel partners
About data collection
Register for remote support
Update remote support settings
Add channel partners
Delete a channel partner
Add a contact
Delete a contact
Register with the portal
Delete portal registration
Collect remote support data
Add a default site
Update site information
Delete site
SAN Managers
About SAN managers
About zone sets
Configuring SAN managers to be managed by HPE OneView
Add a SAN manager
Update a SAN manager
SANs
About SANs
About SAN zoning
View managed SANs
Scopes
About scopes
Create a scope
Change scope resource assignments
Delete a scope
List all scopes
List information about a specific scope
Modify a scope definition
Server Hardware
About server hardware
Server hardware management features
About unsupported server hardware
Add a server blade to an enclosure
Assign administrators to fix server hardware issues
Create a rack server
Delete a rack server
Delete a server blade from management
Identify server hardware that needs administrative attention
Power on or power off server hardware
Reassign the server profile to a server blade previously removed from an enclosure
Read a rack server
Read unsupported server hardware
Refresh the connection between server hardware and the appliance
Remove a server blade from an enclosure
Update firmware for specific server hardware
Server Hardware Types
About server hardware types
Read server hardware types
Update a server hardware type
Server Profiles
About server profiles
Capturing best-practice configurations
About editing a server profile
About moving a server profile
Working with server profiles to control remove-and-replace behavior
About assigning a server profile to an empty device bay
About server profile connections
About server profile connections and changing server hardware types
About server profiles and local storage
Logical drives and unique identifiers
About RAID level and controller
RAID levels and number of physical drives
About local storage and integrated storage controllers
About attaching SAN volumes to a server profile
About server profile consistency validation
Create a server profile
Create an unassigned server profile to use as a template
Create a server profile with user-specified IDs
Attach an existing volume to a server profile
Attach a new volume to a server profile
Copy an unassigned server profile
Assign an unassigned server profile
Unassign a server profile
Read a server profile
Update a server profile
Delete a server profile
Server Profile Templates
About server profile templates
About creating a server profile template
About editing a server profile template
Create a server profile template
Create server profile from a server profile template
Copy a server profile template
Edit a server profile template
Delete a server profile template
Storage Pools
About storage pools
Add a storage pool
Remove a storage pool
Storage Systems
About storage systems
About HPE 3PAR StoreServ Storage systems
Add a storage system
Storage Volumes
About volumes
Add an external storage volume
Create a storage volume
Update a storage volume
Delete a storage volume
Storage Volume Templates
About volume templates
Create a storage volume template
Read a storage volume template
Update a storage volume template
Delete a storage volume template
Switches
About top-of-rack switches
Retrieve switch data
Refresh a switch
Remove a switch
Unmanaged Devices
About unmanaged devices
Create an unmanaged device
Read an unmanaged device
Update an unmanaged device
Users and Groups
About user accounts
About user roles
Action privileges for user roles
Create a user with local authentication
Update a local user account
Update a local user password
Delete a local user account
Add an authentication login domain
Assign roles to an enterprise group
Change the default authentication login domain
Delete an authentication login domain
Reset the administrator password
Enable or disable local logins
Utilization
Read utilization for a specific enclosure
Read utilization for specific server hardware
Read utilization for a specific power delivery device
Troubleshooting the appliance
Troubleshooting appliance backup and restore
Resolving HTTP errors
Recover from an unexpected appliance shutdown
Support and other resources
Accessing Hewlett Packard Enterprise Support
Accessing updates
Websites
Customer self repair
Documentation feedback