netapp.santricity.api.utils package

Submodules

netapp.santricity.api.utils.about_api module

AboutApi.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.utils.about_api.AboutApi(api_client=None)[source]

Bases: object

get_about_response(**kwargs)[source]

Retrieve information about the running Webservice. 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_about_response(callback=callback_function)
Parameters:

function (callback) – The callback function for asynchronous request. (optional)
Returns:

AboutResponse If the method is called asynchronously, returns the request thread.
Raises:
ValueError

If the required params are not provided or if the response data format is unknown.

TypeError:

When the 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.utils.build_info_api module

BuildInfoApi.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.utils.build_info_api.BuildInfoApi(api_client=None)[source]

Bases: object

get_web_server_build_information(**kwargs)[source]

Retrieve web server component build 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_web_server_build_information(callback=callback_function)
Parameters:

function (callback) – The callback function for asynchronous request. (optional)
Returns:

BuildInfoResponse If the method is called asynchronously, returns the request thread.
Raises:
ValueError

If the required params are not provided or if the response data format is unknown.

TypeError:

When the 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.utils.login_api module

LoginApi.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.utils.login_api.LoginApi(api_client=None)[source]

Bases: object

logout(**kwargs)[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.logout(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).
perform_manual_login(login_request, **kwargs)[source]

Perform a manual login

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>

>>> thread = api.perform_manual_login(login_request, callback=callback_function)
Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • login_request (LoginRequest) – (required)
Returns:

LoginResponse If the method is called asynchronously, returns the request thread.
Raises:
ValueError

If the required params are not provided or if the response data format is unknown.

TypeError:

When the data type of response data is different from what we are expecting

ApiException:

Occurs when we get a HTTP error code (422 and above).
perform_manual_login_state_check(**kwargs)[source]

Perform a manual login or check login state

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>>

>>> thread = api.perform_manual_login_state_check(callback=callback_function)
Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)
  • uid (str) – userId
  • pwd (str) – password
  • xsrf (str) – XSRF protected
  • onlycheck (bool) – Only check login status
Returns:

LoginResponse If the method is called asynchronously, returns the request thread.
Raises:
ValueError

If the required params are not provided or if the response data format is unknown.

TypeError:

When the data type of response data is different from what we are expecting

ApiException:

Occurs when we get a HTTP error code (422 and above).

Module contents