All URIs are relative to https://eu1.data.cloud.hpe.com
| Method | HTTP request | Description |
|---|---|---|
| device_type2_create_protection_template | POST /api/v1/storage-systems/device-type2/{systemId}/protection-templates | Create protection template on Nimble / Alletra 6K in system identified by {systemId} |
| device_type2_edit_protection_template | PUT /api/v1/storage-systems/device-type2/{systemId}/protection-templates/{protectionTemplateId} | Edit details of Nimble / Alletra 6K Protection-templates identified by {protectionTemplateId} |
| device_type2_get_all_protection_templates | GET /api/v1/storage-systems/device-type2/{systemId}/protection-templates | Get all protection-templates details by Nimble / Alletra 6K |
| device_type2_get_protection_template_by_id | GET /api/v1/storage-systems/device-type2/{systemId}/protection-templates/{protectionTemplateId} | Get details of Nimble / Alletra 6K protection-templates identified by {protectionTemplateId} |
| device_type2_remove_protection_template | POST /api/v1/storage-systems/device-type2/{systemId}/protection-templates/remove | Remove protection templates for Nimble / Alletra 6K |
TaskResponse device_type2_create_protection_template(system_id, nimble_create_protection_template_input)
Create protection template on Nimble / Alletra 6K in system identified by {systemId}
Create protection template on Nimble / Alletra 6K in system identified by {systemId}
- Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import protection_templates_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 greenlake_data_services.model.nimble_create_protection_template_input import NimbleCreateProtectionTemplateInput
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 = protection_templates_api.ProtectionTemplatesApi(api_client)
system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
nimble_create_protection_template_input = NimbleCreateProtectionTemplateInput(
app_cluster_name="xyz.net",
app_id="sql2005",
app_server="abc.com",
app_service_name="Service1",
app_sync="none",
description="Every day",
name="name_example",
schedules=[
ProtectionScheduleInput(
at_time=0,
days="monday,sunday",
description="Every day",
disable_appsync=True,
downstream_partner="partner1",
downstream_partner_id="005319ed73385876a4000000000000000000000001",
name="snapshot1",
num_retain=0,
num_retain_replica=1234,
period=1234,
period_unit="minutes",
repl_alert_thres=3400,
replicate_every=0,
schedule_type="schedule_type_example",
skip_db_consistency_check=True,
snap_verify=True,
until_time=0,
),
],
) # NimbleCreateProtectionTemplateInput |
# example passing only required values which don't have defaults set
try:
# Create protection template on Nimble / Alletra 6K in system identified by {systemId}
api_response = api_instance.device_type2_create_protection_template(system_id, nimble_create_protection_template_input)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling ProtectionTemplatesApi->device_type2_create_protection_template: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| system_id | str | ID of the storage system | |
| nimble_create_protection_template_input | NimbleCreateProtectionTemplateInput |
- Content-Type: application/json
- Accept: application/json
| 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]
TaskResponse device_type2_edit_protection_template(system_id, protection_template_id, nimble_edit_protection_template_input)
Edit details of Nimble / Alletra 6K Protection-templates identified by {protectionTemplateId}
Edit details of Nimble / Alletra 6K Protection-templates identified by {protectionTemplateId}
- Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import protection_templates_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_protection_template_input import NimbleEditProtectionTemplateInput
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 = protection_templates_api.ProtectionTemplatesApi(api_client)
system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
protection_template_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the Protection Template. A 42 digit hexadecimal number.
nimble_edit_protection_template_input = NimbleEditProtectionTemplateInput(
add_schedules=[
ProtectionScheduleInput(
at_time=0,
days="monday,sunday",
description="Every day",
disable_appsync=True,
downstream_partner="partner1",
downstream_partner_id="005319ed73385876a4000000000000000000000001",
name="snapshot1",
num_retain=0,
num_retain_replica=1234,
period=1234,
period_unit="minutes",
repl_alert_thres=3400,
replicate_every=0,
schedule_type="schedule_type_example",
skip_db_consistency_check=True,
snap_verify=True,
until_time=0,
),
],
app_cluster_name="xyz.net",
app_id="sql2005",
app_server="abc.com",
app_service_name="Service1",
app_sync="none",
description="Every day",
edit_schedules=[
NimbleNsSchedule(
active=False,
at_time=0,
days="all",
disable_appsync=True,
downstream_partner="abc",
downstream_partner_id="0c1c9973433673c3db000000000000000000000008",
downstream_partner_name="abc",
id="0c1c9973433673c3db000000000000000000000008",
name="daily",
num_retain=30,
num_retain_replica=0,
period=1,
period_unit="days",
repl_alert_thres=86400,
replicate_every=0,
schedule_id="0c1c9973433673c3db000000000000000000000008",
schedule_name="daily",
schedule_type="regular",
skip_db_consistency_check=False,
snap_verify=True,
until_time=86399,
),
],
name="name_example",
remove_schedules=[
ProtectionScheduleActionNimble(
id="3a0df0fe6f7dc7bb16000000000000000000003467",
),
],
) # NimbleEditProtectionTemplateInput |
# example passing only required values which don't have defaults set
try:
# Edit details of Nimble / Alletra 6K Protection-templates identified by {protectionTemplateId}
api_response = api_instance.device_type2_edit_protection_template(system_id, protection_template_id, nimble_edit_protection_template_input)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling ProtectionTemplatesApi->device_type2_edit_protection_template: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| system_id | str | ID of the storage system | |
| protection_template_id | str | ID of the Protection Template. A 42 digit hexadecimal number. | |
| nimble_edit_protection_template_input | NimbleEditProtectionTemplateInput |
- Content-Type: application/json
- Accept: application/json
| 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]
NimbleProtectionTemplateList device_type2_get_all_protection_templates(system_id)
Get all protection-templates details by Nimble / Alletra 6K
Get all protection-templates details by Nimble / Alletra 6K
- Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import protection_templates_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_protection_template_list import NimbleProtectionTemplateList
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 = protection_templates_api.ProtectionTemplatesApi(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 Protection Template by Key. (optional)
sort = "name desc" # str | oData query to sort Protection Template 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 protection-templates details by Nimble / Alletra 6K
api_response = api_instance.device_type2_get_all_protection_templates(system_id)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling ProtectionTemplatesApi->device_type2_get_all_protection_templates: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Get all protection-templates details by Nimble / Alletra 6K
api_response = api_instance.device_type2_get_all_protection_templates(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 ProtectionTemplatesApi->device_type2_get_all_protection_templates: %s\n" % e)| 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 Protection Template by Key. | [optional] |
| sort | str | oData query to sort Protection Template resource by Key. | [optional] |
| select | str | Query to select only the required parameters, separated by . if nested | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
NimbleProtectionTemplateDetailsWithRequestUri device_type2_get_protection_template_by_id(system_id, protection_template_id)
Get details of Nimble / Alletra 6K protection-templates identified by {protectionTemplateId}
Get details of Nimble / Alletra 6K protection-templates identified by {protectionTemplateId}
- Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import protection_templates_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.nimble_protection_template_details_with_request_uri import NimbleProtectionTemplateDetailsWithRequestUri
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 = protection_templates_api.ProtectionTemplatesApi(api_client)
system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
protection_template_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the Protection Template. 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 protection-templates identified by {protectionTemplateId}
api_response = api_instance.device_type2_get_protection_template_by_id(system_id, protection_template_id)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling ProtectionTemplatesApi->device_type2_get_protection_template_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 protection-templates identified by {protectionTemplateId}
api_response = api_instance.device_type2_get_protection_template_by_id(system_id, protection_template_id, select=select)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling ProtectionTemplatesApi->device_type2_get_protection_template_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| system_id | str | ID of the storage system | |
| protection_template_id | str | ID of the Protection Template. A 42 digit hexadecimal number. | |
| select | str | Query to select only the required parameters, separated by . if nested | [optional] |
NimbleProtectionTemplateDetailsWithRequestUri
- Content-Type: Not defined
- Accept: application/json
| 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]
TaskResponse device_type2_remove_protection_template(system_id, remove_protection_templates)
Remove protection templates for Nimble / Alletra 6K
Remove protection templates for Nimble / Alletra 6K
- Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import protection_templates_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.remove_protection_templates import RemoveProtectionTemplates
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 = protection_templates_api.ProtectionTemplatesApi(api_client)
system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
remove_protection_templates = RemoveProtectionTemplates(
protection_templates=[
ProtectionTemplateAction(
protection_template_id="3a0df0fe6f7dc7bb16000000000000000000003467",
),
],
) # RemoveProtectionTemplates |
# example passing only required values which don't have defaults set
try:
# Remove protection templates for Nimble / Alletra 6K
api_response = api_instance.device_type2_remove_protection_template(system_id, remove_protection_templates)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling ProtectionTemplatesApi->device_type2_remove_protection_template: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| system_id | str | ID of the storage system | |
| remove_protection_templates | RemoveProtectionTemplates |
- Content-Type: application/json
- Accept: application/json
| 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]