Skip to content

Commit

Permalink
New APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sijeesh
sijeesh committed Mar 29, 2023
1 parent 22991b4 commit a4b021d
Show file tree
Hide file tree
Showing 3,555 changed files with 371,454 additions and 307,023 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
152 changes: 116 additions & 36 deletions README.md
View file

Large diffs are not rendered by default.

36 changes: 19 additions & 17 deletions docs/AccessControlRecord.md
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
# AccessControlRecord


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_protocol** | **str** | Access protocol of snapshot or volume. Possible values: 'iscsi', 'fc'. | [optional]
**acl_id** | **str** | ID of access control record. | [optional]
**apply_to** | **str** | State of apply to. Possible values: 'volume'. 'pe', 'vvol_volume', 'vvol_snapshot', 'snapshot', 'both'. | [optional]
**chap_user_id** | **str** | ID of chap user. | [optional]
**chap_user_name** | **str** | Name of chap user. | [optional]
**id** | **str** | ID of access control record. | [optional]
**initiator_group_id** | **str** | ID of initiator group. | [optional]
**initiator_group_name** | **str** | Name of initiator group. | [optional]
**lun** | **int** | LUN of snapshot or volume. Secondary LUN if this is Virtual Volume. | [optional]
**pe_id** | **str** | ID of protocol endpoint. | [optional]
**pe_lun** | **int** | LUN of protocol endpoint. | [optional]
**pe_name** | **str** | Name of protocol endpoint. | [optional]
**snap_id** | **str** | ID of snapshot. | [optional]
**snap_name** | **str** | Name of snapshot. | [optional]
**snapluns** | [**list[SnapshotLunInfo]**](SnapshotLunInfo.md) | | [optional]
**vol_id** | **str** | ID of volume. | [optional]
**vol_name** | **str** | Name of volume. | [optional]
**access_protocol** | **str, none_type** | Access protocol of snapshot or volume. Possible values: 'iscsi', 'fc'. | [optional]
**acl_id** | **str, none_type** | ID of access control record. | [optional]
**apply_to** | **str, none_type** | State of apply to. Possible values: 'volume'. 'pe', 'vvol_volume', 'vvol_snapshot', 'snapshot', 'both'. | [optional]
**chap_user_id** | **str, none_type** | ID of chap user. | [optional]
**chap_user_name** | **str, none_type** | Name of chap user. | [optional]
**id** | **str, none_type** | ID of access control record. | [optional]
**initiator_group_id** | **str, none_type** | ID of initiator group. | [optional]
**initiator_group_name** | **str, none_type** | Name of initiator group. | [optional]
**lun** | **int, none_type** | LUN of snapshot or volume. Secondary LUN if this is Virtual Volume. | [optional]
**pe_id** | **str, none_type** | ID of protocol endpoint. | [optional]
**pe_lun** | **int, none_type** | LUN of protocol endpoint. | [optional]
**pe_name** | **str, none_type** | Name of protocol endpoint. | [optional]
**snap_id** | **str, none_type** | ID of snapshot. | [optional]
**snap_name** | **str, none_type** | Name of snapshot. | [optional]
**snapluns** | [**[SnapshotLunInfo], none_type**](SnapshotLunInfo.md) | | [optional]
**vol_id** | **str, none_type** | ID of volume. | [optional]
**vol_name** | **str, none_type** | Name of volume. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
4 changes: 3 additions & 1 deletion docs/AccessControlsResponse.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# AccessControlsResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**items** | **list[str]** | List of user permissions based on the supplied filter in the form of 'resource type.permission'. Ex. volume.create |
**items** | **[str]** | List of user permissions based on the supplied filter in the form of 'resource type.permission'. Ex. volume.create |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
7 changes: 5 additions & 2 deletions docs/AddRemoteCopyLinks.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# AddRemoteCopyLinks

