hpeOneView.resources.fc_sans package

Submodules

hpeOneView.resources.fc_sans.endpoints module

class hpeOneView.resources.fc_sans.endpoints.Endpoints(con)[source]

Bases: object

Endpoints API client.

URI = '/rest/fc-sans/endpoints'
get_all(start=0, count=-1, query='', sort='')[source]

Retrieves the list of endpoints known by the appliance.

Parameters

  • start – The first item to return, using 0-based indexing. If not specified, the default is 0 - start with the first available item.

  • count – The number of resources to return. A count of -1 requests all items. The actual number of items in the response may differ from the requested count if the sum of start and count exceed the total number of items.

  • query – A general query string to narrow the list of resources returned. The default is no query - all resources are returned.

  • sort – The sort order of the returned data set. By default, the sort order is based on create time with the oldest entry first.

Returns

The endpoints known by the appliance.

Return type

list

hpeOneView.resources.fc_sans.managed_sans module

class hpeOneView.resources.fc_sans.managed_sans.ManagedSANs(connection, data=None)[source]

Bases: Resource

Managed SANs API client.

URI = '/rest/fc-sans/managed-sans'
create()[source]

Create method is not available

create_endpoints_csv_file(**kwargs)
create_issues_report(**kwargs)
delete()[source]

Delete method is not available

get_all(start=0, count=-1, query='', sort='')[source]

Retrieves the list of registered Managed SANs

Parameters

  • start – The first item to return, using 0-based indexing. If not specified, the default is 0 - start with the first available item.

  • count – The number of resources to return. A count of -1 requests all items. The actual number of items in the response may differ from the requested count if the sum of start and count exceed the total number of items.

  • query – A general query string to narrow the list of resources returned. The default is no query - all resources are returned.

  • sort – The sort order of the returned data set. By default, the sort order is based on create time with the oldest entry first.

Returns

A list of Managed SANs

Return type

list

get_by_name(name)[source]

Gets a Managed SAN by name.

Parameters

name – Name of the Managed SAN

Returns

Managed SAN.

Return type

dict

get_endpoints(**kwargs)
get_wwn(wwn)[source]

Retrieves a list of associations between provided WWNs and the SANs (if any) on which they reside.

Note

This method is available for API version 300 or later.

Parameters

wwn (str) – The WWN that may be associated with the SAN.

Returns

Associations between provided WWNs and the SANs

Return type

list

hpeOneView.resources.fc_sans.san_managers module

class hpeOneView.resources.fc_sans.san_managers.SanManagers(connection, data=None)[source]

Bases: Resource

SAN Managers API client.

URI = '/rest/fc-sans/device-managers'
get_all(start=0, count=-1, filter='', sort='', query='')[source]

Retrieves the list of registered SAN Managers. :param start: The first item to return, using 0-based indexing.

If not specified, the default is 0 - start with the first available item.

Parameters

  • count – The number of resources to return. A count of -1 requests all items. The actual number of items in the response may differ from the requested count if the sum of start and count exceed the total number of items.

  • filter (list or str) – A general filter/query string to narrow the list of items returned. The default is no filter; all resources are returned.

  • query – A general query string to narrow the list of resources returned. The default is no query - all resources are returned.

  • sort – The sort order of the returned data set. By default, the sort order is based on create time with the oldest entry first.

Returns

A list of SAN managers.

Return type

list

get_by_name(name)[source]

Gets a SAN Manager by name.

Parameters

name – Name of the SAN Manager

Returns

SAN Manager.

remove(force=False, timeout=-1)[source]

Removes the SAN Manager from OneView.

Parameters

  • force (bool) – If set to true, the operation completes despite any problems with network connectivity or errors on the resource itself. The default is false.

  • timeout – Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in OneView; it just stops waiting for its completion.

Returns

Details of associated resource.

Return type

dict

update(resource, id_or_uri)[source]

Updates a registered Device Manager.

Parameters

  • resource (dict) – Object to update.

  • id_or_uri – Can be either the Device manager ID or URI.

Returns

The device manager resource.

Return type

dict

hpeOneView.resources.fc_sans.san_providers module

class hpeOneView.resources.fc_sans.san_providers.SanProviders(connection, data=None)[source]

Bases: Resource

SAN Managers API client.

URI = '/rest/fc-sans/providers'
add(resource, provider_uri_or_id, timeout=-1)[source]

Adds a Device Manager under the specified provider.

Parameters

  • resource (dict) – Object to add.

  • provider_uri_or_id – ID or URI of provider.

  • timeout – Timeout in seconds. Wait for task completion by default. The timeout does not abort the operation in OneView, just stop waiting for its completion.

Returns

Added SAN Manager.

Return type

dict

get_default_connection_info(provider_name)[source]

Gets default connection info for a specific provider.

Parameters

provider_name – Name of the provider.

Returns

Default connection information.

Return type

dict

get_provider_uri(provider_display_name)[source]

Gets uri for a specific provider.

Parameters

provider_display_name – Display name of the provider.

Returns

uri

Module contents