hpOneView package

Subpackages

• hpOneView.image_streamer package
  • Subpackages
    • hpOneView.image_streamer.resources package
      • Submodules
      • hpOneView.image_streamer.resources.artifact_bundles module
      • hpOneView.image_streamer.resources.build_plans module
      • hpOneView.image_streamer.resources.deployment_groups module
      • hpOneView.image_streamer.resources.deployment_plans module
      • hpOneView.image_streamer.resources.golden_images module
      • hpOneView.image_streamer.resources.os_volumes module
      • hpOneView.image_streamer.resources.plan_scripts module
      • Module contents
  • Submodules
  • hpOneView.image_streamer.image_streamer_client module
  • Module contents
• hpOneView.resources package
  • Subpackages
    • hpOneView.resources.activity package
      • Submodules
      • hpOneView.resources.activity.alerts module
      • hpOneView.resources.activity.events module
      • hpOneView.resources.activity.tasks module
      • Module contents
    • hpOneView.resources.data_services package
      • Submodules
      • hpOneView.resources.data_services.metric_streaming module
      • Module contents
    • hpOneView.resources.facilities package
      • Submodules
      • hpOneView.resources.facilities.datacenters module
      • hpOneView.resources.facilities.power_devices module
      • hpOneView.resources.facilities.racks module
      • Module contents
    • hpOneView.resources.fc_sans package
      • Submodules
      • hpOneView.resources.fc_sans.endpoints module
      • hpOneView.resources.fc_sans.managed_sans module
      • hpOneView.resources.fc_sans.san_managers module
      • Module contents
    • hpOneView.resources.networking package
      • Submodules
      • hpOneView.resources.networking.connection_templates module
      • hpOneView.resources.networking.ethernet_networks module
      • hpOneView.resources.networking.fabrics module
      • hpOneView.resources.networking.fc_networks module
      • hpOneView.resources.networking.fcoe_networks module
      • hpOneView.resources.networking.interconnect_link_topologies module
      • hpOneView.resources.networking.interconnect_types module
      • hpOneView.resources.networking.interconnects module
      • hpOneView.resources.networking.internal_link_sets module
      • hpOneView.resources.networking.logical_downlinks module
      • hpOneView.resources.networking.logical_interconnect_groups module
      • hpOneView.resources.networking.logical_interconnects module
      • hpOneView.resources.networking.logical_switch_groups module
      • hpOneView.resources.networking.logical_switches module
      • hpOneView.resources.networking.network_sets module
      • hpOneView.resources.networking.sas_interconnect_types module
      • hpOneView.resources.networking.sas_interconnects module
      • hpOneView.resources.networking.sas_logical_interconnect_groups module
      • hpOneView.resources.networking.sas_logical_interconnects module
      • hpOneView.resources.networking.switch_types module
      • hpOneView.resources.networking.switches module
      • hpOneView.resources.networking.uplink_sets module
      • Module contents
    • hpOneView.resources.search package
      • Submodules
      • hpOneView.resources.search.index_resources module
      • hpOneView.resources.search.labels module
      • Module contents
    • hpOneView.resources.security package
      • Submodules
      • hpOneView.resources.security.certificate_authority module
      • hpOneView.resources.security.certificate_rabbitmq module
      • hpOneView.resources.security.login_details module
      • hpOneView.resources.security.roles module
      • hpOneView.resources.security.users module
      • Module contents
    • hpOneView.resources.servers package
      • Submodules
      • hpOneView.resources.servers.connections module
      • hpOneView.resources.servers.enclosure_groups module
      • hpOneView.resources.servers.enclosures module
      • hpOneView.resources.servers.id_pools module
      • hpOneView.resources.servers.id_pools_ipv4_ranges module
      • hpOneView.resources.servers.id_pools_ipv4_subnets module
      • hpOneView.resources.servers.id_pools_ranges module
      • hpOneView.resources.servers.logical_enclosures module
      • hpOneView.resources.servers.migratable_vc_domains module
      • hpOneView.resources.servers.server_hardware module
      • hpOneView.resources.servers.server_hardware_types module
      • hpOneView.resources.servers.server_profile_templates module
      • hpOneView.resources.servers.server_profiles module
      • Module contents
    • hpOneView.resources.settings package
      • Submodules
      • hpOneView.resources.settings.appliance_device_read_community module
      • hpOneView.resources.settings.appliance_device_snmp_v1_trap_destinations module
      • hpOneView.resources.settings.appliance_device_snmp_v3_trap_destinations module
      • hpOneView.resources.settings.appliance_device_snmp_v3_users module
      • hpOneView.resources.settings.appliance_node_information module
      • hpOneView.resources.settings.appliance_time_and_locale_configuration module
      • hpOneView.resources.settings.backups module
      • hpOneView.resources.settings.firmware_bundles module
      • hpOneView.resources.settings.firmware_drivers module
      • hpOneView.resources.settings.licenses module
      • hpOneView.resources.settings.restores module
      • hpOneView.resources.settings.scopes module
      • hpOneView.resources.settings.versions module
      • Module contents
    • hpOneView.resources.storage package
      • Submodules
      • hpOneView.resources.storage.drive_enclosures module
      • hpOneView.resources.storage.sas_logical_jbod_attachments module
      • hpOneView.resources.storage.sas_logical_jbods module
      • hpOneView.resources.storage.storage_pools module
      • hpOneView.resources.storage.storage_systems module
      • hpOneView.resources.storage.storage_volume_attachments module
      • hpOneView.resources.storage.storage_volume_templates module
      • hpOneView.resources.storage.volumes module
      • Module contents
    • hpOneView.resources.uncategorized package
      • Submodules
      • hpOneView.resources.uncategorized.os_deployment_plans module
      • hpOneView.resources.uncategorized.os_deployment_servers module
      • hpOneView.resources.uncategorized.unmanaged_devices module
      • Module contents
  • Submodules
  • hpOneView.resources.resource module
  • hpOneView.resources.task_monitor module
  • Module contents