Request body for adding remote copy links

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**replication_partner_system_id** | **str** | SystemId of target replication partner |
**source** | [**list[CreateRemoteCopyLinkInput]**](CreateRemoteCopyLinkInput.md) | List of remote copy links to be added to source replication partner |
**target** | [**list[CreateRemoteCopyLinkInput]**](CreateRemoteCopyLinkInput.md) | List of remote copy links to be added to target replication partner |
**source** | [**[CreateRemoteCopyLinkInput]**](CreateRemoteCopyLinkInput.md) | List of remote copy links to be added to source replication partner |
**target** | [**[CreateRemoteCopyLinkInput]**](CreateRemoteCopyLinkInput.md) | List of remote copy links to be added to target replication partner |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
3 changes: 3 additions & 0 deletions docs/AddTrustedCertificateInput.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# AddTrustedCertificateInput

Request body for adding a trusted certificate

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | **str** | Action to perform with trusted certificate |
**parameters** | [**TrustedCertParams**](TrustedCertParams.md) | |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
16 changes: 9 additions & 7 deletions docs/Address.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# Address


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active_node** | **int** | Active node ID | [optional]
**auto_sense** | **bool** | Specifies if the autosense is enabled for network port | [optional]
**full_duplex** | **bool** | Is network port full duplex | [optional]
**ip_address** | **str** | IP Address of the network port | [optional]
**net_mask** | **str** | Net mask of the network port | [optional]
**speed** | **int** | Speed of the network port | [optional]
**active_node** | **int, none_type** | Active node ID | [optional]
**auto_sense** | **bool, none_type** | Specifies if the autosense is enabled for network port | [optional]
**full_duplex** | **bool, none_type** | Is network port full duplex | [optional]
**ip_address** | **str, none_type** | IP Address of the network port | [optional]
**net_mask** | **str, none_type** | Net mask of the network port | [optional]
**speed** | **int, none_type** | Speed of the network port | [optional]
**state** | [**STATE**](STATE.md) | | [optional]
**status** | **str** | Status of the network port | [optional]
**status** | **str, none_type** | Status of the network port | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
7 changes: 5 additions & 2 deletions docs/AdmitTime.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# AdmitTime

admission time of disk

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ms** | **int** | time in millisecond | [optional]
**tz** | **str** | timezone | [optional]
**ms** | **int, none_type** | time in millisecond | [optional]
**tz** | **str, none_type** | timezone | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
196 changes: 139 additions & 57 deletions docs/AlarmsApi.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# greenlake-data-services.AlarmsApi
# greenlake_data_services.AlarmsApi

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

Expand All @@ -9,52 +9,80 @@ Method | HTTP request | Description


