netapp.santricity.api.v2 package¶
Submodules¶
netapp.santricity.api.v2.administration_api module¶
AdministrationApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.administration_api.
AdministrationApi
(api_client=None)[source]¶ Bases:
object
-
get_certificate_signing_request
(**kwargs)[source]¶ Retrieves an x509 certificate signing request Mode: Both Embedded and Proxy. The response type of this method is a file stream.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_certificate_signing_request(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – fileName
Returns: File If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_ssl_configuration
(**kwargs)[source]¶ GET the SSL Configuration Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_ssl_configuration(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: SSLCertConfiguration If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
Gets the list of known trusted certificate authorities Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_trusted_certificate_authorities(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[X509CertInfo] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
reload_ssl_configuration
(**kwargs)[source]¶ Asynchonously Reloads SSL Configuration. When this call returns, the reload has been requested Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.reload_ssl_configuration(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_ca
(alias, **kwargs)[source]¶ Deletes the CA with the given aliass Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_ca(alias, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- alias (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
set_ssl_configuration
(**kwargs)[source]¶ Set the SSL Configuration causing a regeneration of the SSL Certificate. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.set_ssl_configuration(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (SSLCertConfiguration) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
upload_ca_certificate
(**kwargs)[source]¶ Upload a the CA that signed the certificate used for this server Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.upload_ca_certificate(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- file (file) – certificate file
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
upload_certificate_signing_request
(**kwargs)[source]¶ Upload a previously exported certificate signing request Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.upload_certificate_signing_request(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- file (file) – certificate file
Returns: list[FileInfo] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.configuration_api module¶
ConfigurationApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.configuration_api.
ConfigurationApi
(api_client=None)[source]¶ Bases:
object
-
dispatch_asup_bundle
(**kwargs)[source]¶ Dispatch the ASUP bundle Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.dispatch_asup_bundle(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (AsupDispatchRequest) –
Returns: AsupResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_asup_configuration_info
(**kwargs)[source]¶ Retrieve ASUP configuration info Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_asup_configuration_info(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: AsupResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_configuration_result
(**kwargs)[source]¶ Get the current result data for the last operation, if no operation has been done, an empty body is returned Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_configuration_result(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: ConfigurationResult If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_configuration_types
(**kwargs)[source]¶ Returns a list of known configuration items that can be used by this server Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_configuration_types(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[str] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
register_asup_bundle
(**kwargs)[source]¶ Register the ASUP bundle Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.register_asup_bundle(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (AsupRegistrationRequest) –
Returns: str If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_configuration
(**kwargs)[source]¶ Starts a new bulk configuration operation. If an operation is already running a 200 is returned. If a new operation is started, a 201 is returned Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_configuration(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (FileBasedConfigurationRequest) –
Returns: ConfigurationResult If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
stop_configuration
(**kwargs)[source]¶ Interrupts any current configuration process Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.stop_configuration(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_asup_configuration_info
(**kwargs)[source]¶ Update ASUP configuration info Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_asup_configuration_info(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (AsupUpdateRequest) –
Returns: AsupResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
validate_csv_file
(**kwargs)[source]¶ Used to validate an input CSV file previously uploaded Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.validate_csv_file(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (FileBasedConfigurationRequest) –
Returns: ValidateConfiurationFileResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.copy_services_api module¶
CopyServicesApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.copy_services_api.
CopyServicesApi
(api_client=None)[source]¶ Bases:
object
-
convert_snapshot_volume_to_read_write
(system_id, view_id, **kwargs)[source]¶ Convert a ReadOnly Snapshot Volume to ReadWrite mode Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.convert_snapshot_volume_to_read_write(system_id, view_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- view_id (str) – (required)
- body (SnapshotVolumeModeConversionRequest) –
Returns: PitViewEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
expand_concat_volume
(system_id, id, **kwargs)[source]¶ Expand a Concat Repository Volume by providing an expansion candidate. Mode: Both Embedded and Proxy. An expansion candidate of type “expansion” is only valid for ThinVolume repositories. ThinVolume repositories are likewise also limited to a single repository member, which prevents use of the “existingVol” and “newVol” expansion types.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.expand_concat_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
- body (ConcatVolumeExpansionRequest) –
Returns: ConcatRepositoryVolume If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_concat_repository_volumes
(system_id, **kwargs)[source]¶ Retrieve the list of Concat Repository Volumes. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_concat_repository_volumes(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[ConcatRepositoryVolume] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_consistency_group_members
(system_id, **kwargs)[source]¶ Get a list of all consistency group members Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_consistency_group_members(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[PITCGMember] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_consistency_group_members_list
(system_id, cg_id, **kwargs)[source]¶ Get ConsistencyGroup members Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_consistency_group_members_list(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
Returns: list[PITCGMember] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_consistency_group_snapshot_views
(system_id, **kwargs)[source]¶ Get a list of all consistency group snapshot views Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_consistency_group_snapshot_views(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[PITConsistencyGroupView] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_consistency_group_snapshot_views_list
(system_id, cg_id, **kwargs)[source]¶ Get Snapshot views associated with the ConsistencyGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_consistency_group_snapshot_views_list(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
Returns: list[PITConsistencyGroupView] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_consistency_group_snapshots
(system_id, cg_id, **kwargs)[source]¶ Get Snapshots associated with the ConsistencyGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_consistency_group_snapshots(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
Returns: list[Snapshot] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_consistency_groups
(system_id, **kwargs)[source]¶ Get all consistency groups Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_consistency_groups(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[PITConsistencyGroup] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_copy_pair_progress
(system_id, **kwargs)[source]¶ Get progress of all copy pairs Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_copy_pair_progress(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[VolumeCopyProgress] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_legacy_snapshot_repo_stats
(system_id, **kwargs)[source]¶ Retrieve the repository usage statistics for all Legacy Snapshots. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_legacy_snapshot_repo_stats(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[RepositoryUtilization] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_legacy_snapshots
(system_id, **kwargs)[source]¶ Get Legacy Snapshots Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_legacy_snapshots(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[LegacySnapshotEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_snapshot_group_repo_stats
(system_id, **kwargs)[source]¶ Retrieve the repository usage statistics for all SnapshotGroups. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_snapshot_group_repo_stats(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[PITGroupRepositoryUtilization] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_snapshot_groups
(system_id, **kwargs)[source]¶ Get all Snapshot Groups Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_snapshot_groups(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[SnapshotGroup] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_snapshot_schedules
(system_id, **kwargs)[source]¶ Get all Snapshot Schedules Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_snapshot_schedules(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[ScheduleInstance] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_snapshot_volume_repo_stats
(system_id, **kwargs)[source]¶ Retrieve the repository usage statistics for all SnapshotVolumes. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_snapshot_volume_repo_stats(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[PITViewRepositoryUtilization] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_snapshot_volumes
(system_id, **kwargs)[source]¶ Get all Snapshot Volumes Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_snapshot_volumes (system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[PitViewEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_snapshots
(system_id, **kwargs)[source]¶ Get all Snapshots Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_snapshots(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[Snapshot] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_volume_copy_pairs
(system_id, **kwargs)[source]¶ Get the list of volume copy pairs Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_volume_copy_pairs(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[VolumeCopyPair] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_concat_repository_volumes
(system_id, id, **kwargs)[source]¶ Get a specific Concat Repository Volume. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_concat_repository_volumes(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
Returns: ConcatRepositoryVolume If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_concat_volume_candidates
(system_id, **kwargs)[source]¶ Request a list of ConcatVolumeCandidates for a single base volume. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_concat_volume_candidates(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (CVCandidateSelectionRequest) –
Returns: list[CVCandidateResponse] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_consistency_group
(system_id, id, **kwargs)[source]¶ Get consistency group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_consistency_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: PITConsistencyGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_consistency_group_members
(system_id, cg_id, volume_ref, **kwargs)[source]¶ Get ConsistencyGroup member Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_consistency_group_members(system_id, cg_id, volume_ref, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- volume_ref (str) – (required)
Returns: PITCGMember If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_consistency_group_snapshot_view
(system_id, cg_id, view_id, **kwargs)[source]¶ Get a Snapshot view associated with the ConsistencyGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_consistency_group_snapshot_view(system_id, cg_id, view_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- view_id (str) – (required)
Returns: PITConsistencyGroupView If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_consistency_group_snapshot_volumes
(system_id, cg_id, view_id, **kwargs)[source]¶ Retrieve the underlying SnapshotVolumes associated with the PITConsistencyGroupView Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_consistency_group_snapshot_volumes(system_id, cg_id, view_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- view_id (str) – (required)
Returns: list[PitViewEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_consistency_group_snapshots
(system_id, cg_id, sequence_number, **kwargs)[source]¶ Get a set of Snapshots by sequenceNumber Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_consistency_group_snapshots(system_id, cg_id, sequence_number, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- sequence_number (int) – (required)
Returns: list[Snapshot] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_copy_pair_progress
(system_id, id, **kwargs)[source]¶ Get progress of a copy pair Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_copy_pair_progress(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
Returns: VolumeCopyProgress If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_legacy_snapshot
(system_id, id, **kwargs)[source]¶ Get Legacy Snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_legacy_snapshot(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
Returns: LegacySnapshotEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_legacy_snapshot_repo_stats
(system_id, id, **kwargs)[source]¶ Retrieve the repository usage statistics for a single Legacy Snapshot. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_legacy_snapshot_repo_stats(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
Returns: RepositoryUtilization If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_multiple_concat_volume_candidates
(system_id, **kwargs)[source]¶ Request the best ConcatVolumeCandidate for multiple base volumes. Mode: Both Embedded and Proxy. If no candidate can be found for a particular base volume, a response with null Candidate will be returned in the list.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_multiple_concat_volume_candidates(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (CVCandidateMultipleSelectionRequest) –
Returns: list[CVCandidateResponse] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_snapshot
(system_id, id, **kwargs)[source]¶ Get a Snapshot Volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_snapshot(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
Returns: Snapshot If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_snapshot_group
(system_id, id, **kwargs)[source]¶ Get a Snapshot Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_snapshot_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: SnapshotGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_snapshot_group_repo_stats
(system_id, id, **kwargs)[source]¶ Retrieve the repository usage statistics for a single SnapshotGroup. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_snapshot_group_repo_stats(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: PITGroupRepositoryUtilization If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_snapshot_schedule
(system_id, id, **kwargs)[source]¶ Get a Snapshot Schedule Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_snapshot_schedule(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: ScheduleInstance If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_snapshot_volume
(system_id, id, **kwargs)[source]¶ Get a Snapshot Volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_snapshot_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: PitViewEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_snapshot_volume_repo_stats
(system_id, id, **kwargs)[source]¶ Retrieve the repository usage statistics for a single SnapshotVolume. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_snapshot_volume_repo_stats(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: PITViewRepositoryUtilization If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_volume_copy_pair
(system_id, vc_id, **kwargs)[source]¶ Get a volume copy pair Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_volume_copy_pair(system_id, vc_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- vc_id (str) – (required)
Returns: VolumeCopyPair If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_consistency_group
(system_id, **kwargs)[source]¶ Create consistency group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_consistency_group(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (ConsistencyGroupCreateRequest) –
Returns: PITConsistencyGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_consistency_group_member
(system_id, cg_id, **kwargs)[source]¶ Add ConsistencyGroup member Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_consistency_group_member(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- body (AddConsistencyGroupMemberRequest) –
Returns: PITCGMember If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_consistency_group_snapshot
(system_id, cg_id, **kwargs)[source]¶ Create ConsistencyGroup snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_consistency_group_snapshot(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- body (CreateConsistencyGroupSnapshotRequest) –
Returns: list[Snapshot] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_consistency_group_snapshot_view
(system_id, cg_id, **kwargs)[source]¶ Create Snapshot Views from a ConsistencyGroup Snapshot Mode: Both Embedded and Proxy. A pitId or a pitSequenceNumber can be provided to this endpoint in order to create a snapshotView. If a pitId is provided, only a single view will be created. If a pitSequenceNumber is provided, a snapshotView will be created for each Snapshot associated with the sequenceNumber.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_consistency_group_snapshot_view(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- body (CreateConsistencyGroupSnapshotViewRequest) –
Returns: PITConsistencyGroupView If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_consistency_group_snapshot_view_detailed
(system_id, cg_id, **kwargs)[source]¶ Create Snapshot Views from a ConsistencyGroup Snapshot Mode: Both Embedded and Proxy. This endpoint provides more granularity and customization in creating a view than the non-batch endpoint. For each snapshot that you wish for a view to be created of, a CGSnapshotViewRequest must be provided that defines the parameters (including a repository candidate, if necessary [See repositories/concat]). Each Snapshot provided MUST be under the same pitSequenceNumber.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_consistency_group_snapshot_view_detailed(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- body (CreateCGSnapshotViewManualRequest) –
Returns: PITConsistencyGroupView If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_legacy_snapshot
(system_id, **kwargs)[source]¶ Create Legacy Snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_legacy_snapshot(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (LegacySnapshotCreateRequest) –
Returns: LegacySnapshotEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_multiple_consistency_group_members
(system_id, cg_id, **kwargs)[source]¶ Add multiple ConsistencyGroup members at once Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_multiple_consistency_group_members(system_id, cg_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- body (AddBatchCGMembersRequest) –
Returns: list[PITCGMember] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_snapshot
(system_id, **kwargs)[source]¶ Create a Snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_snapshot(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (SnapshotCreateRequest) –
Returns: Snapshot If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_snapshot_group
(system_id, **kwargs)[source]¶ Create a Snapshot Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_snapshot_group(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (SnapshotGroupCreateRequest) –
Returns: SnapshotGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_snapshot_volume
(system_id, **kwargs)[source]¶ Create a Snapshot Volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_snapshot_volume(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (SnapshotViewCreateRequest) –
Returns: PitViewEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_volume_copy_pair
(system_id, **kwargs)[source]¶ Create a new volume copy pair Mode: Both Embedded and Proxy. Establish a new volume copy pair by providing a source and a target volume. The target volume must be of greater or equal size to the source.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_volume_copy_pair(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (VolumeCopyCreateRequest) –
Returns: VolumeCopyPair If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_consistency_group
(system_id, id, **kwargs)[source]¶ Delete consistency group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_consistency_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_consistency_group_member
(system_id, cg_id, volume_ref, **kwargs)[source]¶ Remove ConsistencyGroup member Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_consistency_group_member(system_id, cg_id, volume_ref, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- volume_ref (str) – (required)
- retain_repositories (bool) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_consistency_group_snapshot
(system_id, cg_id, sequence_number, **kwargs)[source]¶ Remove ConsistencyGroup snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_consistency_group_snapshot(system_id, cg_id, sequence_number, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- sequence_number (int) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_consistency_group_snapshot_view
(system_id, cg_id, view_id, **kwargs)[source]¶ Delete an existing Snapshot View Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_consistency_group_snapshot_view(system_id, cg_id, view_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- view_id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_legacy_snapshot
(system_id, id, **kwargs)[source]¶ Delete a Legacy Snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_legacy_snapshot(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_snapshot
(system_id, id, **kwargs)[source]¶ Delete a Snapshot Volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_snapshot(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_snapshot_group
(system_id, id, **kwargs)[source]¶ Delete a Snapshot Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_snapshot_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_snapshot_volume
(system_id, id, **kwargs)[source]¶ Delete a Snapshot Volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_snapshot_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_volume_copy_pair
(system_id, vc_id, **kwargs)[source]¶ Remove a volume copy pair Mode: Both Embedded and Proxy. Online volume copies, or copies based on snapshots, require multiple operations to delete all repository volumes (if enabled). If there is a service interruption, it is possible that all repository volumes will not be deleted.These repository volumes can be retrieved using the volumes resource, and will be marked with a volumeUse of ‘freeRepositoryVolume’.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_volume_copy_pair(system_id, vc_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- vc_id (str) – (required)
- retain_repositories (bool) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
rollback_consistency_group_snapshot
(system_id, cg_id, sequence_number, **kwargs)[source]¶ Rollback a ConsistencyGroup snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.rollback_consistency_group_snapshot(system_id, cg_id, sequence_number, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cg_id (str) – (required)
- sequence_number (int) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_consistency_group
(system_id, id, **kwargs)[source]¶ Update consistency group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_consistency_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (ConsistencyGroupUpdateRequest) –
Returns: PITConsistencyGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_copy_pair_operation
(system_id, ids, control, **kwargs)[source]¶ Start/Stop a copy pair operation Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_copy_pair_operation(system_id, ids, control, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- ids (str) – A comma separated list of id’s (required)
- control (str) – control (required)
Returns: list[VolumeCopyProgress] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_legacy_snapshot
(system_id, id, **kwargs)[source]¶ Update a Legacy Snapshot Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_legacy_snapshot(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- id (str) – (required)
- body (LegacySnapshotUpdateRequest) –
Returns: LegacySnapshotEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_snapshot_group
(system_id, id, **kwargs)[source]¶ Update a Snapshot Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_snapshot_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (SnapshotGroupUpdateRequest) –
Returns: SnapshotGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_snapshot_volume
(system_id, id, **kwargs)[source]¶ Update a Snapshot Volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_snapshot_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (SnapshotViewUpdateRequest) –
Returns: PitViewEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_volume_copy_pair_parameters
(system_id, vc_id, **kwargs)[source]¶ Update parameters of a volume copy pair Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_volume_copy_pair_parameters(system_id, vc_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- vc_id (str) – (required)
- body (VolumeCopyUpdateRequest) –
Returns: VolumeCopyPair If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.device_asup_api module¶
DeviceASUPApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.device_asup_api.
DeviceASUPApi
(api_client=None)[source]¶ Bases:
object
-
get_all_asup_transmission_log_files
(**kwargs)[source]¶ Retrieve a list of ASUP transimission log files Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_asup_transmission_log_files(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[FileInfo] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_asup_configuration
(**kwargs)[source]¶ Retrieve the device ASUP configuration Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_asup_configuration(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: DeviceAsupResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_asup_information
(**kwargs)[source]¶ Retrieve ASUP information for all storage devices Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_asup_information(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: DeviceAsupDevice If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_asup_transmission_log_file
(filename, **kwargs)[source]¶ Gets an ASUP transmission log file Mode: Embedded only. The response type of this method is a file stream.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_asup_transmission_log_file(filename, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – (required)
Returns: File If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_asup_configuration
(**kwargs)[source]¶ Update the device ASUP configuration Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_asup_configuration(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (DeviceAsupUpdateRequest) –
Returns: DeviceAsupResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
verify_asup_configuration
(**kwargs)[source]¶ Verify a device ASUP configuration Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.verify_asup_configuration(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (DeviceAsupVerifyRequest) –
Returns: DeviceAsupVerifyResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.diagnostics_api module¶
DiagnosticsApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.diagnostics_api.
DiagnosticsApi
(api_client=None)[source]¶ Bases:
object
-
get_alert_configuration
(system_id, **kwargs)[source]¶ Retrieve the device Alerts configuration Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_alert_configuration(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: DeviceAlertConfiguration If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_core_dump_information
(system_id, **kwargs)[source]¶ Get the core dump information Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_core_dump_information(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: DPLCoreDumpData If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_device_diagnostic_data
(system_id, data_request, **kwargs)[source]¶ Return various data about the managed device for diagnostic or display purposes. Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_device_diagnostic_data(system_id, data_request, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- data_request (DiagnosticDataRequest) – Diagnostic data request (required)
Returns: DeviceDataResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_failures
(system_id, **kwargs)[source]¶ Get list of failures Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_failures(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- details (bool) – Whether or not to fetch object data and extra data
Returns: list[FailureData] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_support_data_retrieval_request_status
(system_id, request_id, **kwargs)[source]¶ Retrieve the status of a pending data retrieval request Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_support_data_retrieval_request_status(system_id, request_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- request_id (int) – (required)
Returns: SupportDataResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_syslog_configuration
(system_id, **kwargs)[source]¶ Retrieve the syslog configuration Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_syslog_configuration(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: AlertSyslogConfiguration If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
set_syslog_configuration
(system_id, **kwargs)[source]¶ Update the syslog configuration Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.set_syslog_configuration(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (AlertSyslogConfiguration) –
Returns: AlertSyslogConfiguration If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_support_data_retrieval_request
(system_id, **kwargs)[source]¶ Initiate a support data retrieval request Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_support_data_retrieval_request(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (SupportDataRequest) –
Returns: InitialAsyncResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
test_alert_email
(system_id, **kwargs)[source]¶ Initiate a test email using the array alert settings Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.test_alert_email(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: DeviceAlertTestResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
test_syslog_send
(system_id, **kwargs)[source]¶ Initiate sending test syslog messages using the syslog settings Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.test_syslog_send(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: AlertSyslogResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_alert_configuration
(system_id, update_request, **kwargs)[source]¶ Update the device Alerts configuration Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_alert_configuration(system_id, update_request, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- update_request (DeviceAlertConfiguration) – Alert configuration request (required)
Returns: DeviceAlertConfiguration If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.drive_firmware_api module¶
DriveFirmwareApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.drive_firmware_api.
DriveFirmwareApi
(api_client=None)[source]¶ Bases:
object
-
cancel_drive_firmware_update
(system_id, **kwargs)[source]¶ Cancel the on going update operations. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.cancel_drive_firmware_update(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_drive_firmware_files
(**kwargs)[source]¶ Retrieve list of files in the drive firmware directory Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_drive_firmware_files(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[FileInfo] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_drive_firmware_compatability_check
(system_id, **kwargs)[source]¶ Performs a mini health check and fetchs firmware to drive associations Mode: Both Embedded and Proxy. This is used to determine which drives are compatible with with firmware files that have been previously uploaded.The information returned about the drives also indicates if it can be updated online.This action also performs a mini health check to help determine if there are any storage system conditions that would prevent a firmware update to proceed.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_drive_firmware_compatability_check(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: DriveFirmwareCompatibilityResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_drive_firmware_file
(filename, **kwargs)[source]¶ Gets a file from the drive firmware directory Mode: Both Embedded and Proxy. The response type of this method is a file stream.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_drive_firmware_file(filename, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – The name of the file (required)
- auto_delete (bool) – Automatically remove the file after the retrieval completes
Returns: File If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_drive_firmware_update_status
(system_id, **kwargs)[source]¶ Get the status of the on going update operations. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_drive_firmware_update_status(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: DriveFirmwareStatus If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_drive_firmware_file
(filename, **kwargs)[source]¶ Deletes a drive firmware file Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_drive_firmware_file(filename, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – The name of the file to delete (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_drive_firmware_update
(system_id, body, online_update, **kwargs)[source]¶ Initiate a drive firmware update Mode: Both Embedded and Proxy. The firmware files to be used for the update should be uploaded previously.When the update has been successfully initiated, the firmware files that were uploaded and used in the update will be automatically removedIf there are files uploaded but not used by the update, they not be immediately removed but may be culled later if they remain unused.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_drive_firmware_update(system_id, body, online_update, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (list[DriveFirmwareUpdateEntry]) – Data for which drives to update. (required)
- online_update (bool) – Perform the update with the drives online. (required)
Returns: str If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
upload_drive_firmware_file
(**kwargs)[source]¶ Upload a drive firmware file Mode: Both Embedded and Proxy. Firmware file is uploaded to staging area and referenced in other drive firmware operations. If your multipart form has non-file data, it will be ignored and only the files handled.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.upload_drive_firmware_file(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- file (file) – drive firmware file
Returns: list[FileInfo] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.file_management_api module¶
FileManagementApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.file_management_api.
FileManagementApi
(api_client=None)[source]¶ Bases:
object
-
get_all_support_artifacts
(**kwargs)[source]¶ Retrieve the list of support artifacts by type Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_support_artifacts(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[SupportArtifacts] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_file_from_scratch_dir
(filename, **kwargs)[source]¶ Gets a file from the scratch directory Mode: Both Embedded and Proxy. The response type of this method is a file stream.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_file_from_scratch_dir(filename, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – (required)
- auto_delete (bool) – Automatically remove the file after the retrieval completes
Returns: File If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_scratch_file
(**kwargs)[source]¶ Retrieve a file from the scratch directory Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_scratch_file(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[FileInfo] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_support_artifacts
(identifier, **kwargs)[source]¶ Retrieve a specific support artifact. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_support_artifacts(identifier, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- identifier (str) – (required)
Returns: File If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_scratch_file
(filename, **kwargs)[source]¶ Deletes a generic file Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_scratch_file(filename, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – Name of file to delete (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_support_artifact
(identifier, **kwargs)[source]¶ Deletes a specific support artifact. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_support_artifact(identifier, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- identifier (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
upload_file
(**kwargs)[source]¶ Upload a generic file for later reference in an API call. Mode: Both Embedded and Proxy. If your multipart form has non-file data, it will be ignored and only the files handled.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.upload_file(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- file (file) – file
Returns: list[FileInfo] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.firmware_api module¶
FirmwareApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.firmware_api.
FirmwareApi
(api_client=None)[source]¶ Bases:
object
-
activate_staged_controller_firmware
(system_id, **kwargs)[source]¶ Activate staged controller firmware Mode: Proxy only. Activate Controller Firmware that was previous staged for a later upgrade operation. This operation will begin activation of the uploaded package.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.activate_staged_controller_firmware(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (CfwActivationRequest) –
Returns: CfwUpgradeResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
activate_staged_firmware
(**kwargs)[source]¶ Activates a previously staged Firmware Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.activate_staged_firmware(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
begin_compatibility_check
(**kwargs)[source]¶ Begin a firmware compatibility check operation Mode: Proxy only. This endpoint allows a user to request all firmware and nvsram files that are compatible with a StorageSystem, or list of StorageSystems.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.begin_compatibility_check(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (FirmwareCompatibilityRequest) –
Returns: FirmwareCompatibilityResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
cancel_compatibility_check
(**kwargs)[source]¶ Cancel a firmware compatibility check operation Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.cancel_compatibility_check(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
cancel_health_check
(**kwargs)[source]¶ Cancel a running health check Mode: Both Embedded and Proxy. This operation may take some time to cancel, as pending operations must be completed first.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.cancel_health_check(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
check_embedded_firmware_bundle_compatibility
(system_id, **kwargs)[source]¶ Performs a compatibility check on a controller firmware bundle. Speed up process by sending only first 8KB of file. Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.check_embedded_firmware_bundle_compatibility(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- file (file) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
check_embedded_nvsram_compatibility
(system_id, **kwargs)[source]¶ Performs a compatibility check on a NVSRAM file. Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.check_embedded_nvsram_compatibility(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- file (file) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
clear_staged_firmware
(system_id, **kwargs)[source]¶ Clear staged firmware details on the array Mode: Proxy only. Clear staged firmware details on the storage array
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.clear_staged_firmware(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_firmware_files
(**kwargs)[source]¶ Get the list of firmware files Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_firmware_files(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[CFWPackageMetadata] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_compatibility_check_results
(**kwargs)[source]¶ Request status of a firmware compatibility check operation Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_compatibility_check_results(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- request_id (int) – Retrieve result of a previously submitted request.
Returns: FirmwareCompatibilityResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_controller_firmware_upgrade_status
(system_id, **kwargs)[source]¶ Retrieve status of a Controller Firmware upgrade operation Mode: Proxy only. Retrieve the status of a running controller firmware or nvsram upgrade operation.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_controller_firmware_upgrade_status(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: CfwUpgradeResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_embedded_firmware_information
(**kwargs)[source]¶ Get last successful firmware updgrade timestamps and firmware upgrade logs Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_embedded_firmware_information(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- cfw_upgrade (bool) – Controller Firmware Upgrade
- iom_upgrade (bool) – IOM Firmware Upgrade
- drive_upgrade (bool) – Drive Firmware Upgrade
- include_logs (bool) – Include firmware log
Returns: EmbeddedFirmwareResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_firmware_details
(system_id, **kwargs)[source]¶ Retrieve details on the current firmware Mode: Embedded only. Retrieve the list of code modules and versions of the firmware on the storage array.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_firmware_details(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: CurrentFirmwareResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_firmware_file
(filename, **kwargs)[source]¶ Get a specific firmware file Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_firmware_file(filename, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – (required)
Returns: CFWPackageMetadata If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_health_check_status
(**kwargs)[source]¶ Get health check status Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_health_check_status(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- request_id (int) – Retrieve result of a previously submitted request.
Returns: HealthCheckResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_iom_service_information
(**kwargs)[source]¶ Get IOM service information Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_iom_service_information(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: IomServiceInfoResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_staged_controller_firmware_details
(system_id, **kwargs)[source]¶ Retrieve details on the staged firmware Mode: Embedded only. Retrieve the list of code modules and versions of the firmware staged on the storage array.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_staged_controller_firmware_details(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: StagedFirmwareResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_staged_firmware_details
(system_id, **kwargs)[source]¶ Retrieve details on the staged firmware Mode: Proxy only. Retrieve the list of code modules and versions of the firmware staged on the storage array.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_staged_firmware_details(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: StagedFirmwareResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_firmware_file
(filename, **kwargs)[source]¶ Delete an uploaded firmware file Mode: Proxy only. Delete an uploaded firmware file by providing the filename. If the file is locked the file will be scheduled for deletion on service shutdown.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_firmware_file(filename, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- filename (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_staged_firmware
(system_id, **kwargs)[source]¶ Clear staged firmware details on the array Mode: Embedded only. Clear staged firmware details on the storage array
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_staged_firmware(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_controller_firmware_upgrade
(system_id, **kwargs)[source]¶ Initiate a Controller Firmware upgrade operation Mode: Proxy only. Start a controller firmware or nvsram upgrade operation.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_controller_firmware_upgrade(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (CfwUpgradeRequest) –
Returns: InitialAsyncResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_health_check
(**kwargs)[source]¶ Begin a health check Mode: Both Embedded and Proxy. The health checks are designed to test whether or not a StorageSystem is stable enough to safely allow a firmware upgrade operation to proceed. They can also be used in a generic fashion to probe a large number of StorageSystems for issues requiring attention.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_health_check(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (HealthCheckRequest) –
Returns: InitialAsyncResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_iom_service_information
(**kwargs)[source]¶ Updates the IOM service configuration Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_iom_service_information(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (IomServiceUpdateRequest) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
upload_embedded_firmware_file
(**kwargs)[source]¶ Upload a firmware file. Mode: Embedded only. Upload endpoint for firmware that is not staged but directly loaded to the controller. This endpoint only applies when running embedded, not as a proxy.. File can be named the veosimage or the nvsramimage
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.upload_embedded_firmware_file(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- staged (bool) – set to true to indicate to stage
- nvsram (bool) – set to true to NVSRAM is included, and if so it must be first. If this is true and a DLP file is included, it must be first. If not, an error is generated
- nvsramfile (file) –
- dlpfile (file) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
upload_firmware_file
(firmware_file, **kwargs)[source]¶ Upload a firmware file. Mode: Proxy only. The firmware file will be uploaded to the server and will be available for firmware upgrade operations. It is recommended to keep the file names the same as they were named by the company. Some file types require this and will fail of renamed
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.upload_firmware_file(firmware_file, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- firmware_file (file) – The firmware file (required)
- validate (bool) – Validate firmware file
Returns: FileInfo If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
upload_nvsram_file
(system_id, **kwargs)[source]¶ Upload a nvsram file. Mode: Embedded only. Upload endpoint for nvsram to download to the controller.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.upload_nvsram_file(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- nvsramimage (file) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.flash_cache_api module¶
FlashCacheApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.flash_cache_api.
FlashCacheApi
(api_client=None)[source]¶ Bases:
object
-
get_flash_cache
(system_id, **kwargs)[source]¶ Retrieve the FlashCache, if it exists. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_flash_cache(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_flash_cache_compatible_volumes
(system_id, **kwargs)[source]¶ Retrieve a list of volumes that are compatible with the defined flashCache Mode: Both Embedded and Proxy. Volumes must be compatible with the security and DataAssurance settings of the FlashCache to be added.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_flash_cache_compatible_volumes(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
modify_flash_cache
(system_id, **kwargs)[source]¶ Modify FlashCache parameters Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.modify_flash_cache(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (FlashCacheUpdateRequest) –
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_flash_cache
(system_id, **kwargs)[source]¶ Define a new FlashCache Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_flash_cache(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (FlashCacheCreateRequest) –
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_flash_cache_drives
(system_id, **kwargs)[source]¶ Add drives to an existing FlashCache Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_flash_cache_drives(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (DriveRefList) –
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_flash_cache
(system_id, **kwargs)[source]¶ Delete the defined FlashCache Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_flash_cache(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_flash_cache_drives
(system_id, **kwargs)[source]¶ Remove drives currently being used by the FlashCache Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_flash_cache_drives(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (DriveRefList) –
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
resume_flash_cache
(system_id, **kwargs)[source]¶ Resume a suspended FlashCache Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.resume_flash_cache(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
suspend_flash_cache
(system_id, **kwargs)[source]¶ Suspend the FlashCache Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.suspend_flash_cache(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: FlashCacheEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.hardware_api module¶
HardwareApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.hardware_api.
HardwareApi
(api_client=None)[source]¶ Bases:
object
-
cancel_hardware_identification
(system_id, **kwargs)[source]¶ Cancel any active hardware identification Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.cancel_hardware_identification(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_controllers
(system_id, **kwargs)[source]¶ Get the list of controllers Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_controllers(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[Controller] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_drives
(system_id, **kwargs)[source]¶ Get the list of drives Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_drives(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[DriveEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_controller
(system_id, controller_id, **kwargs)[source]¶ Get a controller Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_controller(system_id, controller_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- controller_id (str) – (required)
Returns: Controller If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_drive
(system_id, id, **kwargs)[source]¶ Get a drive Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_drive(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: DriveEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_drive_connection_info
(system_id, **kwargs)[source]¶ Get connectivity information for drive trays Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_drive_connection_info(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: EsmPortConnectionResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_hardware_information
(system_id, **kwargs)[source]¶ Get hardware information Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_hardware_information(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: HardwareInventoryResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_iscsi_data
(system_id, **kwargs)[source]¶ Get the iSCSI Entity data Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_iscsi_data(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: IscsiEntityResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_iscsi_target
(system_id, **kwargs)[source]¶ Get the iSCSI Target Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_iscsi_target(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: Target If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_unreadable_sectors_list
(system_id, **kwargs)[source]¶ Get the list of unreadable sectors Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_unreadable_sectors_list(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: UnreadableSectorResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
select_drives
(system_id, **kwargs)[source]¶ Select drives for storage-pool creation Mode: Both Embedded and Proxy. Retrieve a list of drives based on provided selection criteria. If the number of drives you have selected is not available based on the request parameters, an empty list is returned.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.select_drives(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (DriveSelectionRequest) –
Returns: list[DriveEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_hardware_identification
(system_id, **kwargs)[source]¶ Start hardware identification Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_hardware_identification(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (IdentificationRequest) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_iscsi_data
(system_id, **kwargs)[source]¶ Update iSCSI Entity data Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_iscsi_data(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (IscsiEntityUpdateRequest) –
Returns: IscsiEntityResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_iscsi_target
(system_id, **kwargs)[source]¶ Update the iSCSI Target Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_iscsi_target(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (IscsiTargetUpdateRequest) –
Returns: IscsiTargetResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.mapping_api module¶
MappingApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.mapping_api.
MappingApi
(api_client=None)[source]¶ Bases:
object
-
get_all_host_groups
(system_id, **kwargs)[source]¶ Get all HostGroups Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_host_groups(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[HostGroup] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_host_port_types
(system_id, **kwargs)[source]¶ Get all HostTypes Mode: Both Embedded and Proxy. DEPRECATED: See /host-types
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_host_port_types(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[HostType] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_host_type_values
(system_id, **kwargs)[source]¶ Get the list of HostTypes Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_host_type_values(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[HostTypeValues] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_host_types
(system_id, **kwargs)[source]¶ Get all HostTypes Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_host_types(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[HostType] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_hosts
(system_id, **kwargs)[source]¶ Get all Hosts Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_hosts(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[HostEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_host
(system_id, id, **kwargs)[source]¶ Get a Host Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_host(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – Get a Host (required)
Returns: HostEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_host_group
(system_id, id, **kwargs)[source]¶ Get a HostGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_host_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – Get a HostGroup (required)
Returns: HostGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_host_port_type
(system_id, id, **kwargs)[source]¶ Get a HostType Mode: Both Embedded and Proxy. DEPRECATED: See /host-types
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_host_port_type(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: HostType If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_host_type
(system_id, id, **kwargs)[source]¶ Get a HostType Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_host_type(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – Het a HostType (required)
Returns: HostType If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_host_type_values
(system_id, index, **kwargs)[source]¶ Get the list of HostTypes Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_host_type_values(system_id, index, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- index (int) – “The value of the index for the desired host type value. This value corresponds to the index attribute of the HostTypeValues model” (required)
Returns: HostTypeValues If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_unassociated_host_ports
(system_id, **kwargs)[source]¶ Get the list of unassociated HostPorts Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_unassociated_host_ports(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[UnassociatedHostPort] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
move_host
(system_id, host_id, **kwargs)[source]¶ Move a Host under a different HostGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.move_host(system_id, host_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- host_id (str) – The id of an existing host entry configured on the specified array (required)
- body (HostMoveRequest) –
Returns: HostEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_host
(system_id, **kwargs)[source]¶ Create a new Host Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_host(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (HostCreateRequest) –
Returns: Host If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_host_group
(system_id, **kwargs)[source]¶ Create a HostGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_host_group(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (HostGroupCreateRequest) –
Returns: HostGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_host
(system_id, id, **kwargs)[source]¶ Delete a Host Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_host(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – Delete a Host (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_host_group
(system_id, id, **kwargs)[source]¶ Delete a HostGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_host_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – Delete a HostGroup (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
set_host_port_type_default
(system_id, **kwargs)[source]¶ Set default HostType Mode: Both Embedded and Proxy. DEPRECATED: See /host-types
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.set_host_port_type_default(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (SingleNumberValue) –
Returns: HostType If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
set_host_type_default
(system_id, **kwargs)[source]¶ Set default HostType Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.set_host_type_default(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (SingleNumberValue) –
Returns: HostType If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_host
(system_id, id, **kwargs)[source]¶ Update the parameters of a Host Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_host(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – Update the parameters of a Host (required)
- body (HostUpdateRequest) –
Returns: HostEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_host_group
(system_id, id, **kwargs)[source]¶ Update a HostGroup Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_host_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – Update a HostGroup (required)
- body (HostGroupUpdateRequest) –
Returns: HostGroup If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.mirroring_api module¶
MirroringApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.mirroring_api.
MirroringApi
(api_client=None)[source]¶ Bases:
object
-
begin_synchronization_amg
(system_id, id, **kwargs)[source]¶ Begin synchronization of an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.begin_synchronization_amg(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (AsyncMirrorGroupSyncRequest) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
complete_incomplete_amg
(system_id, incomplete_mirror_id, **kwargs)[source]¶ Complete an incomplete Async Mirror relationship Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.complete_incomplete_amg(system_id, incomplete_mirror_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- incomplete_mirror_id (str) – (required)
- body (AsyncMirrorGroupMemberCompletionRequest) –
Returns: AmgMember If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_amg_member_repository_stats
(system_id, **kwargs)[source]¶ Retrieve the repository usage statistics for all AmgMembers. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_amg_member_repository_stats(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AsyncMirrorRepositoryUtilization] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_amg_member_volumes
(system_id, mirror_id, **kwargs)[source]¶ Retrieve the member volumes associated with an AMG Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_amg_member_volumes(system_id, mirror_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mirror_id (str) – (required)
Returns: list[AmgMember] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_amg_members
(system_id, **kwargs)[source]¶ Get all Async Mirror Group Members Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_amg_members(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AmgMember] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_amg_sync_progress
(system_id, **kwargs)[source]¶ Retrieve the sync progress of all Async Mirror Groups at once Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_amg_sync_progress(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AsyncMirrorGroupSyncProgress] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_async_mirror_groups
(system_id, **kwargs)[source]¶ Get Async Mirror Groups Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_async_mirror_groups(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[Amg] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_remote_volume_mirrors
(system_id, **kwargs)[source]¶ Get Remote Volume Mirrors Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_remote_volume_mirrors(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[RemoteMirrorPair] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_amg_member
(system_id, id, **kwargs)[source]¶ Get a specific Async Mirror Group Member Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_amg_member(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: AmgMember If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_amg_member_repository_stats
(system_id, id, **kwargs)[source]¶ Retrieve the repository usage statistics for a single AmgMember. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_amg_member_repository_stats(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: AsyncMirrorRepositoryUtilization If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_amg_member_volume
(system_id, mirror_id, id, **kwargs)[source]¶ Retrieve a member volume associated with an AMG Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_amg_member_volume(system_id, mirror_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mirror_id (str) – (required)
- id (str) – (required)
Returns: AmgMember If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_amg_sync_progress
(system_id, mirror_group_id, **kwargs)[source]¶ Retrieve sync progress of an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_amg_sync_progress(system_id, mirror_group_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mirror_group_id (str) – (required)
Returns: AsyncMirrorGroupSyncProgress If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_async_mirror_group
(system_id, id, **kwargs)[source]¶ Get an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_async_mirror_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: Amg If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_async_mirror_storage_system_list
(system_id, **kwargs)[source]¶ Get a list of storage-systems that support Asynchronous Mirroring Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_async_mirror_storage_system_list(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- compatible_only (bool) – Only return storage-systems supporting async mirroring that compatible with the target storage-system.
Returns: list[RemoteCandidate] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_incomplete_amg
(system_id, **kwargs)[source]¶ Get Async Mirror Group relationships that have not yet been completed Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_incomplete_amg(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AmgIncompleteMember] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_incomplete_amg_mirror_id
(system_id, mirror_id, **kwargs)[source]¶ Get Async Mirror Group relationships that have not yet been completed Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_incomplete_amg_mirror_id(system_id, mirror_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mirror_id (str) – (required)
Returns: list[AmgIncompleteMember] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_remote_amg_mirror_connections
(system_id, mirror_group_id, **kwargs)[source]¶ Retrieve the current remote StorageDevice mirroring connections for an Amg Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_remote_amg_mirror_connections(system_id, mirror_group_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mirror_group_id (str) – (required)
Returns: AsyncMirrorConnectionsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_remote_mirror_connections
(system_id, **kwargs)[source]¶ Retrieve the current remote StorageDevice mirroring connections Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_remote_mirror_connections(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AsyncMirrorConnectionsResponse] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_remote_volume_mirror
(system_id, id, **kwargs)[source]¶ Get Remote Volume Mirror Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_remote_volume_mirror(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: RemoteMirrorPair If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_remote_volume_mirror_candidates
(system_id, volume_id, **kwargs)[source]¶ Retrieve potential mirror candidates for a volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_remote_volume_mirror_candidates(system_id, volume_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- volume_id (str) – (required)
Returns: list[RemoteMirrorCandidate] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_remote_volume_mirror_sync_process
(system_id, id, **kwargs)[source]¶ Get Remote Mirror synchronization status Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_remote_volume_mirror_sync_process(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: JobProgress If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_amg_member
(system_id, mirror_id, **kwargs)[source]¶ Add a new member to an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_amg_member(system_id, mirror_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mirror_id (str) – (required)
- body (AsyncMirrorGroupMemberCreateRequest) –
Returns: AmgMember If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_async_mirror_group
(system_id, **kwargs)[source]¶ Create an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_async_mirror_group(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (AsyncMirrorGroupCreateRequest) –
Returns: Amg If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_remote_volume_mirror
(system_id, **kwargs)[source]¶ Create Remote Volume Mirror Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_remote_volume_mirror(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (RemoteVolumeMirrorCreateRequest) –
Returns: RemoteMirrorPair If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_amg_member
(system_id, mirror_id, id, **kwargs)[source]¶ Remove a member from an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_amg_member(system_id, mirror_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mirror_id (str) – (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_async_mirror_group
(system_id, id, **kwargs)[source]¶ Delete an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_async_mirror_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_incomplete_async_mirror_relationship
(system_id, incomplete_mirror_id, **kwargs)[source]¶ Remove an Async Mirror relationship that has not been completed Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_incomplete_async_mirror_relationship(system_id, incomplete_mirror_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- incomplete_mirror_id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_remote_volume_mirror
(system_id, id, **kwargs)[source]¶ Remove a Remote Volume Mirror Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_remote_volume_mirror(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
resume_synchronization_amg
(system_id, id, **kwargs)[source]¶ Resume synchronization of an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.resume_synchronization_amg(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- delete_recovery_point_if_necessary (bool) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
suspend_synchronization_amg
(system_id, id, **kwargs)[source]¶ Suspend synchronization of an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.suspend_synchronization_amg(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
test_connectivity_amg
(system_id, id, **kwargs)[source]¶ Test connectivity of an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.test_connectivity_amg(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (AsyncMirrorGroupConnectivityTestRequest) –
Returns: list[AsyncCommunicationData] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
test_remote_volume_mirror_communication
(system_id, id, **kwargs)[source]¶ Test Remote Mirror Communication Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.test_remote_volume_mirror_communication(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: RemoteCommunicationData If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_async_mirror_group
(system_id, id, **kwargs)[source]¶ Update an Async Mirror Group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_async_mirror_group(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (AsyncMirrorGroupUpdateRequest) –
Returns: Amg If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_mirror_role_amg
(system_id, id, **kwargs)[source]¶ Update the mirror role of an Async Mirror Group. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_mirror_role_amg(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (AsyncMirrorGroupRoleUpdateRequest) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_remote_volume_mirror
(system_id, id, **kwargs)[source]¶ Update a Remote Volume Mirror Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_remote_volume_mirror(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (RemoteVolumeMirrorUpdateRequest) –
Returns: RemoteMirrorPair If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.monitoring_api module¶
MonitoringApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.monitoring_api.
MonitoringApi
(api_client=None)[source]¶ Bases:
object
-
clear_mel_events
(system_id, **kwargs)[source]¶ Clear MelEvents Mode: Both Embedded and Proxy. Gives the user the ability to clear the event cache and the EventLog directly on the StorageDevice.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.clear_mel_events(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- clear_cache (bool) –
- reset_mel (bool) – Reset the EventLog on the StorageDevice
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_global_status_events
(**kwargs)[source]¶ Get all global status events Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_global_status_events(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- last_known (int) – The sequence number of the last event you have received
- wait (int) – seconds to wait for a new event
Returns: list[Event] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_storage_device_status_events
(system_id, **kwargs)[source]¶ Get the list of status Events for the StorageDevice Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_storage_device_status_events(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- last_known (int) –
- wait (int) – Amount of time to wait for a new event
Returns: list[Event] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_event_availability
(system_id, **kwargs)[source]¶ Check the oldest and newest available events Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_event_availability(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- cache_only (bool) – Only retrieve events currently in the cache
Returns: MelExtent If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_log_messages
(system_id, **kwargs)[source]¶ Get a list of log messages for based on input values. Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_log_messages(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- logger_type (str) – LoggerType to retrieve records for
- start_record (int) – Starting record number
- ending_record (int) – Ending record number
Returns: LoggerRecordResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_mel_events
(system_id, **kwargs)[source]¶ Retrieve MelEvents Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_mel_events(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- start_sequence_number (int) –
- count (int) – Maximum number to retrieve
- critical (bool) – Only retrieve events classified as critical
- include_debug (bool) – Whether or not to retrieve debug entries
Returns: list[MelEntryEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.service_catalog_api module¶
ServiceCatalogApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.service_catalog_api.
ServiceCatalogApi
(api_client=None)[source]¶ Bases:
object
-
get_all_pools
(system_id, **kwargs)[source]¶ Retrieve the list of pools Mode: Both Embedded and Proxy. Retrieve the list of pools and their service quality features. The list is sorted in descending order by the largest block of freeSpace that each has available.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_pools(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[PoolQosResponse] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_ssc_volumes
(system_id, **kwargs)[source]¶ Retrieve the list of volumes Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_ssc_volumes(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: list[UserVolume] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_pool
(system_id, pool_id, **kwargs)[source]¶ Retrieve a pool by name or ID Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_pool(system_id, pool_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- pool_id (str) – (required)
Returns: PoolQosResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_ssc_volume
(system_id, volume_id, **kwargs)[source]¶ Retrieve a volume by id or label Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_ssc_volume(system_id, volume_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- volume_id (str) – (required)
Returns: UserVolume If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_ssc_volume
(system_id, **kwargs)[source]¶ Define a new volume and configure its QOS parameters Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_ssc_volume(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- body (SscVolumeCreateRequest) –
Returns: UserVolume If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_ssc_volume
(system_id, volume_id, **kwargs)[source]¶ Delete a volume by id or label Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_ssc_volume(system_id, volume_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- volume_id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_ssc_volume
(system_id, volume_id, **kwargs)[source]¶ Update an existing volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_ssc_volume(system_id, volume_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- volume_id (str) – (required)
- body (SscVolumeUpdateRequest) –
Returns: UserVolume If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.statistics_api module¶
StatisticsApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.statistics_api.
StatisticsApi
(api_client=None)[source]¶ Bases:
object
-
get_all_analysed_controller_statistics
(system_id, **kwargs)[source]¶ Get all analysed controller statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_analysed_controller_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AnalysedControllerStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_analysed_drive_statistics
(system_id, **kwargs)[source]¶ Get all analysed disk statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_analysed_drive_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AnalysedDiskStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_analysed_interface_statistics
(system_id, **kwargs)[source]¶ Get all analysed controller statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_analysed_interface_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AnalyzedInterfaceStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_analysed_volume_statistics
(system_id, idlist, **kwargs)[source]¶ Get all analysed volume statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_analysed_volume_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (str) – A comma separated list of volume ids (required)
Returns: list[AnalysedVolumeStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_historical_raw_performance_statistics
(system_id, **kwargs)[source]¶ Get historical performance raw statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_historical_raw_performance_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- type (str) – Statistics type
- start (int) – start time in milliseconds since the epoch
- end (int) – end time in milliseconds since the epoch
- length (int) – Length of time in ms.
Returns: RawStatsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_live_performance_statistics
(system_id, **kwargs)[source]¶ Get Live performance statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_live_performance_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- type (str) – Statistics type
Returns: RawStatsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_raw_disk_statistics
(system_id, **kwargs)[source]¶ Get raw disk statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_raw_disk_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- usecache (bool) –
Returns: list[DiskIOStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_raw_volume_statistics
(system_id, **kwargs)[source]¶ Get raw volume statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_raw_volume_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- usecache (bool) –
Returns: list[VolumeIOStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_analysed_controller_statistics
(system_id, idlist, **kwargs)[source]¶ Get a subset of analysed controller statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_analysed_controller_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of controller id’s (required)
Returns: list[AnalysedControllerStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_analysed_drive_statistics
(system_id, idlist, **kwargs)[source]¶ Get a subset of analysed disk statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_analysed_drive_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of disk ids (required)
Returns: list[AnalysedDiskStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_analysed_volume_statistics
(system_id, **kwargs)[source]¶ Get a subset of the analysed volume statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_analysed_volume_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[AnalysedVolumeStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_analyzed_interface_stats
(system_id, idlist, **kwargs)[source]¶ Get a subset of analysed controller statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_analyzed_interface_stats(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of interface id’s (required)
Returns: list[AnalyzedInterfaceStatistics] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_average_analyzed_statistics_types
(system_id, **kwargs)[source]¶ Get the list supported average analyzed statistics types Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_average_analyzed_statistics_types(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[str] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_averaged_historical_performance_statistics
(system_id, **kwargs)[source]¶ Get historical performance statistics averaged over a time range. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_averaged_historical_performance_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- type (str) – Statistics type
- length (int) – Length of time in ms.
Returns: AverageAnalysedStatsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_historical_performance_statistics
(system_id, **kwargs)[source]¶ Get historical performance statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_historical_performance_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- type (str) – Statistics type
- start (int) – start time in milliseconds since the epoch
- end (int) – end time in milliseconds since the epoch
Returns: HistoricalStatsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_historical_raw_performance_statistics
(system_id, idlist, **kwargs)[source]¶ Get selected historical performance raw statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_historical_raw_performance_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of object ids (required)
- type (str) – Statistics type
- start (int) – start time in milliseconds since the epoch
- end (int) – end time in milliseconds since the epoch
- length (int) – Length of time in ms.
Returns: RawStatsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_live_performance_statistics
(system_id, idlist, **kwargs)[source]¶ Get selected Live performance statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_live_performance_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of object ids (required)
- type (str) – Statistics type
Returns: RawStatsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_raw_controller_statistics
(system_id, **kwargs)[source]¶ Get raw controller statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_raw_controller_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- usecache (bool) –
Returns: list[ControllerStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_raw_controller_statistics_using_list
(system_id, idlist, **kwargs)[source]¶ Get raw controller statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_raw_controller_statistics_using_list(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- idlist (list[str]) – A comma separated list of controller id’s (required)
- usecache (bool) –
Returns: list[ControllerStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_raw_disk_statistics
(system_id, idlist, **kwargs)[source]¶ Get a subset of the raw disk statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_raw_disk_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of disk ids (required)
- usecache (bool) –
Returns: list[DiskIOStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_raw_interface_statistics
(system_id, **kwargs)[source]¶ Get raw interface statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_raw_interface_statistics(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- usecache (bool) –
Returns: list[InterfaceStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_raw_interface_statistics_with_list
(system_id, idlist, **kwargs)[source]¶ Get raw controller statistics Mode: Embedded only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_raw_interface_statistics_with_list(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
- idlist (list[str]) – A comma separated list of controller id’s (required)
- usecache (bool) –
Returns: list[InterfaceStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_raw_statistics_types
(system_id, **kwargs)[source]¶ Get the list supported raw statistics types Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_raw_statistics_types(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[str] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_raw_volume_statistics
(system_id, idlist, **kwargs)[source]¶ Get raw volume statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_raw_volume_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of volume ids (required)
- usecache (bool) –
Returns: list[VolumeIOStats] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_selected_historical_performance_statistics
(system_id, idlist, **kwargs)[source]¶ Get selected historical performance statistics Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_selected_historical_performance_statistics(system_id, idlist, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- idlist (list[str]) – A comma separated list of object ids (required)
- type (str) – Statistics type
- start (int) – start time in milliseconds since the epoch
- end (int) – end time in milliseconds since the epoch
Returns: HistoricalStatsResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_supported_statistics_types
(system_id, **kwargs)[source]¶ Get the list supported statistics types Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_supported_statistics_types(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[str] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.storage_systems_api module¶
StorageSystemsApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.storage_systems_api.
StorageSystemsApi
(api_client=None)[source]¶ Bases:
object
-
cancel_discovery_operation
(**kwargs)[source]¶ Cancel discovery operation Proxy Only. Cancel a running discovery operation.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.cancel_discovery_operation(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
configure_ethernet_interfaces
(system_id, **kwargs)[source]¶ Configure the ethernet management connections on a controller Mode: Both Embedded and Proxy. Update the ethernet management connection configuration. <br> This operation can lead to an inaccessible controller if performed incorrectly or if incorrect ip addresses, gateway addresses, etc, are provided. Configuration is performed by connecting to the alternate controller, so it must be accessible for the operation to succeed.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.configure_ethernet_interfaces(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (ManagementConfigurationRequest) –
Returns: ManagementInterface If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
discover_storage_devices
(**kwargs)[source]¶ Discover StorageDevices on the network Mode: Proxy only. Initiate a discovery operation on a range of IP addresses. Retrieve the results using a GET.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.discover_storage_devices(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (DiscoveryStartRequest) –
Returns: DiscoverResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
enable_feature_pack
(system_id, key_file, **kwargs)[source]¶ Enable a feature pack. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.enable_feature_pack(system_id, key_file, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- key_file (file) – The bundle key file (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
Enable a premium feature. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.enable_premium_feature(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- key_file (file) – The premium feature key file
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_folders
(**kwargs)[source]¶ Get all Folders Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_folders(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[Folder] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_storage_systems
(**kwargs)[source]¶ Get list of storage-systems Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_storage_systems(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: list[StorageSystemResponse] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_discovery_results
(**kwargs)[source]¶ Get discovery results Mode: Proxy only. Retrieve the results of a discovery operation on a range of IP addresses. Recent previous results can be retrieved using their requestId.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_discovery_results(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- request_id (int) –
Returns: DiscoverResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_ethernet_interfaces
(system_id, **kwargs)[source]¶ Get the list of ethernet interfaces Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_ethernet_interfaces(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[ManagementInterface] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_filtered_object_graph
(system_id, **kwargs)[source]¶ Retrieve one or more elements from the ObjectGraph using an XPath expression. Mode: Both Embedded and Proxy. This method is used to query the ObjectGraph for one or more elements. <br/> <b>Examples:</b> <br/> <ul><li>Retrieve the list of drives: /drive </li> <li>Locate all instances of an attribute called “id”: //id </li> <li>Find a thinVolume with an id of “1”: /highLevelVolBundle/thinVolume[id=”1”]</li><li>Find all thin volumes and volumes inefficiently: //volume | //thinVolume</li><li>Get the NSVRAM version from saData: /sa/saData/nvsramVersion</li></ul><b>References: </b> http://www.w3schools.com/xsl/xpath_intro.asp
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_filtered_object_graph(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- query (str) –
Returns: list[object] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_folder
(folder_id, **kwargs)[source]¶ Get a Folder Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_folder(folder_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- folder_id (str) – (required)
Returns: Folder If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_lockdown_status_response
(system_id, **kwargs)[source]¶ Retrieve information about the storage system lockdown status. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_lockdown_status_response(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – (required)
Returns: LockdownStatusResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_object_graph
(system_id, **kwargs)[source]¶ Retrieve the ObjectGraph, which contains all configuration details for the storage-system. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_object_graph(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: ObjectBundle If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_password_status
(system_id, **kwargs)[source]¶ Get the password status of the StorageDevice Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_password_status(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: PasswordStatusResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_storage_device_with_folder
(folder_id, **kwargs)[source]¶ Get StorageDevices associated with a Folder Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_storage_device_with_folder(folder_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- folder_id (str) – (required)
Returns: list[str] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_storage_system
(system_id, **kwargs)[source]¶ Get a specific storage-system Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_storage_system(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: StorageSystemResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_storage_system_capabilities
(system_id, **kwargs)[source]¶ Get StorageDevice capabilities. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_storage_system_capabilities(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: CapabilitiesResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_folder
(**kwargs)[source]¶ Create a Folder Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_folder(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (FolderCreateRequest) –
Returns: Folder If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_storage_system
(**kwargs)[source]¶ Add a storage-system Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_storage_system(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- body (StorageSystemCreateRequest) –
Returns: AddStorageSystemReturn If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_feature_pack
(system_id, **kwargs)[source]¶ Remove all feature packs. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_feature_pack(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_folder
(folder_id, **kwargs)[source]¶ Delete a Folder Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_folder(folder_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- folder_id (str) – (required)
Returns: CallResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
Remove a premium feature. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_premium_feature(system_id, capability, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- capability (str) – Capability to remove. (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_storage_system
(system_id, **kwargs)[source]¶ Remove one or more storage-systems. The path is a comma seperated list of IDs Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_storage_system(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
set_password
(system_id, **kwargs)[source]¶ Set the password of the StorageDevice Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.set_password(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (PasswordSetRequest) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_folder
(folder_id, **kwargs)[source]¶ Update a Folder Mode: Proxy only.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_folder(folder_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- folder_id (str) – (required)
- body (FolderUpdateRequest) –
Returns: Folder If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_storage_device_name
(system_id, **kwargs)[source]¶ Set the name of the StorageDevice Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_storage_device_name(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (StorageSystemConfigUpdateRequest) –
Returns: StorageSystemConfigResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_storage_system
(system_id, update_request, **kwargs)[source]¶ Update a storage-system Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_storage_system(system_id, update_request, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- update_request (StorageSystemUpdateRequest) – Update request (required)
Returns: StorageSystemResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
validate_storage_system_password
(system_id, **kwargs)[source]¶ Validate the stored password for a storage-system Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.validate_storage_system_password(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.upgrade_api module¶
UpgradeApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.upgrade_api.
UpgradeApi
(api_client=None)[source]¶ Bases:
object
-
get_software_versions
(**kwargs)[source]¶ This operation returns version information for the software that is currently running (same as /utils/about) and the version of any staged updates. If there are no updates, the array of version data is empty. Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_software_versions(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: SoftwareVersions If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_software_download
(**kwargs)[source]¶ Starts a download of software updates from the update server to the staging area.<br> This operation runs asynchronously. A set of events are posted to the event queue devmgr/v2/events that indicate the status of the process Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_software_download(callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- force (str) –
Returns: UpgradeManagerResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_software_reload
(**kwargs)[source]¶ Starts a reload of the software. If any updates are downloaded, they will be loaded.<br> This operation runs asynchronously. A set of events are posted to the event queue devmgr/v2/events that indicate the status of the process Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_software_reload(callback=callback_function)
Parameters: function (callback) – The callback function for asynchronous request. (optional)
Returns: UpgradeManagerResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.volumes_api module¶
VolumesApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.volumes_api.
VolumesApi
(api_client=None)[source]¶ Bases:
object
-
change_raid_type
(system_id, id, **kwargs)[source]¶ Perform a RAID type migration on a storage pool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.change_raid_type(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (RaidMigrationRequest) –
Returns: VolumeGroupEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
expand_storage_pool_capacity
(system_id, pool_id, **kwargs)[source]¶ Expand the capacity of a StoragePool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.expand_storage_pool_capacity(system_id, pool_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- pool_id (str) – Storage pool id (required)
- body (StoragePoolExpansionRequest) –
Returns: VolumeGroupEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
expand_thin_volume
(system_id, id, **kwargs)[source]¶ Expand a ThinVolume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.expand_thin_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (ThinVolumeExpansionRequest) –
Returns: ThinVolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
expand_thin_volume_capacity_old
(system_id, id, **kwargs)[source]¶ Deprecated since version NOTE:: This method has been DEPRECATED
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.expand_thin_volume_capacity_old(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (ThinVolumeExpansionRequest) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
export_fde_key
(system_id, **kwargs)[source]¶ Export a full disk encryption key Mode: Both Embedded and Proxy. The response type of this method is a file stream. Use secure pass phrase for additional security instead of pass phrase.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.export_fde_key(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- pass_phrase (str) – Pass phrase
- file_name (str) – File name
Returns: File If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_access_volume
(system_id, **kwargs)[source]¶ Get the access volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_access_volume(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: AccessVolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_lun_mappings
(system_id, **kwargs)[source]¶ Retrieve the list of LunMappings Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_lun_mappings(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[LUNMapping] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_mappable_objects
(system_id, **kwargs)[source]¶ Get a list of all mappable objects Mode: Both Embedded and Proxy. Provides a simplified way to discover the type of mappable object from an id/reference.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_mappable_objects(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[MappableObject] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_storage_pools
(system_id, **kwargs)[source]¶ Get list of storage pools Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_storage_pools(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[VolumeGroupEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_thin_volumes
(system_id, **kwargs)[source]¶ Get the list of ThinVolumes Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_thin_volumes(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[ThinVolumeEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_volumes
(system_id, **kwargs)[source]¶ Get the list of volumes Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_volumes(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[VolumeEx] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_lun_mapping
(system_id, id, **kwargs)[source]¶ Retrieve a LunMapping Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_lun_mapping(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: LUNMapping If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_mappable_object
(system_id, id, **kwargs)[source]¶ Get a specific mappable object Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_mappable_object(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: MappableObject If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_storage_pool
(system_id, id, **kwargs)[source]¶ Get a storage pool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_storage_pool(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: VolumeGroupEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_storage_pool_expansion_candidates
(system_id, pool_id, **kwargs)[source]¶ Retrieve a list of expansion candidates for a StoragePool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_storage_pool_expansion_candidates(system_id, pool_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- pool_id (str) – Storage pool id (required)
Returns: list[VolumeGroupExpansionCandidate] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_storage_pool_progress
(system_id, id, **kwargs)[source]¶ Check the progress of a long-running action on a storage pool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_storage_pool_progress(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: list[OperationProgress] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_storage_pool_removable_drives
(system_id, id, **kwargs)[source]¶ Get maximum number of drives that can be removed from a StoragePool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_storage_pool_removable_drives(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: RemovableDriveResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_thin_volume
(system_id, id, **kwargs)[source]¶ Get a ThinVolume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_thin_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: ThinVolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_thin_volume2
(system_id, id, **kwargs)[source]¶ Deprecated since version NOTE:: This method has been DEPRECATED
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_thin_volume2(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_thin_volumes2
(system_id, **kwargs)[source]¶ Deprecated since version NOTE:: This method has been DEPRECATED
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_thin_volumes2(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_volume
(system_id, id, **kwargs)[source]¶ Get a specific volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: VolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_volume_expansion_progress
(system_id, id, **kwargs)[source]¶ Get the volume expansion progress Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_volume_expansion_progress(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: VolumeActionProgressResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_volume_expansion_progress2
(system_id, id, **kwargs)[source]¶ Deprecated since version NOTE:: This method has been DEPRECATED
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_volume_expansion_progress2(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
import_fde_key
(system_id, **kwargs)[source]¶ Import a full disk encryption key Mode: Both Embedded and Proxy. Use secure pass phrase for additional security instead of pass phrase.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.import_fde_key(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- pass_phrase (str) – Pass phrase
- keyfile (file) – file
- secure_pass_phrase (str) – Secure pass phrase
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
initialize_thin_volume
(system_id, thin_volume_id, **kwargs)[source]¶ Initialize a ThinVolume Mode: Both Embedded and Proxy. Reinitialize the target thin volume, wiping out all existing data!
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.initialize_thin_volume(system_id, thin_volume_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- thin_volume_id (str) – (required)
Returns: ThinVolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
initialize_volume
(system_id, volume_id, **kwargs)[source]¶ Initialize a volume Mode: Both Embedded and Proxy. This procedure causes the specified volume to be re-initialized. All data that is currently present on the volume will be irretrievably lost as a result of this operation. Once a format operation starts, the volume’s action field will be changed to ‘initializing’; the getVolumeActionProgress procedure can then be used to monitor the progress of the operation. Volume format operations are typically required only when reviving a volume that has been marked failed for some reason. Newly-created volumes need not be explicitly formatted using this procedure.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.initialize_volume(system_id, volume_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- volume_id (str) – (required)
Returns: VolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
move_lun_mapping
(system_id, mapping_id, **kwargs)[source]¶ Move a LunMapping to a different host or host group Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.move_lun_mapping(system_id, mapping_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- mapping_id (str) – (required)
- body (VolumeMappingMoveRequest) –
Returns: LUNMapping If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_fde_key
(system_id, **kwargs)[source]¶ Create or change a full disk encryption key Mode: Both Embedded and Proxy. The result of this method is the creation of a new key file. Retrieve with the /file/{filename} endpoint.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_fde_key(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (SecureVolumeKeyRequest) –
Returns: SecureVolumeKeyResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_lun_mapping
(system_id, **kwargs)[source]¶ Create a new LunMapping Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_lun_mapping(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (VolumeMappingCreateRequest) –
Returns: LUNMapping If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_storage_pool
(system_id, **kwargs)[source]¶ Create a storage pool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_storage_pool(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (StoragePoolCreateRequest) –
Returns: VolumeGroupEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_thin_volume
(system_id, **kwargs)[source]¶ Create a ThinVolume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_thin_volume(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (ThinVolumeCreateRequest) –
Returns: ThinVolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_volume
(system_id, **kwargs)[source]¶ Create a new volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_volume(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- body (VolumeCreateRequest) –
Returns: VolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_lun_mapping
(system_id, id, **kwargs)[source]¶ Remove a LunMapping Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_lun_mapping(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_storage_pool
(system_id, id, **kwargs)[source]¶ Delete a storage pool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_storage_pool(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- delete_volumes (bool) – Automatically delete all owned volumes when a delete request is received.
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_storage_pool_drive
(system_id, id, **kwargs)[source]¶ Reduce the number of drives of a StoragePool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_storage_pool_drive(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (DiskPoolReductionRequest) –
Returns: VolumeGroupEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_thin_volume
(system_id, id, **kwargs)[source]¶ Delete a ThinVolume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_thin_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_volume
(system_id, id, **kwargs)[source]¶ Delete a volume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_volume_expansion
(system_id, id, **kwargs)[source]¶ Start the volume expansion Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_volume_expansion(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (VolumeExpansionRequest) –
Returns: VolumeActionProgressResponse If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
start_volume_expansion2
(system_id, id, **kwargs)[source]¶ Deprecated since version NOTE:: This method has been DEPRECATED
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.start_volume_expansion2(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (VolumeExpansionRequest) –
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_storage_pool
(system_id, id, request, **kwargs)[source]¶ Update a storage pool Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_storage_pool(system_id, id, request, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- request (StoragePoolUpdateRequest) – (required)
Returns: VolumeGroupEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_thin_volume
(system_id, id, **kwargs)[source]¶ Update a ThinVolume Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_thin_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (ThinVolumeUpdateRequest) –
Returns: ThinVolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_volume
(system_id, id, **kwargs)[source]¶ Update volume parameters Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_volume(system_id, id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- id (str) – (required)
- body (VolumeUpdateRequest) –
Returns: VolumeEx If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
validate_fde_key
(system_id, keyfile, **kwargs)[source]¶ Validate a full disk encryption key Mode: Both Embedded and Proxy. Use secure pass phrase for additional security instead of pass phrase.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.validate_fde_key(system_id, keyfile, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- keyfile (file) – file (required)
- pass_phrase (str) – Pass phrase
- secure_pass_phrase (str) – Secure pass phrase
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
netapp.santricity.api.v2.workloads_api module¶
WorkloadsApi.py
The Clear BSD License
Copyright (c) – 2016, NetApp, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of NetApp, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY’S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class
netapp.santricity.api.v2.workloads_api.
WorkloadsApi
(api_client=None)[source]¶ Bases:
object
-
copy_workload
(system_id, workload_id, data, **kwargs)[source]¶ Create a copy of an existing workload Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.copy_workload(system_id, workload_id, data, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- workload_id (str) – (required)
- data (WorkloadCopyRequest) – Name for the new workload (required)
Returns: WorkloadModel If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_all_defined_workloads
(system_id, **kwargs)[source]¶ Get all defined workloads Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_all_defined_workloads(system_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
Returns: list[WorkloadModel] If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
get_defined_workloads
(system_id, workload_id, **kwargs)[source]¶ Get a given defined workload Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.get_defined_workloads(system_id, workload_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- workload_id (str) – (required)
Returns: WorkloadModel If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
new_workload
(system_id, data, **kwargs)[source]¶ Create a workload Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.new_workload(system_id, data, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- data (WorkloadCreateRequest) – (required)
Returns: WorkloadModel If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
remove_workload
(system_id, workload_id, **kwargs)[source]¶ Delete a workload Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.remove_workload(system_id, workload_id, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- workload_id (str) – (required)
Returns: None If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-
update_workload
(system_id, workload_id, data, **kwargs)[source]¶ Modify an existing workload Mode: Both Embedded and Proxy.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>
>>> thread = api.update_workload(system_id, workload_id, data, callback=callback_function)
Parameters: - function (callback) – The callback function for asynchronous request. (optional)
- system_id (str) – The id of the storage-system (required)
- workload_id (str) – (required)
- data (WorkloadUpdateRequest) – (required)
Returns: WorkloadModel If the method is called asynchronously, returns the request thread.
Raises: - ValueError
If the required params are not provided or if the response data format is unknown.
- TypeError:
When the data type of response data is different from what we are expecting
- ApiException:
Occurs when we get a HTTP error code (422 and above).
-