Skip to content

Latest commit

 

History

History
4017 lines (3075 loc) · 168 KB

VolumeSetsApi.md

File metadata and controls

4017 lines (3075 loc) · 168 KB

greenlake_data_services.VolumeSetsApi

All URIs are relative to https://eu1.data.cloud.hpe.com

Method HTTP request Description
device_type1_edit_proximity_settings PUT /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id}/proximity-settings Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from Primera / Alletra 9K
device_type1_get_proximity_settings GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id}/proximity-settings Get hosts and proximity details identified by application set {id} for Primera / Alletra 9K identified by {systemId}
device_type1_get_replication_partner_volumes_by_app_set_id GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{appsetId}/replication-partners/{replicationPartnerId}/volumes Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for Primera / Alletra 9K
device_type1_get_replication_partners_by_app_set_id GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{appsetId}/replication-partners Get details of Primera / Alletra 9K replication partners identified by {systemId} and {appsetId}
device_type1_snapsets_get_by_id GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{appsetId}/snapsets/{snapsetId} Get details of snapsets identified by {snapsetId} for Applicationset identified by {appsetId} for Primera / Alletra 9K
device_type1_volume_set_capacity_statistics_get_by_id GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id}/capacity-statistics Get capacity details for an applicationset identified by appsetUid
device_type1_volume_set_export POST /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{appsetId}/export Export applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}
device_type1_volume_set_snapshot_get_by_id DELETE /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{appsetId}/snapsets/{snapsetId} Remove Primera / Alletra 9K snapset in system identified by {snapsetId}
device_type1_volume_set_snapshots_list GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id}/snapsets Get snapshot details of volume sets identified by {id} for Primera / Alletra 9K
device_type1_volume_set_unexport POST /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{appsetId}/un-export Unexport applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}
device_type1_volume_set_volumes_list GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{appsetId}/volumes Get volumes for an applicationset identified by appsetUid
device_type1_volume_sets_create POST /api/v1/storage-systems/device-type1/{systemId}/applicationsets Create Application Set for a storage system Primera / Alletra 9K
device_type1_volume_sets_delete_by_id DELETE /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id} Remove applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}
device_type1_volume_sets_edit_by_id PUT /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id} Edit applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}
device_type1_volume_sets_get_by_id GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id} Get applicationset details for an applicationset identified by appsetUid
device_type1_volume_sets_list GET /api/v1/storage-systems/device-type1/{systemId}/applicationsets Get all applicationset details for Primera / Alletra 9K
device_type1_volume_sets_snapshot_create POST /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id}/snapsets Create snapshot for application set identified by {id}
device_type1action_on_volume_sets POST /api/v1/storage-systems/device-type1/{systemId}/applicationsets/{id}/remote-protection/actions Actions on volume set identified by {id} and {systemId} from Primera / Alletra 9K
device_type2_action_on_snapshot_collection POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/snapshot-collections/update Perform offline/online action on snapshot collections of Nimble / Alletra 6K and associated with volume collection {volumeCollectionId} in the system identified by {systemId}
device_type2_action_on_volume_collection POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/actions/handover Perform handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
device_type2_action_on_volume_collection_id POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/actions/demote Perform demote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
device_type2_actionon_volume_collection POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/actions/abort-handover Perform abort handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
device_type2_add_volumes_to_volume_collections POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/actions/add-volumes Add volumes to Nimble / Alletra 6K volumes collection in system identified by {systemId}
device_type2_create_snapshot_collections POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/snapshot-collections Create Nimble / Alletra 6K snapshot collection in system identified by {systemId}
device_type2_edit_volume_collection_by_id PUT /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId} Edit details of Nimble / Alletra 6K Volume-collections identified by {volumeCollectionId}
device_type2_get_all_folders GET /api/v1/storage-systems/device-type2/{systemId}/folders Get all folders details by Nimble / Alletra 6K
device_type2_get_all_volume_collections GET /api/v1/storage-systems/device-type2/{systemId}/volume-collections Get all volume-collections details by Nimble / Alletra 6K
device_type2_get_snapshot_collections_by_id GET /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/snapshot-collections/{snapshotCollectionId} Get details of snapshot collection of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId} by {snapshotId}
device_type2_get_snapshots_by_volume_collection_id GET /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/snapshot-collections Get all snapshot collections' details of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId}
device_type2_get_volume_collection_by_id GET /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId} Get details of Nimble / Alletra 6K volume-collections identified by {volumeCollectionId}
device_type2_promote_action_on_volume_collection POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/actions/promote Perform promote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
device_type2_remove_snap_shot_collection POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/snapshot-collections/remove Remove multiple snapshot collections identified by {volumeCollectionId} from Nimble / Alletra 6K
device_type2_remove_volume_collection_by_id DELETE /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId} Remove Volume-collection identified by {volumeCollectionId} from Nimble / Alletra 6K
device_type2_remove_volumes_from_volume_collection POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections/{volumeCollectionId}/actions/remove-volumes Remove volumes from Nimble / Alletra 6K volumes collection in system identified by {systemId}
device_type2_volume_collection_create POST /api/v1/storage-systems/device-type2/{systemId}/volume-collections Create Nimble / Alletra 6K volume collection in system identified by {systemId}
volumeset_get_by_id GET /api/v1/volume-sets/{id} Get volume-set identified by id
volumeset_get_byvolumeset_id GET /api/v1/volume-sets/{id}/volumes Get volumes identified by volume set id
volumeset_list GET /api/v1/volume-sets Get all volume-sets
volumeset_list_for_system_by_system_id GET /api/v1/storage-systems/{systemId}/volume-sets Get all volume-sets for a systemId
volumeset_system_get_by_id GET /api/v1/storage-systems/{systemId}/volume-sets/{id} Get volume-set identified by id