Submodules

hpOneView.connection module

connection.py

This module maintains communication with the appliance.

class hpOneView.connection.connection(applianceIp, api_version=300, sslBundle=False, timeout=None)

Bases: object

change_initial_password(newPassword)

delete(uri, custom_headers=None)

disable_etag_validation()

Disable the concurrency control for the PUT and DELETE requests. The requests will be forced without specifying an explicit ETag. This method sets an If-Match header of “*”.

do_http(method, path, body, custom_headers=None)

download_to_stream(stream_writer, url, body=u'', method=u'GET', custom_headers=None)

enable_etag_validation()

Enable the concurrency control for the PUT and DELETE requests, in which the requests are conditionally processed only if the provided entity tag in the body matches the latest entity tag stored for the resource.

The eTag validation is enabled by default.

encode_multipart_formdata(fields, files, baseName, verbose=False)

Fields is a sequence of (name, value) elements for regular form fields. Files is a sequence of (name, filename, value) elements for data to be uploaded as files

Returns: (content_type, body) ready for httplib.HTTP instance

get(uri)

getFirstPage()

getLastPage()

getNextPage()

getPrevPage()

get_by_uri(xuri)

get_connection()

get_eula_status()

get_host()

get_session()

get_session_id()

login(cred, verbose=False)

logout(verbose=False)

make_url(path)

patch(uri, body, custom_headers=None)

post(uri, body, custom_headers=None)

post_multipart(uri, fields, files, baseName, verbose=False)

post_multipart_with_response_handling(uri, file_path, baseName)

put(uri, body, custom_headers=None)

set_eula(supportAccess=u'yes')

set_proxy(proxyHost, proxyPort)

set_session_id(session_id)

set_trusted_ssl_bundle(sslBundle)

validateVersion()

hpOneView.connection.get_member(mlist)

hpOneView.connection.get_members(mlist)

hpOneView.connection.make_eula_dict(supportAccess)

hpOneView.connection.make_initial_password_change_dict(userName, oldPassword, newPassword)

hpOneView.exceptions module

exception hpOneView.exceptions.HPOneViewException(data, error=None)

Bases: exceptions.Exception

OneView base Exception.

msg

Exception message.

Type:str

oneview_response

OneView rest response.

Type:dict

