hpOneView.resources.fc_sans package

Submodules

hpOneView.resources.fc_sans.endpoints module

class hpOneView.resources.fc_sans.endpoints.Endpoints(con)

Bases: object

Endpoints API client.

URI = u'/rest/fc-sans/endpoints'

get_all(start=0, count=-1, query=u'', sort=u'')

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

hpOneView.resources.fc_sans.managed_sans module

class hpOneView.resources.fc_sans.managed_sans.ManagedSANs(connection, data=None)

Bases: hpOneView.resources.resource.Resource

Managed SANs API client.

URI = u'/rest/fc-sans/managed-sans'

create()

Create method is not available

create_endpoints_csv_file = <functools.partial object>

create_issues_report = <functools.partial object>

delete()

Delete method is not available

get_all(start=0, count=-1, query=u'', sort=u'')

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)

Gets a Managed SAN by name.

Parameters:name – Name of the Managed SAN Returns:Managed SAN. Return type:dict

get_endpoints = <functools.partial object>

get_wwn(wwn)

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

hpOneView.resources.fc_sans.san_managers module

class hpOneView.resources.fc_sans.san_managers.SanManagers(con)

Bases: object

SAN Managers API client.

PROVIDER_URI = u'/rest/fc-sans/providers'

URI = u'/rest/fc-sans/device-managers'

add(resource, provider_uri_or_id, timeout=-1)

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(id_or_uri)

Retrieves a single registered SAN Manager by ID or URI.

Parameters:id_or_uri – Can be either the SAN Manager resource ID or URI. Returns:The SAN Manager resource. Return type:dict

get_all(start=0, count=-1, query=u'', sort=u'')

Retrieves the list of registered SAN Managers.

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 SAN managers.

Return type:

list

get_by_name(name)

Gets a SAN Manager by name.

Parameters:name – Name of the SAN Manager Returns:SAN Manager. Return type:dict

get_by_provider_display_name(provider_display_name)

Gets a SAN Manager by provider display name.

Parameters:provider_display_name – Name of the Provider Display Name Returns:SAN Manager. Return type:dict

get_default_connection_info(provider_name)

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)

Gets uri for a specific provider.

Parameters:provider_display_name – Display name of the provider. Returns:uri

remove(resource, timeout=-1)

Removes a registered SAN Manager.

Parameters:

• resource (dict) – Object to delete.
• 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:

Indicates if the resource was successfully removed.

Return type:

bool

update(resource, id_or_uri)

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

Module contents