device_type1_edit_proximity_settings

TaskResponse device_type1_edit_proximity_settings(system_id, id, change_proximity_settings_input)

Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from Primera / Alletra 9K

Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.change_proximity_settings_input import ChangeProximitySettingsInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    change_proximity_settings_input = ChangeProximitySettingsInput(
        hosts=[
            HostProximityInput(
                host_name="tstHost",
                proximity="PRIMARY",
            ),
        ],
    ) # ChangeProximitySettingsInput | 

    # example passing only required values which don't have defaults set
    try:
        # Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from Primera / Alletra 9K
        api_response = api_instance.device_type1_edit_proximity_settings(system_id, id, change_proximity_settings_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_edit_proximity_settings: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str UID of the applicationset
change_proximity_settings_input ChangeProximitySettingsInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_get_proximity_settings

VolumeSetProximitySettings device_type1_get_proximity_settings(id, system_id)

Get hosts and proximity details identified by application set {id} for Primera / Alletra 9K identified by {systemId}

Get hosts and proximity details identified by application set {id} for Primera / Alletra 9K identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.volume_set_proximity_settings import VolumeSetProximitySettings
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | ID of the applicationset
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system

    # example passing only required values which don't have defaults set
    try:
        # Get hosts and proximity details identified by application set {id} for Primera / Alletra 9K identified by {systemId}
        api_response = api_instance.device_type1_get_proximity_settings(id, system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_get_proximity_settings: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of the applicationset
system_id str systemId of the device-type1 storage system

Return type

VolumeSetProximitySettings

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_get_replication_partner_volumes_by_app_set_id

ReplicationPartnerVolumesSummaryList device_type1_get_replication_partner_volumes_by_app_set_id(system_id, appset_id, replication_partner_id)

Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for Primera / Alletra 9K

Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.replication_partner_volumes_summary_list import ReplicationPartnerVolumesSummaryList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    appset_id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    replication_partner_id = "aedec7d11d02f73611a6ff992c256bdb" # str | id of device-type1 replication partner
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for Primera / Alletra 9K
        api_response = api_instance.device_type1_get_replication_partner_volumes_by_app_set_id(system_id, appset_id, replication_partner_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_get_replication_partner_volumes_by_app_set_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for Primera / Alletra 9K
        api_response = api_instance.device_type1_get_replication_partner_volumes_by_app_set_id(system_id, appset_id, replication_partner_id, limit=limit, offset=offset)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_get_replication_partner_volumes_by_app_set_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
appset_id str UID of the applicationset
replication_partner_id str id of device-type1 replication partner
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]

Return type

ReplicationPartnerVolumesSummaryList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_get_replication_partners_by_app_set_id

ReplicationPartnersSummaryList device_type1_get_replication_partners_by_app_set_id(system_id, appset_id)

Get details of Primera / Alletra 9K replication partners identified by {systemId} and {appsetId}

Get details of Primera / Alletra 9K replication partners identified by {systemId} and {appsetId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.replication_partners_summary_list import ReplicationPartnersSummaryList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    appset_id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset

    # example passing only required values which don't have defaults set
    try:
        # Get details of Primera / Alletra 9K replication partners identified by {systemId} and {appsetId}
        api_response = api_instance.device_type1_get_replication_partners_by_app_set_id(system_id, appset_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_get_replication_partners_by_app_set_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
appset_id str UID of the applicationset

Return type

ReplicationPartnersSummaryList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_snapsets_get_by_id

SnapshotsetListSingle device_type1_snapsets_get_by_id(system_id, appset_id, snapset_id)

Get details of snapsets identified by {snapsetId} for Applicationset identified by {appsetId} for Primera / Alletra 9K

Get details of snapset identified by {snapsetId} for Applicationset identified by {appsetId} for Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.snapshotset_list_single import SnapshotsetListSingle
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    appset_id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    snapset_id = "a7c4e6593f51d0b98f0e40d7e6df04fd" # str | Identifier of snapset.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get details of snapsets identified by {snapsetId} for Applicationset identified by {appsetId} for Primera / Alletra 9K
        api_response = api_instance.device_type1_snapsets_get_by_id(system_id, appset_id, snapset_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_snapsets_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get details of snapsets identified by {snapsetId} for Applicationset identified by {appsetId} for Primera / Alletra 9K
        api_response = api_instance.device_type1_snapsets_get_by_id(system_id, appset_id, snapset_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_snapsets_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
appset_id str UID of the applicationset
snapset_id str Identifier of snapset.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

SnapshotsetListSingle

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_set_capacity_statistics_get_by_id

PrimeraApplicationSetCapacityStats device_type1_volume_set_capacity_statistics_get_by_id(id, system_id)

Get capacity details for an applicationset identified by appsetUid

Get capacity details for an applicationset identified by appsetUid

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.primera_application_set_capacity_stats import PrimeraApplicationSetCapacityStats
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get capacity details for an applicationset identified by appsetUid
        api_response = api_instance.device_type1_volume_set_capacity_statistics_get_by_id(id, system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_capacity_statistics_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get capacity details for an applicationset identified by appsetUid
        api_response = api_instance.device_type1_volume_set_capacity_statistics_get_by_id(id, system_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_capacity_statistics_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str UID of the applicationset
system_id str systemId of the device-type1 storage system
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

PrimeraApplicationSetCapacityStats

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_set_export

TaskResponse device_type1_volume_set_export(system_id, appset_id, export_app_set_post)

Export applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Export applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.export_app_set_post import ExportAppSetPost
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    appset_id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    export_app_set_post = ExportAppSetPost(
        host_group_ids=[
            "host_group_ids_example",
        ],
        proximity="PRIMARY",
    ) # ExportAppSetPost | 

    # example passing only required values which don't have defaults set
    try:
        # Export applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}
        api_response = api_instance.device_type1_volume_set_export(system_id, appset_id, export_app_set_post)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_export: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
appset_id str UID of the applicationset
export_app_set_post ExportAppSetPost

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_set_snapshot_get_by_id

TaskResponse device_type1_volume_set_snapshot_get_by_id(system_id, appset_id, snapset_id)

Remove Primera / Alletra 9K snapset in system identified by {snapsetId}

Remove Primera / Alletra 9K snapset in system identified by {snapsetId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    appset_id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    snapset_id = "a7c4e6593f51d0b98f0e40d7e6df04fd" # str | Identifier of snapset.
    force = True # bool | Make snapset offline and remove. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Remove Primera / Alletra 9K snapset in system identified by {snapsetId}
        api_response = api_instance.device_type1_volume_set_snapshot_get_by_id(system_id, appset_id, snapset_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_snapshot_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Remove Primera / Alletra 9K snapset in system identified by {snapsetId}
        api_response = api_instance.device_type1_volume_set_snapshot_get_by_id(system_id, appset_id, snapset_id, force=force)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_snapshot_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
appset_id str UID of the applicationset
snapset_id str Identifier of snapset.
force bool Make snapset offline and remove. [optional]

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_set_snapshots_list

SnapshotSetsSummaryList device_type1_volume_set_snapshots_list(system_id, id)

Get snapshot details of volume sets identified by {id} for Primera / Alletra 9K

Get snapshot details of volume sets identified by {id} for Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.snapshot_sets_summary_list import SnapshotSetsSummaryList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)
    filter = "name eq array1 and wwn eq 2FF70002AC018D94" # str | oData query to filter by Key. (optional)
    sort = "systemWWN desc" # str | oData query to sort by Key. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get snapshot details of volume sets identified by {id} for Primera / Alletra 9K
        api_response = api_instance.device_type1_volume_set_snapshots_list(system_id, id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_snapshots_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get snapshot details of volume sets identified by {id} for Primera / Alletra 9K
        api_response = api_instance.device_type1_volume_set_snapshots_list(system_id, id, limit=limit, offset=offset, select=select, filter=filter, sort=sort)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_snapshots_list: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str UID of the applicationset
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
select str Query to select only the required parameters, separated by . if nested [optional]
filter str oData query to filter by Key. [optional]
sort str oData query to sort by Key. [optional]

Return type

SnapshotSetsSummaryList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_set_unexport

TaskResponse device_type1_volume_set_unexport(system_id, appset_id, un_export_app_set_post)

Unexport applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Unexport applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.un_export_app_set_post import UnExportAppSetPost
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    appset_id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    un_export_app_set_post = UnExportAppSetPost(
        host_group_ids=["host Group1","Host Group2"],
    ) # UnExportAppSetPost | 

    # example passing only required values which don't have defaults set
    try:
        # Unexport applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}
        api_response = api_instance.device_type1_volume_set_unexport(system_id, appset_id, un_export_app_set_post)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_unexport: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
appset_id str UID of the applicationset
un_export_app_set_post UnExportAppSetPost

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_set_volumes_list

PrimeraAppSetVolumes device_type1_volume_set_volumes_list(appset_id, system_id)

Get volumes for an applicationset identified by appsetUid

Get volumes for an applicationset identified by appsetUid

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.primera_app_set_volumes import PrimeraAppSetVolumes
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    appset_id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "name eq array1 and wwn eq 2FF70002AC018D94" # str | oData query to filter by Key. (optional)
    sort = "systemWWN desc" # str | oData query to sort by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get volumes for an applicationset identified by appsetUid
        api_response = api_instance.device_type1_volume_set_volumes_list(appset_id, system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_volumes_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get volumes for an applicationset identified by appsetUid
        api_response = api_instance.device_type1_volume_set_volumes_list(appset_id, system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_set_volumes_list: %s\n" % e)

Parameters

Name Type Description Notes
appset_id str UID of the applicationset
system_id str systemId of the device-type1 storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str oData query to filter by Key. [optional]
sort str oData query to sort by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

PrimeraAppSetVolumes

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_sets_create

TaskResponse device_type1_volume_sets_create(system_id, create_app_set_input)

Create Application Set for a storage system Primera / Alletra 9K

Create Application Set for a storage system Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.create_app_set_input import CreateAppSetInput
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    create_app_set_input = CreateAppSetInput(
        app_set_business_unit="HPE",
        app_set_comments="Edit appset",
        app_set_importance="High",
        app_set_name="Appset_134",
        app_set_type=CreateAppSetInputAppSetType(None),
        custom_app_type="CustomWorkload_123",
        members=["vol1","vol2"],
    ) # CreateAppSetInput | 

    # example passing only required values which don't have defaults set
    try:
        # Create Application Set for a storage system Primera / Alletra 9K
        api_response = api_instance.device_type1_volume_sets_create(system_id, create_app_set_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_create: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
create_app_set_input CreateAppSetInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_sets_delete_by_id

TaskResponse device_type1_volume_sets_delete_by_id(system_id, id)

Remove applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Remove applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset

    # example passing only required values which don't have defaults set
    try:
        # Remove applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}
        api_response = api_instance.device_type1_volume_sets_delete_by_id(system_id, id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_delete_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str UID of the applicationset

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_sets_edit_by_id

TaskResponse device_type1_volume_sets_edit_by_id(system_id, id, volume_set_put)

Edit applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Edit applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.volume_set_put import VolumeSetPut
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    volume_set_put = VolumeSetPut(
        add_members=["vol1","vol2"],
        app_set_business_unit="HPE",
        app_set_comments="Edit appset",
        app_set_name="Appset_134",
        app_set_type=CreateAppSetInputAppSetType(None),
        custom_app_type="CustomWorkload_123",
        remove_members=["vol1","vol2"],
    ) # VolumeSetPut | 

    # example passing only required values which don't have defaults set
    try:
        # Edit applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}
        api_response = api_instance.device_type1_volume_sets_edit_by_id(system_id, id, volume_set_put)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_edit_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str UID of the applicationset
volume_set_put VolumeSetPut

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_sets_get_by_id

PrimeraApplicationSetDetails device_type1_volume_sets_get_by_id(id, system_id)

Get applicationset details for an applicationset identified by appsetUid

Get applicationset details for an applicationset identified by appsetUid

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.primera_application_set_details import PrimeraApplicationSetDetails
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get applicationset details for an applicationset identified by appsetUid
        api_response = api_instance.device_type1_volume_sets_get_by_id(id, system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get applicationset details for an applicationset identified by appsetUid
        api_response = api_instance.device_type1_volume_sets_get_by_id(id, system_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str UID of the applicationset
system_id str systemId of the device-type1 storage system
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

PrimeraApplicationSetDetails

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_sets_list

PrimeraApplicationSetsList device_type1_volume_sets_list(system_id)

Get all applicationset details for Primera / Alletra 9K

Get all applicationset details for Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.primera_application_sets_list import PrimeraApplicationSetsList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "uid eq 2a0df0fe6f7dc7bb16000000000000000000004817" # str | Lucene query to filter application-sets by Key. (optional)
    sort = "name desc" # str | Lucene query to sort application-sets by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all applicationset details for Primera / Alletra 9K
        api_response = api_instance.device_type1_volume_sets_list(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all applicationset details for Primera / Alletra 9K
        api_response = api_instance.device_type1_volume_sets_list(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_list: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str Lucene query to filter application-sets by Key. [optional]
sort str Lucene query to sort application-sets by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

PrimeraApplicationSetsList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
304 Not Modified -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1_volume_sets_snapshot_create

TaskResponse device_type1_volume_sets_snapshot_create(system_id, id, appset_post)

Create snapshot for application set identified by {id}

Create snapshot for application set identified by {id}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.appset_post import AppsetPost
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | UID of the applicationset
    appset_post = AppsetPost(
        comment="",
        expire_secs=100,
        read_only=False,
        retain_secs=86400,
        snapshot_name="snapshot_oracle_1611807822",
        vv_name_pattern=NamePattern("PARENT_TIMESTAMP"),
    ) # AppsetPost | 

    # example passing only required values which don't have defaults set
    try:
        # Create snapshot for application set identified by {id}
        api_response = api_instance.device_type1_volume_sets_snapshot_create(system_id, id, appset_post)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1_volume_sets_snapshot_create: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str UID of the applicationset
appset_post AppsetPost

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type1action_on_volume_sets

TaskResponse device_type1action_on_volume_sets(system_id, id, remote_protection_actions_input)

Actions on volume set identified by {id} and {systemId} from Primera / Alletra 9K

Actions on volume set identified by {id} and {systemId} from Primera / Alletra 9K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.remote_protection_actions_input import RemoteProtectionActionsInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "e9d353bf98fc1a6bdb90b824e3ca14b5" # str | ID of the applicationset
    remote_protection_actions_input = RemoteProtectionActionsInput(
        action="SYNC",
        parameters=RemoteProtectionActionsInputParams(
            start_action_params=StartParams(
                target_name="s1511",
            ),
            stop_action_params=StopParams(
                target_name="s1511",
            ),
            sync_action_params=SyncParams(
                force_full_sync=False,
            ),
        ),
    ) # RemoteProtectionActionsInput | 

    # example passing only required values which don't have defaults set
    try:
        # Actions on volume set identified by {id} and {systemId} from Primera / Alletra 9K
        api_response = api_instance.device_type1action_on_volume_sets(system_id, id, remote_protection_actions_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type1action_on_volume_sets: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str ID of the applicationset
remote_protection_actions_input RemoteProtectionActionsInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_action_on_snapshot_collection

TaskResponse device_type2_action_on_snapshot_collection(system_id, volume_collection_id, nimble_update_snapshot_collections_state_input)

Perform offline/online action on snapshot collections of Nimble / Alletra 6K and associated with volume collection {volumeCollectionId} in the system identified by {systemId}

Perform offline/online action on snapshot collections of Nimble / Alletra 6K and associated with volume collection {volumeCollectionId} in the system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_update_snapshot_collections_state_input import NimbleUpdateSnapshotCollectionsStateInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    nimble_update_snapshot_collections_state_input = NimbleUpdateSnapshotCollectionsStateInput(
        online=True,
        snapshot_collection_ids=[
            "3a0df0fe6f7dc7bb16000000000000000000003467",
        ],
    ) # NimbleUpdateSnapshotCollectionsStateInput | 

    # example passing only required values which don't have defaults set
    try:
        # Perform offline/online action on  snapshot collections of Nimble / Alletra 6K and associated with volume collection {volumeCollectionId}  in the system identified by {systemId}
        api_response = api_instance.device_type2_action_on_snapshot_collection(system_id, volume_collection_id, nimble_update_snapshot_collections_state_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_action_on_snapshot_collection: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
nimble_update_snapshot_collections_state_input NimbleUpdateSnapshotCollectionsStateInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_action_on_volume_collection

TaskResponse device_type2_action_on_volume_collection(system_id, volume_collection_id, nimble_handover_volume_collections_input)

Perform handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_handover_volume_collections_input import NimbleHandoverVolumeCollectionsInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    nimble_handover_volume_collections_input = NimbleHandoverVolumeCollectionsInput(
        invoke_on_upstream_partner=False,
        no_reverse=False,
        override_upstream_down=False,
        replication_partner_id="2a0df0fe6f7dc7bb16000000000000000000004817",
    ) # NimbleHandoverVolumeCollectionsInput | 

    # example passing only required values which don't have defaults set
    try:
        # Perform handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
        api_response = api_instance.device_type2_action_on_volume_collection(system_id, volume_collection_id, nimble_handover_volume_collections_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_action_on_volume_collection: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
nimble_handover_volume_collections_input NimbleHandoverVolumeCollectionsInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_action_on_volume_collection_id

TaskResponse device_type2_action_on_volume_collection_id(system_id, volume_collection_id, nimble_demote_volume_collections_input)

Perform demote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform demote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_demote_volume_collections_input import NimbleDemoteVolumeCollectionsInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    nimble_demote_volume_collections_input = NimbleDemoteVolumeCollectionsInput(
        invoke_on_upstream_partner=True,
        replication_partner_id="2a0df0fe6f7dc7bb16000000000000000000004817",
    ) # NimbleDemoteVolumeCollectionsInput | 

    # example passing only required values which don't have defaults set
    try:
        # Perform demote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
        api_response = api_instance.device_type2_action_on_volume_collection_id(system_id, volume_collection_id, nimble_demote_volume_collections_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_action_on_volume_collection_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
nimble_demote_volume_collections_input NimbleDemoteVolumeCollectionsInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_actionon_volume_collection

TaskResponse device_type2_actionon_volume_collection(system_id, volume_collection_id)

Perform abort handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform abort handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.

    # example passing only required values which don't have defaults set
    try:
        # Perform abort handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
        api_response = api_instance.device_type2_actionon_volume_collection(system_id, volume_collection_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_actionon_volume_collection: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_add_volumes_to_volume_collections

TaskResponse device_type2_add_volumes_to_volume_collections(system_id, volume_collection_id, nimble_add_volume_to_volume_collection_input)

Add volumes to Nimble / Alletra 6K volumes collection in system identified by {systemId}

Add volumes to Nimble / Alletra 6K volumes collection in system identified by {systemId

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_add_volume_to_volume_collection_input import NimbleAddVolumeToVolumeCollectionInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of volumeCollection. A 42 digit hexadecimal number.
    nimble_add_volume_to_volume_collection_input = NimbleAddVolumeToVolumeCollectionInput(None) # NimbleAddVolumeToVolumeCollectionInput | 

    # example passing only required values which don't have defaults set
    try:
        # Add volumes to Nimble / Alletra 6K volumes collection in system identified by {systemId}
        api_response = api_instance.device_type2_add_volumes_to_volume_collections(system_id, volume_collection_id, nimble_add_volume_to_volume_collection_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_add_volumes_to_volume_collections: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of volumeCollection. A 42 digit hexadecimal number.
nimble_add_volume_to_volume_collection_input NimbleAddVolumeToVolumeCollectionInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_create_snapshot_collections

TaskResponse device_type2_create_snapshot_collections(system_id, volume_collection_id, nimble_create_snapshot_collections_input)

Create Nimble / Alletra 6K snapshot collection in system identified by {systemId}

Create Nimble / Alletra 6K snapshot collection in system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.nimble_create_snapshot_collections_input import NimbleCreateSnapshotCollectionsInput
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    nimble_create_snapshot_collections_input = NimbleCreateSnapshotCollectionsInput(
        agent_type="agent_type_example",
        allow_writes=True,
        description="99.9999% availability",
        disable_appsync=True,
        invoke_on_upstream_partner=True,
        is_external_trigger=False,
        metadata=[
            KeyValue(
                key="key1",
                value="value1",
            ),
        ],
        name="snap1",
        replicate=True,
        replicate_to="replicate_to_example",
        skip_db_consistency_check=True,
        snap_verify=True,
        start_online=True,
        vol_snap_attr_list=[
            NimbleVolumeSnapAttr(
                app_uuid="rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
                metadata=[
                    KeyValue(
                        key="key1",
                        value="value1",
                    ),
                ],
                vol_id="2a0df0fe6f7dc7bb16000000000000000000004817",
            ),
        ],
    ) # NimbleCreateSnapshotCollectionsInput | 

    # example passing only required values which don't have defaults set
    try:
        # Create Nimble / Alletra 6K snapshot collection in system identified by {systemId}
        api_response = api_instance.device_type2_create_snapshot_collections(system_id, volume_collection_id, nimble_create_snapshot_collections_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_create_snapshot_collections: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
nimble_create_snapshot_collections_input NimbleCreateSnapshotCollectionsInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_edit_volume_collection_by_id

TaskResponse device_type2_edit_volume_collection_by_id(system_id, volume_collection_id, nimble_edit_volume_collection_input)

Edit details of Nimble / Alletra 6K Volume-collections identified by {volumeCollectionId}

Edit details of Nimble / Alletra 6K Volume-collections identified by {volumeCollectionId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_edit_volume_collection_input import NimbleEditVolumeCollectionInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of volumeCollection. A 42 digit hexadecimal number.
    nimble_edit_volume_collection_input = NimbleEditVolumeCollectionInput(
        agent_hostname="myobject-5",
        agent_username="myobject-5",
        app_cluster_name="myobject-5",
        app_id="inval",
        app_server="myobject-5",
        app_service_name="myobject-5",
        app_sync="vss",
        description="99.9999% availability",
        name="myobject-5",
        vcenter_hostname="myobject-5",
        vcenter_username="administrator@vsphere.local",
    ) # NimbleEditVolumeCollectionInput | 

    # example passing only required values which don't have defaults set
    try:
        # Edit  details of Nimble / Alletra 6K Volume-collections identified by {volumeCollectionId}
        api_response = api_instance.device_type2_edit_volume_collection_by_id(system_id, volume_collection_id, nimble_edit_volume_collection_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_edit_volume_collection_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of volumeCollection. A 42 digit hexadecimal number.
nimble_edit_volume_collection_input NimbleEditVolumeCollectionInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_get_all_folders

NimbleFolderList device_type2_get_all_folders(system_id)

Get all folders details by Nimble / Alletra 6K

Get all folders details by Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.nimble_folder_list import NimbleFolderList
from greenlake_data_services.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "id eq 2a0df0fe6f7dc7bb16000000000000000000004817" # str | Lucene query to filter folders by Key. (optional)
    sort = "name desc" # str | oData query to sort folders resource by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all folders details by Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_all_folders(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_all_folders: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all folders details by Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_all_folders(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_all_folders: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str Lucene query to filter folders by Key. [optional]
sort str oData query to sort folders resource by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimbleFolderList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_get_all_volume_collections

NimbleVolumeCollectionList device_type2_get_all_volume_collections(system_id)

Get all volume-collections details by Nimble / Alletra 6K

Get all volume-collections details by Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_volume_collection_list import NimbleVolumeCollectionList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "id eq 2a0df0fe6f7dc7bb16000000000000000000004817" # str | Lucene query to filter volume-collection by Key. (optional)
    sort = "name desc" # str | oData query to sort volume-collection resource by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all volume-collections details by Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_all_volume_collections(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_all_volume_collections: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all volume-collections details by Nimble / Alletra 6K
        api_response = api_instance.device_type2_get_all_volume_collections(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_all_volume_collections: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str Lucene query to filter volume-collection by Key. [optional]
sort str oData query to sort volume-collection resource by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimbleVolumeCollectionList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_get_snapshot_collections_by_id

NimbleSnapshotCollectionDetails device_type2_get_snapshot_collections_by_id(system_id, volume_collection_id, snapshot_collection_id)

Get details of snapshot collection of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId} by {snapshotId}

Get details of snapshot collection of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId} by {snapshotId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_snapshot_collection_details import NimbleSnapshotCollectionDetails
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    snapshot_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of snapshot Collection. A 42 digit hexadecimal number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get details of snapshot collection of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId} by {snapshotId}
        api_response = api_instance.device_type2_get_snapshot_collections_by_id(system_id, volume_collection_id, snapshot_collection_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_snapshot_collections_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get details of snapshot collection of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId} by {snapshotId}
        api_response = api_instance.device_type2_get_snapshot_collections_by_id(system_id, volume_collection_id, snapshot_collection_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_snapshot_collections_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
snapshot_collection_id str Identifier of snapshot Collection. A 42 digit hexadecimal number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimbleSnapshotCollectionDetails

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_get_snapshots_by_volume_collection_id

NimbleSnapshotCollectionList device_type2_get_snapshots_by_volume_collection_id(system_id, volume_collection_id)

Get all snapshot collections' details of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId}

Get all snapshot collections' details of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_snapshot_collection_list import NimbleSnapshotCollectionList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "id eq 2a0df0fe6f7dc7bb16000000000000000000004817" # str | Lucene query to filter snapshot collections by Key. (optional)
    sort = "name desc" # str | oData query to sort snapshot collections resource by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all snapshot collections' details of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId}
        api_response = api_instance.device_type2_get_snapshots_by_volume_collection_id(system_id, volume_collection_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_snapshots_by_volume_collection_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all snapshot collections' details of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId}
        api_response = api_instance.device_type2_get_snapshots_by_volume_collection_id(system_id, volume_collection_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_snapshots_by_volume_collection_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str Lucene query to filter snapshot collections by Key. [optional]
sort str oData query to sort snapshot collections resource by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimbleSnapshotCollectionList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_get_volume_collection_by_id

NimbleVCollectionDetailsWithRequestUri device_type2_get_volume_collection_by_id(system_id, volume_collection_id)

Get details of Nimble / Alletra 6K volume-collections identified by {volumeCollectionId}

Get details of Nimble / Alletra 6K volume-collections identified by {volumeCollectionId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.nimble_v_collection_details_with_request_uri import NimbleVCollectionDetailsWithRequestUri
from greenlake_data_services.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of volumeCollection. A 42 digit hexadecimal number.
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get details of Nimble / Alletra 6K volume-collections identified by {volumeCollectionId}
        api_response = api_instance.device_type2_get_volume_collection_by_id(system_id, volume_collection_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_volume_collection_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get details of Nimble / Alletra 6K volume-collections identified by {volumeCollectionId}
        api_response = api_instance.device_type2_get_volume_collection_by_id(system_id, volume_collection_id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_get_volume_collection_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of volumeCollection. A 42 digit hexadecimal number.
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

NimbleVCollectionDetailsWithRequestUri

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_promote_action_on_volume_collection

TaskResponse device_type2_promote_action_on_volume_collection(system_id, volume_collection_id)

Perform promote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform promote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.

    # example passing only required values which don't have defaults set
    try:
        # Perform promote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}
        api_response = api_instance.device_type2_promote_action_on_volume_collection(system_id, volume_collection_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_promote_action_on_volume_collection: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_remove_snap_shot_collection

TaskResponse device_type2_remove_snap_shot_collection(system_id, volume_collection_id, remove_snapshot_collection_input)

Remove multiple snapshot collections identified by {volumeCollectionId} from Nimble / Alletra 6K

Remove multiple snapshot collections identified by {volumeCollectionId} from Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.remove_snapshot_collection_input import RemoveSnapshotCollectionInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    remove_snapshot_collection_input = RemoveSnapshotCollectionInput(
        force=True,
        snapshot_collections=[
            SnapshotCollectionAction(
                id="3a0df0fe6f7dc7bb16000000000000000000003467",
            ),
        ],
    ) # RemoveSnapshotCollectionInput | 

    # example passing only required values which don't have defaults set
    try:
        # Remove multiple snapshot collections identified by {volumeCollectionId} from Nimble / Alletra 6K
        api_response = api_instance.device_type2_remove_snap_shot_collection(system_id, volume_collection_id, remove_snapshot_collection_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_remove_snap_shot_collection: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
remove_snapshot_collection_input RemoveSnapshotCollectionInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_remove_volume_collection_by_id

TaskResponse device_type2_remove_volume_collection_by_id(system_id, volume_collection_id)

Remove Volume-collection identified by {volumeCollectionId} from Nimble / Alletra 6K

Remove Volume-collection identified by {volumeCollectionId} from Nimble / Alletra 6K

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000000007" # str | Identifier of Volume Collection. A 42 digit hexadecimal number.
    force = True # bool | Forceful delete volume collection option. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Remove Volume-collection identified by {volumeCollectionId} from Nimble / Alletra 6K
        api_response = api_instance.device_type2_remove_volume_collection_by_id(system_id, volume_collection_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_remove_volume_collection_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Remove Volume-collection identified by {volumeCollectionId} from Nimble / Alletra 6K
        api_response = api_instance.device_type2_remove_volume_collection_by_id(system_id, volume_collection_id, force=force)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_remove_volume_collection_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of Volume Collection. A 42 digit hexadecimal number.
force bool Forceful delete volume collection option. [optional]

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_remove_volumes_from_volume_collection

TaskResponse device_type2_remove_volumes_from_volume_collection(system_id, volume_collection_id, nimble_remove_volume_from_volume_collection_input)

Remove volumes from Nimble / Alletra 6K volumes collection in system identified by {systemId}

Remove volumes from Nimble / Alletra 6K volumes collection in system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_remove_volume_from_volume_collection_input import NimbleRemoveVolumeFromVolumeCollectionInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    volume_collection_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | Identifier of volumeCollection. A 42 digit hexadecimal number.
    nimble_remove_volume_from_volume_collection_input = NimbleRemoveVolumeFromVolumeCollectionInput(None) # NimbleRemoveVolumeFromVolumeCollectionInput | 

    # example passing only required values which don't have defaults set
    try:
        # Remove volumes from Nimble / Alletra 6K volumes collection in system identified by {systemId}
        api_response = api_instance.device_type2_remove_volumes_from_volume_collection(system_id, volume_collection_id, nimble_remove_volume_from_volume_collection_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_remove_volumes_from_volume_collection: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
volume_collection_id str Identifier of volumeCollection. A 42 digit hexadecimal number.
nimble_remove_volume_from_volume_collection_input NimbleRemoveVolumeFromVolumeCollectionInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_type2_volume_collection_create

TaskResponse device_type2_volume_collection_create(system_id, nimble_create_volume_collection_input)

Create Nimble / Alletra 6K volume collection in system identified by {systemId}

Create Nimble / Alletra 6K volume collection in system identified by {systemId}

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_create_volume_collection_input import NimbleCreateVolumeCollectionInput
from greenlake_data_services.model.task_response import TaskResponse
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
    nimble_create_volume_collection_input = NimbleCreateVolumeCollectionInput(
        agent_hostname="myobject-5",
        agent_username="myobject-5",
        app_cluster_name="myobject-5",
        app_id="inval",
        app_server="myobject-5",
        app_service_name="myobject-5",
        app_sync="vss",
        description="99.9999% availability",
        is_standalone_volcoll=True,
        metadata=[
            KeyValue(
                key="key1",
                value="value1",
            ),
        ],
        name="myobject-5",
        prottmpl_id="2a0df0fe6f7dc7bb16000000000000000000004817",
        replication_type="periodic_snapshot",
        vcenter_hostname="myobject-5",
        vcenter_username="administrator@vsphere.local",
        volume_list=[
            "volume_list_example",
        ],
    ) # NimbleCreateVolumeCollectionInput | 

    # example passing only required values which don't have defaults set
    try:
        # Create Nimble / Alletra 6K volume collection in system identified by {systemId}
        api_response = api_instance.device_type2_volume_collection_create(system_id, nimble_create_volume_collection_input)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->device_type2_volume_collection_create: %s\n" % e)

Parameters

Name Type Description Notes
system_id str ID of the storage system
nimble_create_volume_collection_input NimbleCreateVolumeCollectionInput

Return type

TaskResponse

Authorization

JWTAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Storage system object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

volumeset_get_by_id

FleetVolumeSetDetails volumeset_get_by_id(id)

Get volume-set identified by id

Get volume-set identified by id

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.fleet_volume_set_details import FleetVolumeSetDetails
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    id = "fd3244ef7f1ab8bd16500c7a41bdf8f8" # str | UID of Volume Set
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get volume-set identified by id
        api_response = api_instance.volumeset_get_by_id(id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get volume-set identified by id
        api_response = api_instance.volumeset_get_by_id(id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str UID of Volume Set
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

FleetVolumeSetDetails

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

volumeset_get_byvolumeset_id

FleetVolumeset volumeset_get_byvolumeset_id(id)

Get volumes identified by volume set id

Get volumes identified by volume set id

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.fleet_volumeset import FleetVolumeset
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    id = "fd3244ef7f1ab8bd16500c7a41bdf8f8" # str | UID of Volume Set
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "name eq array1 and wwn eq 2FF70002AC018D94" # str | oData query to filter by Key. (optional)
    sort = "systemWWN desc" # str | oData query to sort by Key. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get volumes identified by volume set id
        api_response = api_instance.volumeset_get_byvolumeset_id(id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_get_byvolumeset_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get volumes identified by volume set id
        api_response = api_instance.volumeset_get_byvolumeset_id(id, select=select, limit=limit, offset=offset, filter=filter, sort=sort)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_get_byvolumeset_id: %s\n" % e)

Parameters

Name Type Description Notes
id str UID of Volume Set
select str Query to select only the required parameters, separated by . if nested [optional]
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str oData query to filter by Key. [optional]
sort str oData query to sort by Key. [optional]

Return type

FleetVolumeset

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

volumeset_list

FleetVolumeSetList volumeset_list()

Get all volume-sets

Get all volume sets

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.fleet_volume_set_list import FleetVolumeSetList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "name eq volset and systemId eq 7CE751P312" # str | oData query to filter by Key. (optional)
    sort = "systemId desc" # str | oData query to sort by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all volume-sets
        api_response = api_instance.volumeset_list(limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_list: %s\n" % e)

Parameters

Name Type Description Notes
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str oData query to filter by Key. [optional]
sort str oData query to sort by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

FleetVolumeSetList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

volumeset_list_for_system_by_system_id

FleetVolumeSetList volumeset_list_for_system_by_system_id(system_id)

Get all volume-sets for a systemId

Get all volume sets for a systemId

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.fleet_volume_set_list import FleetVolumeSetList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    limit = 10 # int | Number of items to return at a time (optional)
    offset = 5 # int | The offset of the first item in the collection to return (optional)
    filter = "name eq volset and systemId eq 7CE751P312" # str | oData query to filter by Key. (optional)
    sort = "systemId desc" # str | oData query to sort by Key. (optional)
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get all volume-sets for a systemId
        api_response = api_instance.volumeset_list_for_system_by_system_id(system_id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_list_for_system_by_system_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get all volume-sets for a systemId
        api_response = api_instance.volumeset_list_for_system_by_system_id(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_list_for_system_by_system_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
limit int Number of items to return at a time [optional]
offset int The offset of the first item in the collection to return [optional]
filter str oData query to filter by Key. [optional]
sort str oData query to sort by Key. [optional]
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

FleetVolumeSetList

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

volumeset_system_get_by_id

FleetSystemVolumeset volumeset_system_get_by_id(system_id, id)

Get volume-set identified by id

Get volume-set identified by id

Example

  • Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import volume_sets_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.fleet_system_volumeset import FleetSystemVolumeset
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
    host = "https://eu1.data.cloud.hpe.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = volume_sets_api.VolumeSetsApi(api_client)
    system_id = "7CE751P312" # str | systemId of the device-type1 storage system
    id = "fd3244ef7f1ab8bd16500c7a41bdf8f8" # str | UID of Volume Set
    select = "id" # str | Query to select only the required parameters, separated by . if nested (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get volume-set identified by id
        api_response = api_instance.volumeset_system_get_by_id(system_id, id)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_system_get_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get volume-set identified by id
        api_response = api_instance.volumeset_system_get_by_id(system_id, id, select=select)
        pprint(api_response)
    except greenlake_data_services.ApiException as e:
        print("Exception when calling VolumeSetsApi->volumeset_system_get_by_id: %s\n" % e)

Parameters

Name Type Description Notes
system_id str systemId of the device-type1 storage system
id str UID of Volume Set
select str Query to select only the required parameters, separated by . if nested [optional]

Return type

FleetSystemVolumeset

Authorization

JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Pool object not found -
500 Internal / unexpected error -
503 Appliance in maintenance mode -
0 unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]