exception hpOneView.exceptions.HPOneViewInvalidResource(data, error=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Invalid Resource Exception.

msg

Exception message.

Type:str

exception hpOneView.exceptions.HPOneViewMissingUniqueIdentifiers(data, error=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Missing Unique Identifiers Exception. The exception is raised when unique identifiers are missing for the resource

msg

Exception message.

Type:str

exception hpOneView.exceptions.HPOneViewResourceNotFound(data, error=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Resource Not Found Exception. The exception is raised when an associated resource was not found.

msg

Exception message.

Type:str

exception hpOneView.exceptions.HPOneViewTaskError(msg, error_code=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Task Error Exception.

msg

Exception message.

Type:str

error_code

A code which uniquely identifies the specific error.

Type:str

exception hpOneView.exceptions.HPOneViewTimeout(data, error=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Timeout Exception.

msg

Exception message.

Type:str

exception hpOneView.exceptions.HPOneViewUnavailableMethod(data, error=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Unavailable Method Exception. The exception is raised when a method is not available for the resource class.

msg

Exception message.

Type:str

exception hpOneView.exceptions.HPOneViewUnknownType(data, error=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Unknown Type Error.

msg

Exception message.

Type:str

exception hpOneView.exceptions.HPOneViewValueError(data, error=None)

Bases: hpOneView.exceptions.HPOneViewException

OneView Value Error. The exception is raised when the data contains an inappropriate value.

msg

Exception message.

Type:str

hpOneView.exceptions.handle_exceptions(exception_type, exception_value, exception_traceback, logger=<logging.Logger object>)

hpOneView.oneview_client module

This module implements a common client for HPE OneView REST API.

class hpOneView.oneview_client.OneViewClient(config)

Bases: object

DEFAULT_API_VERSION = 300

alerts

Gets the Alerts API client.

Returns: Return type:Alerts

api_version

Gets the OneView API Version.

Returns:API Version. Return type:int

appliance_device_read_community

Gets the ApplianceDeviceReadCommunity API client.

Returns: Return type:ApplianceDeviceReadCommunity

appliance_device_snmp_v1_trap_destinations

Gets the ApplianceDeviceSNMPv1TrapDestinations API client.

Returns: Return type:ApplianceDeviceSNMPv1TrapDestinations

appliance_device_snmp_v3_trap_destinations

Gets the ApplianceDeviceSNMPv3TrapDestinations API client.

Returns: Return type:ApplianceDeviceSNMPv3TrapDestinations

appliance_device_snmp_v3_users

Gets the ApplianceDeviceSNMPv3Users API client.

Returns: Return type:ApplianceDeviceSNMPv3Users

appliance_node_information

Gets the ApplianceNodeInformation API client.

Returns: Return type:ApplianceNodeInformation

appliance_time_and_locale_configuration

Gets the ApplianceTimeAndLocaleConfiguration API client.

Returns: Return type:ApplianceTimeAndLocaleConfiguration

backups

Gets the Backup API client.

Returns: Return type:Backups

certificate_authority

Gets the Certificate Authority API client.

Returns: Return type:CertificateAuthority

certificate_rabbitmq

Gets the Certificate RabbitMQ API client.

Returns: Return type:CertificateRabbitMQ

connection

Gets the underlying HPE OneView connection used by the OneViewClient.

Returns: Return type:connection

connection_templates

Gets the ConnectionTemplates API client.

Returns: Return type:ConnectionTemplates

connections

Gets the Connections API client.

Returns: Return type:Connections

create_image_streamer_client()

Create the Image Streamer API Client.

Returns: Return type:ImageStreamerClient

datacenters

Gets the Datacenters API client.

Returns: Return type:Datacenters

drive_enclosures

Gets the Drive Enclosures API client.

Returns: Return type:DriveEnclosures

enclosure_groups

Gets the EnclosureGroups API client.

Returns: Return type:EnclosureGroups

enclosures

Gets the Enclosures API client.

Returns: Return type:Enclosures

endpoints

Gets the Endpoints API client.

Returns: Return type:Endpoints

ethernet_networks

Gets the EthernetNetworks API client.

Returns: Return type:EthernetNetworks

events

Gets the Events API client.

Returns: Return type:Events

fabrics

Gets the Fabrics API client.

Returns: Return type:Fabrics

fc_networks

Gets the FcNetworks API client.

Returns: Return type:FcNetworks

fcoe_networks

Gets the FcoeNetworks API client.

Returns: Return type:FcoeNetworks

firmware_bundles

Gets the FirmwareBundles API client.

Returns: Return type:FirmwareBundles

firmware_drivers

Gets the FirmwareDrivers API client.

Returns: Return type:FirmwareDrivers

classmethod from_environment_variables()

Construct OneViewClient using environment variables.

Allowed variables: ONEVIEWSDK_IP (required), ONEVIEWSDK_USERNAME (required), ONEVIEWSDK_PASSWORD (required), ONEVIEWSDK_AUTH_LOGIN_DOMAIN, ONEVIEWSDK_API_VERSION, ONEVIEWSDK_IMAGE_STREAMER_IP, ONEVIEWSDK_SESSIONID, ONEVIEWSDK_SSL_CERTIFICATE, ONEVIEWSDK_CONNECTION_TIMEOUT and ONEVIEWSDK_PROXY.

Returns: Return type:OneViewClient

classmethod from_json_file(file_name)

Construct OneViewClient using a json file.

Parameters:file_name – json full path. Returns: Return type:OneViewClient

id_pools

Gets the IdPools API client.

Returns: Return type:IdPools

id_pools_ipv4_ranges

Gets the IdPoolsIpv4Ranges API client.

Returns: Return type:IdPoolsIpv4Ranges

id_pools_ipv4_subnets

Gets the IdPoolsIpv4Subnets API client.

Returns: Return type:IdPoolsIpv4Subnets

id_pools_vmac_ranges

Gets the IdPoolsRanges API Client for VMAC Ranges.

Returns: Return type:IdPoolsRanges

id_pools_vsn_ranges

Gets the IdPoolsRanges API Client for VSN Ranges.

Returns: Return type:IdPoolsRanges

id_pools_vwwn_ranges

Gets the IdPoolsRanges API Client for VWWN Ranges.

Returns: Return type:IdPoolsRanges

index_resources

Gets the Index Resources API client.

Returns: Return type:IndexResources

interconnect_link_topologies

Gets the InterconnectLinkTopologies API client.

Returns: Return type:InterconnectLinkTopologies

interconnect_types

Gets the InterconnectTypes API client.

Returns: Return type:InterconnectTypes

interconnects

Gets the Interconnects API client.

Returns: Return type:Interconnects

internal_link_sets

Gets the InternalLinkSets API client.

Returns: Return type:InternalLinkSets

labels

Gets the Labels API client.

Returns: Return type:Labels

licenses

Gets all the licenses Returns: List of licenses

logical_downlinks

Gets the LogicalDownlinks API client.

Returns: Return type:LogicalDownlinks

logical_enclosures

Gets the LogicalEnclosures API client.

Returns: Return type:LogicalEnclosures

logical_interconnect_groups

Gets the LogicalInterconnectGroups API client.

Returns: Return type:LogicalInterconnectGroups

logical_interconnects

Gets the LogicalInterconnects API client.

Returns: Return type:LogicalInterconnects

logical_switch_groups

Gets the LogicalSwitchGroups API client.

Returns: Return type:LogicalSwitchGroups

logical_switches

Gets the LogicalSwitches API client.

Returns: Return type:LogicalSwitches

login_details

Gets the login details

Returns: List of login details

managed_sans

Gets the Managed SANs API client.

Returns: Return type:ManagedSANs

metric_streaming

Gets the MetricStreaming API client.

Returns: Return type:MetricStreaming

migratable_vc_domains

Gets the VC Migration Manager API client.

Returns: Return type:MigratableVcDomains

network_sets

Gets the NetworkSets API client.

Returns: Return type:NetworkSets

os_deployment_plans

Gets the Os Deployment Plans API client.

Returns: Return type:OsDeploymentPlans

os_deployment_servers

Gets the Os Deployment Servers API client.

Returns: Return type:OsDeploymentServers

power_devices

Gets the PowerDevices API client.

Returns: Return type:PowerDevices

racks

Gets the Racks API client.

Returns: Return type:Racks

restores

Gets the Restores API client.

Returns: Return type:Restores

roles

Gets the Roles API client.

Returns: Return type:Roles

san_managers

Gets the SanManagers API client.

Returns: Return type:SanManagers

sas_interconnect_types

Gets the SasInterconnectTypes API client.

Returns: Return type:SasInterconnectTypes

sas_interconnects

Gets the SAS Interconnects API client.

Returns: Return type:SasInterconnects

sas_logical_interconnect_groups

Gets the SasLogicalInterconnectGroups API client.

Returns: Return type:SasLogicalInterconnectGroups

sas_logical_interconnects

Gets the SasLogicalInterconnects API client.

Returns: Return type:SasLogicalInterconnects

sas_logical_jbod_attachments

Gets the SAS Logical JBOD Attachments client.

Returns: Return type:SasLogicalJbodAttachments

sas_logical_jbods

Gets the SAS Logical JBODs API client.

Returns: Return type:SasLogicalJbod

scopes

Gets the Scopes API client.

Returns: Return type:Scopes

server_hardware

Gets the ServerHardware API client.

Returns: Return type:ServerHardware

server_hardware_types

Gets the ServerHardwareTypes API client.

Returns: Return type:ServerHardwareTypes

server_profile_templates

Gets the ServerProfileTemplate API client.

Returns: Return type:ServerProfileTemplate

server_profiles

Gets the ServerProfiles API client.

Returns: Return type:ServerProfiles

storage_pools

Gets the StoragePools API client.

Returns: Return type:StoragePools

storage_systems

Gets the StorageSystems API client.

Returns: Return type:StorageSystems

storage_volume_attachments

Gets the StorageVolumeAttachments API client.

Returns: Return type:StorageVolumeAttachments

storage_volume_templates

Gets the StorageVolumeTemplates API client.

Returns: Return type:StorageVolumeTemplates

switch_types

Gets the SwitchTypes API client.

Returns: Return type:SwitchTypes

switches

Gets the Switches API client.

Returns: Return type:Switches

tasks

Gets the Tasks API client.

Returns: Return type:Tasks

unmanaged_devices

Gets the Unmanaged Devices API client.

Returns: Return type:UnmanagedDevices

uplink_sets

Gets the UplinkSets API client.

Returns: Return type:UplinkSets

users

Gets the Users API client.

Returns: Return type:Users

versions

Gets the Version API client.

Returns: Return type:Version

volumes

Gets the Volumes API client.

Returns: Return type:Volumes

Module contents

HPE OneView Library

hpOneView is a library for interfacing with HPE OneView Management Appliance.

hpOneView.main()