ReadonlyApi.md

nexuscli.ReadonlyApi

All URIs are relative to https://localhost/service/siesta/

Method	HTTP request	Description
force_release	POST /rest/beta/read-only/force-release	Forcibly release read-only
freeze	POST /rest/beta/read-only/freeze	Enable read-only
get	GET /rest/beta/read-only	Get read-only state
release	POST /rest/beta/read-only/release	Release read-only

force_release

force_release()

Forcibly release read-only

Forcibly release read-only status, including System initiated tasks. Warning: may result in data loss.

Example

from __future__ import print_function
import time
import nexuscli
from nexuscli.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
nexuscli.configuration.username = 'YOUR_USERNAME'
nexuscli.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = nexuscli.ReadonlyApi()

try: 
    # Forcibly release read-only
    api_instance.force_release()
except ApiException as e:
    print("Exception when calling ReadonlyApi->force_release: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

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

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

freeze

freeze()

Enable read-only

Example

from __future__ import print_function
import time
import nexuscli
from nexuscli.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
nexuscli.configuration.username = 'YOUR_USERNAME'
nexuscli.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = nexuscli.ReadonlyApi()

try: 
    # Enable read-only
    api_instance.freeze()
except ApiException as e:
    print("Exception when calling ReadonlyApi->freeze: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

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

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

get

ReadOnlyState get()

Get read-only state

Example

from __future__ import print_function
import time
import nexuscli
from nexuscli.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
nexuscli.configuration.username = 'YOUR_USERNAME'
nexuscli.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = nexuscli.ReadonlyApi()

try: 
    # Get read-only state
    api_response = api_instance.get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReadonlyApi->get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ReadOnlyState

Authorization

basicAuth

HTTP request headers

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

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

release

release()

Release read-only

Release administrator initiated read-only status. Will not release read-only caused by system tasks.

Example

from __future__ import print_function
import time
import nexuscli
from nexuscli.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
nexuscli.configuration.username = 'YOUR_USERNAME'
nexuscli.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = nexuscli.ReadonlyApi()

try: 
    # Release read-only
    api_instance.release()
except ApiException as e:
    print("Exception when calling ReadonlyApi->release: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

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

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