# **device_type2_get_alarms**
> NimbleAlarmsList device_type2_get_alarms(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
> NimbleAlarmsList device_type2_get_alarms(system_id)
Get all alarms of Nimble / Alletra 6K

Get all alarms of Nimble / Alletra 6K

### Example

* Bearer (JWT) Authentication (JWTAuth):

```python
from __future__ import print_function
import time
import greenlake-data-services
from greenlake-data-services.rest import ApiException
import greenlake_data_services
from greenlake_data_services.api import alarms_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_alarms_list import NimbleAlarmsList
from pprint import pprint

# Configure HTTP basic authorization: JWTAuth
configuration = greenlake-data-services.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = greenlake-data-services.AlarmsApi(greenlake-data-services.ApiClient(configuration))
system_id = 'system_id_example' # str | ID of the storage system
limit = 56 # int | Number of items to return at a time (optional)
offset = 56 # int | The offset of the first item in the collection to return (optional)
filter = 'filter_example' # str | Lucene query to filter Alarms by Key. (optional)
sort = 'sort_example' # str | Data query to sort Alarm resource by Key. (optional)
select = 'select_example' # str | Query to select only the required parameters, separated by . if nested (optional)

try:
# Get all alarms of Nimble / Alletra 6K
api_response = api_instance.device_type2_get_alarms(system_id, limit=limit, offset=offset, filter=filter, sort=sort, select=select)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->device_type2_get_alarms: %s\n" % e)
# 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 = alarms_api.AlarmsApi(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 Alarms by Key. (optional)
sort = "name desc" # str | Data query to sort Alarm 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 alarms of Nimble / Alletra 6K
api_response = api_instance.device_type2_get_alarms(system_id)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling AlarmsApi->device_type2_get_alarms: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
# Get all alarms of Nimble / Alletra 6K
api_response = api_instance.device_type2_get_alarms(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 AlarmsApi->device_type2_get_alarms: %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 Alarms by Key. | [optional]
**sort** | **str**| Data query to sort Alarm resource by Key. | [optional]
**select** | **str**| Query to select only the required parameters, separated by . if nested | [optional]
**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 Alarms by Key. | [optional]
**sort** | **str**| Data query to sort Alarm resource by Key. | [optional]
**select** | **str**| Query to select only the required parameters, separated by . if nested | [optional]

### Return type

Expand All @@ -69,49 +97,90 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
**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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **device_type2_get_alarms_using_alarm_id**
> NimbleAlarmsWithRequestUri device_type2_get_alarms_using_alarm_id(system_id, alarm_id, select=select)
> NimbleAlarmsWithRequestUri device_type2_get_alarms_using_alarm_id(system_id, alarm_id)
Get all alarms of Nimble / Alletra 6K identified by {alarmId}

Get all alarms of Nimble / Alletra 6K identified by {alarmId}

### Example

* Bearer (JWT) Authentication (JWTAuth):

```python
from __future__ import print_function
import time
import greenlake-data-services
from greenlake-data-services.rest import ApiException
import greenlake_data_services
from greenlake_data_services.api import alarms_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.error import Error
from greenlake_data_services.model.nimble_alarms_with_request_uri import NimbleAlarmsWithRequestUri
from pprint import pprint

# Configure HTTP basic authorization: JWTAuth
configuration = greenlake-data-services.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = greenlake-data-services.AlarmsApi(greenlake-data-services.ApiClient(configuration))
system_id = 'system_id_example' # str | ID of the storage system
alarm_id = 'alarm_id_example' # str | ID of the Alarm. A 42 digit hexadecimal number.
select = 'select_example' # str | Query to select only the required parameters, separated by . if nested (optional)

try:
# Get all alarms of Nimble / Alletra 6K identified by {alarmId}
api_response = api_instance.device_type2_get_alarms_using_alarm_id(system_id, alarm_id, select=select)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->device_type2_get_alarms_using_alarm_id: %s\n" % e)
# 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 = alarms_api.AlarmsApi(api_client)
system_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the storage system
alarm_id = "2a0df0fe6f7dc7bb16000000000000000000004817" # str | ID of the Alarm. 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 all alarms of Nimble / Alletra 6K identified by {alarmId}
api_response = api_instance.device_type2_get_alarms_using_alarm_id(system_id, alarm_id)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling AlarmsApi->device_type2_get_alarms_using_alarm_id: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
# Get all alarms of Nimble / Alletra 6K identified by {alarmId}
api_response = api_instance.device_type2_get_alarms_using_alarm_id(system_id, alarm_id, select=select)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling AlarmsApi->device_type2_get_alarms_using_alarm_id: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**system_id** | **str**| ID of the storage system |
**alarm_id** | **str**| ID of the Alarm. A 42 digit hexadecimal number. |
**select** | **str**| Query to select only the required parameters, separated by . if nested | [optional]
**system_id** | **str**| ID of the storage system |
**alarm_id** | **str**| ID of the Alarm. A 42 digit hexadecimal number. |
**select** | **str**| Query to select only the required parameters, separated by . if nested | [optional]

### Return type

Expand All @@ -126,5 +195,18 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
**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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Loading

0 comments on commit a4b021d

Please sign in to comment.