kowabunga.NfsApi

All URIs are relative to https://raw.githubusercontent.com/api/v1

Method	HTTP request	Description
delete_storage_nfs	DELETE /nfs/{nfsId}
list_storage_nfs_kylos	GET /nfs/{nfsId}/kylo
list_storage_nfss	GET /nfs
read_storage_nfs	GET /nfs/{nfsId}
update_storage_nfs	PUT /nfs/{nfsId}

delete_storage_nfs

delete_storage_nfs(nfs_id)

Deletes an existing NFS storage.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/v1"
)

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

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.NfsApi(api_client)
    nfs_id = 'nfs_id_example' # str | The ID of the NFS storage.

    try:
        api_instance.delete_storage_nfs(nfs_id)
    except Exception as e:
        print("Exception when calling NfsApi->delete_storage_nfs: %s\n" % e)

Parameters

Name	Type	Description	Notes
nfs_id	str	The ID of the NFS storage.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The NFS storage has been successfully removed.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
409	Conflict error: A similar resource already exists or resource is still being referenced somewhere.	-
422	UnprocessableEntity error: Server can't process request.	-

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

list_storage_nfs_kylos

List[str] list_storage_nfs_kylos(nfs_id)

Returns the IDs of Kylo objects.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/v1"
)

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

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.NfsApi(api_client)
    nfs_id = 'nfs_id_example' # str | The ID of the NFS storage.

    try:
        api_response = api_instance.list_storage_nfs_kylos(nfs_id)
        print("The response of NfsApi->list_storage_nfs_kylos:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NfsApi->list_storage_nfs_kylos: %s\n" % e)

Parameters

Name	Type	Description	Notes
nfs_id	str	The ID of the NFS storage.

Return type

List[str]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns an array of Kylo IDs.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-

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

list_storage_nfss

List[str] list_storage_nfss()

Returns the IDs of NFS storage objects.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/v1"
)

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

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.NfsApi(api_client)

    try:
        api_response = api_instance.list_storage_nfss()
        print("The response of NfsApi->list_storage_nfss:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NfsApi->list_storage_nfss: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns an array of NFS storage IDs.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-

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

read_storage_nfs

StorageNFS read_storage_nfs(nfs_id)

Returns a NFS storage.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.models.storage_nfs import StorageNFS
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/v1"
)

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

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.NfsApi(api_client)
    nfs_id = 'nfs_id_example' # str | The ID of the NFS storage.

    try:
        api_response = api_instance.read_storage_nfs(nfs_id)
        print("The response of NfsApi->read_storage_nfs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NfsApi->read_storage_nfs: %s\n" % e)

Parameters

Name	Type	Description	Notes
nfs_id	str	The ID of the NFS storage.

Return type

StorageNFS

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the NFS storage object.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-

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

update_storage_nfs

StorageNFS update_storage_nfs(nfs_id, storage_nfs)

Updates a NFS storage configuration.

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (BearerAuth):

import kowabunga
from kowabunga.models.storage_nfs import StorageNFS
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/v1"
)

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

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.NfsApi(api_client)
    nfs_id = 'nfs_id_example' # str | The ID of the NFS storage.
    storage_nfs = kowabunga.StorageNFS() # StorageNFS | StorageNFS payload.

    try:
        api_response = api_instance.update_storage_nfs(nfs_id, storage_nfs)
        print("The response of NfsApi->update_storage_nfs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NfsApi->update_storage_nfs: %s\n" % e)

Parameters

Name	Type	Description	Notes
nfs_id	str	The ID of the NFS storage.
storage_nfs	StorageNFS	StorageNFS payload.

Return type

StorageNFS

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns the NFS storage object.	-
400	BadRequest error: Bad request (wrong input parameters).	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-
507	InsufficientResource error: Server can't allocate resources (logical quotas or physical limits hit).	-

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

kowabunga.NfsApi

delete_storage_nfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_storage_nfs_kylos

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_storage_nfss

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_storage_nfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_storage_nfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

Uh oh!

FilesExpand file tree

NfsApi.md

Latest commit

History

NfsApi.md

File metadata and controls

kowabunga.NfsApi

delete_storage_nfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_storage_nfs_kylos

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_storage_nfss

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_storage_nfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_storage_nfs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details