# NetApp ONTAP
The Python client library is a package you can use when writing scripts to access the
ONTAP REST API. It provides support for several underlying services, including connection
management, asynchronous request processing, and exception handling. By using the Python
client library, you can quickly develop robust code to support the automation of your ONTAP
deployments.
# Getting started
The Python client library is available as the package **netapp_ontap** at the Python Package
Index (PyPi) web site at https://pypi.org/project/netapp-ontap
## Software requirements
Before installing the Python client library, you must make sure the following packages are
installed on your system:
* python 3.6 or later
* requests 2.26.0 or later
* requests-toolbelt 0.9.1 or later
* marshmallow 3.2.1 or later
The library requires version 1.26.7 or later of urllib3 due to outstanding CVEs against
older versions. It also requires version 2022.12.7 of certifi due to a CVE that removed
root certificates from TrustCor from the root store. However, it will still work with older
versions of urllib3 and certifi as long as the versions of urllib3 and certifi are compatible
with the requests package.
## Installing and importing the package
You must install the package using the pip utility:
```
pip install netapp-ontap
```
After installing the package, you can import the objects you need into your application:
```python
from netapp_ontap.resources import Volume, Snapshot
```
## Creating an object
You can create an object in several different ways. Here are three examples of
creating an equivalent `Volume` object.
```python
from netapp_ontap.resources import Volume
# Example 1 - keyword arguments
volume = Volume(name='vol1', svm={'name': 'vs1'}, aggregates=[{'name': 'aggr1'}])
# Example 2 - dict as keyword arguments
data = {
'name': 'vol1',
'svm': {'name': 'vs1'},
'aggregates': [{'name': 'aggr1'}],
}
volume = Volume(**data)
# Example 3 - using the from_dict() method
volume = Volume.from_dict({
'name': 'vol1',
'svm': {'name': 'vs1'},
'aggregates': [{'name': 'aggr1'}],
})
```
## Performing actions on an object
After you create an object, you can perform actions on the object based
on the purpose and design of your application. The example below illustrates
how to create a new volume and then take a snapshot.
Note that when using the library, in all cases you must first establish a
connection to the management LIF of the ONTAP system using the
`netapp_ontap.host_connection.HostConnection` object. In the example below,
the connection is created and then set as the global default.
This means that all objects and the associated actions reuse
this same connection. See *Host connections* for more information.
```python
from netapp_ontap import config, HostConnection
from netapp_ontap.resources import Volume, Snapshot
config.CONNECTION = HostConnection('myhost.mycompany.com', 'username', 'password')
volume = Volume(name='vol1', svm={'name': 'vs1'}, aggregates=[{'name': 'aggr1'}])
volume.post()
snapshot = Snapshot.from_dict({
'name': '%s_snapshot' % volume.name,
'comment': 'A snapshot of %s' % volume.name,
'volume': volume.to_dict(),
})
snapshot.post()
```
# Host connections
The `netapp_ontap.host_connection.HostConnection` object allows a client application
to store credentials once and reuse them for each subsequent operation.
You can do this in any of the following ways:
* Call the function `set_connection()` on a specific resource so the connection is used for
all actions on the resource.
* Set the `netapp_ontap.config.CONNECTION` variable to establish a single connection instance for all
operations within the scope of that block. This allows you to connect to ONTAP once
and use the same connection everywhere, instead of providing credentials every time you make a
request.
* Use the connection object as a context manager with the **with** keyword. Note: This method
is not recommended if you are using mutiple threads connecting to different hosts. This [issue](https://community.netapp.com/t5/ONTAP-Rest-API-Discussions/Python-with-context-manager-and-rest-apis-multi-threading/m-p/442026/highlight/true#M468)
is currently being worked on and should be fixed in future releases.
Note that you can call `get_connection()` to get the connection used by an object and use it for
subsequent operations.
By default, every operation attempts to verify the SSL certificate for the connection. If a
certificate cannot be verified, the **SSLError** exception is thrown. You can disable this
verification by setting `netapp_ontap.host_connection.HostConnection.verify` to false when creating the
`netapp_ontap.host_connection.HostConnection` instance.
## Custom headers
In some cases, you might want to set and send custom headers with the REST request.
This can be done at the connection level. For a specific connection, you can pass in
the headers you would like to send for each request within the scope of that connection object.
The library provides full access to the request headers so that you can update, add, or delete
headers from the same connection object at any point. If a header is not recognized by ONTAP,
it is ignored.
```python
from netapp_ontap import config, HostConnection
headers = {'my-header1':'my-header-value1', 'my-header2':'my-header-value2'}
# Initialize a connection object with custom headers
config.CONNECTION = HostConnection('myhost.mycompany.com', 'username', 'password', headers=headers)
# Delete a header from a connection object
conn = HostConnection('myhost.mycompany.com', 'username', 'password', headers=headers)
del conn.request_headers['my-header1']
# Add a header to a connection object using the assignment operator
conn = HostConnection('myhost.mycompany.com', 'username', 'password', headers=headers)
conn.request_headers['mynew-header'] = 'mynew-header-value'
# Add headers to a connection object
config.CONNECTION = HostConnection('myhost.mycompany.com', 'username' 'password')
config.CONNECTION.request_headers = headers
# Update an existing header using the assignment operator
config.CONNECTION = HostConnection('myhost.mycompany.com','username','password', headers=headers)
config.CONNECTION.request_headers['my-header1'] = 'my-new-header'
```
# Asynchronous processing and jobs
All POST, PATCH, and DELETE requests that can take more than two seconds to complete are
designed to run asynchronously as non-blocking operations. These operations are executed
as background jobs at the ONTAP cluster. The HTTP response generated by an
asynchronous request always contains a link to the associated job object. By default, an
asynchronous request automatically polls the job using the unique job identifier in the link.
Control is returned to your script when a terminal state is reached (success or failure) or
the configured timeout value expires. However, you can override this behavior by setting the
**poll** value to false when calling the function, causing control to return before the job
completes. Forcing an immediate return can be useful when a job might take a long time to
complete and you want to continute execution of the script.
# Responses
A request always returns a `netapp_ontap.response.NetAppResponse` object which contains the details
of the HTTP response. It contains information such as whether the response is an error
or a job. Refer to `netapp_ontap.response.NetAppResponse` for further information on how
to check the details of the response.
# Exception handling
By default, an exception is returned if a request returns an HTTP status code of 400 or greater.
The exception object, which is of type `netapp_ontap.error.NetAppRestError`,
holds the HTTP response object so that the exception can be handled in the client code.
If you wish not to raise exceptions, you can set `netapp_ontap.config.RAISE_API_ERRORS` to false. In this case,
it is up to the client to check the HTTP response from the `netapp_ontap.response.NetAppResponse`
object and handle any errors. Refer to `netapp_ontap.error.NetAppRestError` for further information.
```python
# Set RAISE_API_ERRORS to False and check the HTTP response.
config.RAISE_API_ERRORS = False
response = Svm.find(name="nonexistent_vs")
assert "entry doesn't exist" in response.http_response.text
```
# Debugging
While writing your application, it can often be useful to see the raw HTTP request and response
text that the library is sending to and from the server. There are two flags that can be set
to help with this.
## DEBUG flag
The first is the DEBUG flag. This can be set either by setting DEBUG=1 in the environment prior
to executing your application or by setting `netapp_ontap.utils.DEBUG` to 1 inside of your application.
This flag, when set, will cause the library to log the request and response for any failed
API call. This will be logged at DEBUG level (see the section on logging for setting up your
application). Here's an example of setting this value inside of your application:
```python
import logging
from netapp_ontap import HostConnection, NetAppRestError, config, utils
from netapp_ontap.resources import Volume
logging.basicConfig(level=logging.DEBUG)
config.CONNECTION = HostConnection('10.100.200.50', username='admin', password='password', verify=False)
# Set the DEBUG flag to 1
utils.DEBUG = 1
# this API call will fail with a 404
try:
volume = Volume(uuid="1", name='does_not_exist')
volume.get()
except NetAppRestError:
print('We got an expected exception')
```
Here is what the output would look like:
```
$ python test_debug.py
DEBUG:urllib3.util.retry:Converted retries value: 5 -> Retry(total=5, connect=None, read=None, redirect=None, status=None)
DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): 10.100.200.50:443
DEBUG:urllib3.connectionpool:https://10.100.200.50:443 "GET /api/storage/volumes/1 HTTP/1.1" 404 130
DEBUG:netapp_ontap.utils:
-----------REQUEST-----------
GET https://10.100.200.50:443/api/storage/volumes/1
Accept: */*
User-Agent: python-requests/2.21.0
Connection: keep-alive
Accept-Encoding: gzip, deflate
X-Dot-Client-App: netapp-ontap-python-9.8.0
Authorization: Basic YWRtaW46cGFzc3dvcmQK
None
-----------------------------
-----------RESPONSE-----------
404 Not Found
Date:Tue, 12 Nov 2019 13:00:24 GMT
Server:libzapid-httpd
X-Content-Type-Options: nosniff
Cache-Control: no-cache,no-store,must-revalidate
Content-Length: 130
Content-Type: application/hal+json
Keep-Alive: timeout=5, max=100
Connection:Keep-Alive
{
"error": {
"message": ""1" is an invalid value for field "uuid" (<UUID>)",
"code": "2",
"target": "uuid"
}
}
------------------------------
We got an expected exception
$
```
## LOG_ALL_API_CALLS flag
There is also a LOG_ALL_API_CALLS flag which can be set in the same ways. You can
set it in the environment or during script execution by setting `netapp_ontap.utils.LOG_ALL_API_CALLS`
to 1. This flag will produce the same output as above, but it will log the call no
matter if there was a failure or not. Here's an example of what that would look
like if we got an existing volume:
```python
import logging
from netapp_ontap import HostConnection, config, utils
from netapp_ontap.resources import Volume
logging.basicConfig(level=logging.DEBUG)
config.CONNECTION = HostConnection('10.100.200.50', username='admin', password='password', verify=False)
# Set the LOG_ALL_API_CALLS flag to 1
utils.LOG_ALL_API_CALLS = 1
# this API call will succeed and be logged
volume = list(Volume.get_collection())[0]
```
Here is what the output would look like:
```
$ python test_debug.py
DEBUG:urllib3.util.retry:Converted retries value: 5 -> Retry(total=5, connect=None, read=None, redirect=None, status=None)
DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): 10.100.200.50:443
DEBUG:urllib3.connectionpool:https://10.100.200.50:443 "GET /api/storage/volumes HTTP/1.1" 200 567
DEBUG:netapp_ontap.utils:
-----------REQUEST-----------
GET https://10.100.200.50:443/api/storage/volumes
User-Agent: python-requests/2.21.0
Connection: keep-alive
Accept: */*
Accept-Encoding: gzip, deflate
X-Dot-Client-App: netapp-ontap-python-9.8.0
Authorization: Basic YWRtaW46cGFzc3dvcmQK
None
-----------------------------
-----------RESPONSE-----------
200 OK
Date:Tue, 12 Nov 2019 13:14:01 GMT
Server:libzapid-httpd
X-Content-Type-Options: nosniff
Cache-Control: no-cache,no-store,must-revalidate
Content-Length: 567
Content-Type: application/hal+json
Keep-Alive: timeout=5, max=100
Connection:Keep-Alive
{
"records": [
{
"uuid": "c68bdca8-d090-11e9-bb29-005056bb7f42",
"name": "vs0_root",
"_links": {
"self": {
"href": "/api/storage/volumes/c68bdca8-d090-11e9-bb29-005056bb7f42"
}
}
},
{
"uuid": "ed3b6ebf-d48e-11e9-bb29-005056bb7f42",
"name": "vs1_root",
"_links": {
"self": {
"href": "/api/storage/volumes/ed3b6ebf-d48e-11e9-bb29-005056bb7f42"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/storage/volumes"
}
}
}
------------------------------
$
```
# Additional considerations
In most cases, the objects and actions in the library can be mapped directly
to equivalent cURL commands run against the ONTAP REST interface. However, there are a few
exceptions you should be aware of.
## Property names
If a property of a resource is named the same as one of the Python reserved names,
the name is transposed when accessing the member of the resource. For example,
if there is a resource named "Foo" that has a property defined in the API named "class",
the property name would instead be "class_" when using the library. For example:
```python
from netapp_ontap.resources import Foo
foo = Foo()
foo.class_ = "high"
```
## Action methods
Some resources may have additional methods aside from the generic get(), post(),
patch(), etc. These are known as "action methods" and will send requests to an
endpoint matching the same name. For example, the `netapp_ontap.resources.security_certificate.SecurityCertificate`
resource has the `netapp_ontap.resources.security_certificate.SecurityCertificate.sign()` method.
Using this method will make a POST call to /api/security/certitficates/{uuid}/sign.
If a resource has a field with the same name as an action method, then the name of
the action method will be changed so as to not conflict. In the above example, if
the SecurityCertificate object had a field called `sign`, then the name of the action
method would be `sign_action()` instead.
# Documentation
To view the latest documentation, visit https://devnet.netapp.com/restapi.php , click on the
"Python Client Library" tab, and then choose the latest version of the docs. You can also view
the ONTAP REST API docs linked from the same page under the "Overview" tab.
If you want to view this library's docs offline, then you can locate the copy installed in
`<python_environment>/lib/<python_version>/site_packages/netapp_ontap/docs`.
# Compatibility
The version assigned to the library consists of the major ONTAP release it is generated
from and a minor version for the library within that release. For example: within the
ONTAP 9.7 product family, the library may ship several fix releases by incrementing the
minor index: 9.7.0, 9.7.1, 9.7.2. The minor version
allows the library to be updated at a cadence separate from ONTAP.
Client libraries that have the same major version as ONTAP are completely compatible.
For example, the libraries netapp-ontap-9.6.1 and netapp-ontap-9.6.4 are fully
compatible with both ONTAP 9.6 and ONTAP 9.6P1.
A client library will support N-1 major versions of ONTAP with full backwards compatiblity
of all APIs and fields. For example, a program written using client library 9.6.1 and
talking to ONTAP 9.6 will continue to function consistently when the client library is
updated to 9.7.0.
A client library with a major version less than the ONTAP release can still be
used, however it will not be able to access any of the new REST APIs. For example, the library
netapp-ontap-9.6.4 is only partially compatible with ONTAP 9.7. In this case, the library will
not have access to the newer APIs or fields offered by ONTAP, but scripts can continue to
access any of the same 9.6 fields they were before without issue.
For example a new property **volume.is_svm_root** was added with ONTAP 9.7.
The following behaviors would be seen with different libraries and ONTAP combinations:
* library 9.6.0 would ignore the value coming from an ONTAP 9.7 response
* library 9.7.0 would fully support the property coming from an ONTAP 9.7+ response
* library 9.7.0 would not produce any errors for that property coming from an ONTAP 9.6 response
# Changelog
There are several changes to the Python Client Library and the ONTAP REST API, which are organized by release below.
## 9.14.1 library updates
**New `netapp_ontap` release cycle**
Starting with 9.14.1, the Python Client Library (`netapp_ontap`) will have one release for each ONTAP release cycle
(aligned with the ONTAP RC release). We will no longer have an RC and GA release for the library.
**Resource properties can now be set to `None`**
Some ONTAP REST endpoints accept null values in the request body, however, the Python library did not support this.
Starting in 9.14.1 the Python client library will allow users to set resource properties to `None` and will include
these values as null in the request body. Here is an example:
```python
# Get an existing rule
rule = S3BucketLifecycleRule("53714b3a-cd85-11ed-8980-005056aca578","b51ed46b-cff7-11ed-8980-005056aca578")
rule.name = "my_rule"
rule.get()
# set the expiration to None
rule.expiration = None
# patch the rule
rule.patch(hydrate=True)
```
Here is the resulting body of the request:
```json
{"expiration" : null}
```
**Resources can be more quickly retrieved using `fast_get_collection()`**
`fast_get_collection()` is the quicker version of `get_collection()` that will fetch all records
in the form of a RawResource type. It returns a generator that yields `netapp_ontap.raw_resource.RawResource` objects containing
information about the resource as a dictionary. `netapp_ontap.raw_resource.RawResource` objects do not support, `get()`, `post()`,
`patch()`, or `delete()`, but they can be converted to the appropriate resource type using
`netapp_ontap.raw_resource.RawResource.promote`. `netapp_ontap.raw_resource.RawResource` objects should be treated as read-only.
`fast_get_collection()` is significantly more efficient when there are many records in the response
because it skips deserializing and validating the resource until the user explicitly
asks by using `promote()`.
Here is an example:
```python
# Get all the volumes quickly
my_volumes = list(Volume.fast_get_collection())
deleted_volumes = []
for record in my_volumes:
# Get the current volume name and state
volume_name = record.name
volume_state = record.state
# Delete the volume if the name starts with "test_" OR if the volume is offline
if volume_name.startswith("test_") or volume_state == "offline":
# generate the resource object from this RawResource
volume = record.promote()
volume.delete()
deleted_volumes.append(volume_name)
print(f"The following {len(deleted_volumes)} volumes were deleted:")
print("\n".join(deleted_volumes))
```
**New endpoints**
* Endpoint: /name-services/cache/host/settings/{uuid}
HTTP methods: GET, PATCH
This API retrieves and updates a host cache setting for a given SVM.
* Endpoint: /network/fc/interfaces/{fc_interface.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for a Fibre Channel interface.
* Endpoint: /network/fc/interfaces/{fc_interface.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for a Fibre Channel interface for a specific time.
* Endpoint: /network/fc/ports/{fc_port.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for a Fibre Channel port.
* Endpoint: /network/fc/ports/{fc_port.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for a Fibre Channel port for a specific time.
* Endpoint: /network/fc/ports/{fc_port.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for a Fibre Channel port for a specific time.
* Endpoint: /protocols/fpolicy/{svm.uuid}/persistent-stores
HTTP methods: GET, POST
This API retrieves, and creates FPolicy persistent store configurations.
* Endpoint: /protocols/fpolicy/{svm.uuid}/persistent-stores/{name}
HTTP methods: GET, PATCH, DELETE
This API retrieves, updates, and deletes a FPolicy persistent store configurations with the specified name.
* Endpoint: /protocols/nvme/services/{svm.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for the NVMe protocol service of an SVM for a specific time.
* Endpoint: /protocols/san/fcp/services/{svm.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for the FC Protocol service of an SVM for a specific time.
* Endpoint: /protocols/san/initiators
HTTP methods: GET
This API retrieves SAN initiators.
* Endpoint: /protocols/san/initiators/{svm.uuid}/{name}
HTTP methods: GET
This API retrieves a SAN initiator using it's name and SVM uuid.
* Endpoint: /protocols/san/initiators/{svm.uuid}/{name}
HTTP methods: GET
This API retrieves a SAN initiator using it's name and SVM uuid.
* Endpoint: /protocols/san/iscsi/services/{svm.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for the iSCSI protocol service of an SVM for a specific time.
* Endpoint: /storage/luns/{lun.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for a LUN.
* Endpoint: /storage/luns/{lun.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for a LUN for a specific time.
* Endpoint: /storage/namespaces/{nvme_namespace.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for an NVMe namespace.
* Endpoint: /storage/namespaces/{nvme_namespace.uuid}/metrics/{timestamp}
HTTP methods: GET
This API retrieves historical performance metrics for a NVMe namespace for a specific time.
* Endpoint: /security/authentication/cluster/oauth2
HTTP methods: GET, PATCH
This API retrieves and updates the OAuth 2.0 status.
* Endpoint: /security/authentication/cluster/oauth2/clients
HTTP methods: GET, POST
This API retrieves and creates OAuth 2.0 configurations.
* Endpoint: /security/authentication/cluster/oauth2/clients/{name}
HTTP methods: GET, DELETE
This API retrieves and deletes OAuth 2.0 configurations with the specified name.
* Endpoint: /security/authentication/duo/groups
HTTP methods: GET, POST
This API retrieves and creates Duo groups.
* Endpoint: /security/authentication/duo/groups/{owner.uuid}/{name}
HTTP methods: GET, PATCH, DELETE
This API retrieves, updates, and deletes a Duo group based on the owner id and group name.
* Endpoint: /security/authentication/duo/profiles
HTTP methods: GET, POST
This API retrieves and creates Duo profile.
* Endpoint: /security/authentication/duo/profiles/{owner.uuid}
HTTP methods: GET, PATCH, DELETE
This API retrieves, updates, and deletes a Duo profule based on the owner id.
* Endpoint: /security/key-stores/{uuid}
HTTP methods: GET, PATCH, DELETE
This API retrieves, updates, and deletes the keystore configuration with the specified uuid.
* Endpoint: /storage/qos/qos-options
HTTP methods: GET, PATCH
This API retrieves, and updates QoS options.
* Endpoint: /support/autosupport/messages/{node.uuid}/{index}/{destination}
HTTP methods: GET
This API retrieves information about a single Autosupport message.
## 9.13.1 library updates
**New endpoints**
* Endpoint: /resource-tags
HTTP methods: GET
This API retrieves the tags currently being used for resources in the API.
* Endpoint: /resource-tags/{value}
HTTP methods: GET
This API retrieves a specific resource tag.
* Endpoint: /resource-tags/{resource_tag.value}/resources
HTTP methods: GET, POST
These APIs can be used to retrieve the resources for a specific tag or create a new tag on a specific resource.
* Endpoint: /resource-tags/{resource_tag.value}/resources/{href}
HTTP methods: GET, DELETE
These APIs can be used to retrieve or delete a specific resource for a specific tag.
* Endpoint: /application/consistency-groups/{consistency_group.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance and capacity metrics for a consistency group.
* Endpoint: /support/ems/role-configs
HTTP methods: GET, POST
These APIs can be used to retrieve a collection of the EMS role-based configurations or create an EMS role-based configuration for an access control role.
* Endpoint: /support/ems/role-configs/{access_control_reol.name}
HTTP methods: GET, PATCH, DELETE
These APIs can be used to retrieve, update, or delete the EMS role-based configuration of the access control role.
* Endpoint: /security/key-managers/{security_key_manager.uuid}/restore
HTTP methods: POST
This API retrieves and restores any current unrestored keys (associated with the storage controller) from the specified key management server.
* Endpoint: /security/login/totps
HTTP methods: GET, POST
These APIs can be used to retrieve and create the TOTP profiles configured for user accounts.
* Endpoint: /security/login/totps/{owner.uuid}/{account.name}
HTTP methods: GET, PATCH, DELETE
These APIs can be used to retrieve, update, or delete the TOTP profile configured for a user account.
* Endpoint: /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules
HTTP methods: GET, POST
These APIs can be used to retrieve all S3 Lifecycle rules associated with a bucket or create the S3 bucket lifecycle rule configuration.
* Endpoint: /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules/{name}
HTTP methods: GET, PATCH, DELETE
These APIs can be used to retrieve, update, or delete the S3 bucket lifecycle rule configuration.
## 9.12.1 library updates
**New endpoints**
* Endpoint: /application/consistency-groups/{consistency_group.uuid}/snapshots/{uuid}
HTTP methods: PATCH
This API completes a Snapshot copy operation of a consistency group.
* Endpoint: /security/aws-kms
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow ONTAP to securely store its encryption keys using AWS KMS. They allow for configuring, updating, and deleting AWS KMS configurations.
* Endpoint: /security/aws-kms/{aws_kms.uuid}/rekey-external
HTTP methods: POST
This API rekeys or re-versions the AWS KMS Key Encryption Key (KEK) for the given AWS KMS.
* Endpoint: /security/aws-kms/{aws_kms.uuid}/rekey-internal
HTTP methods: POST
This API rekeys SVM KEK for the given AWS KMS.
* Endpoint: /security/aws-kms/{aws_kms.uuid}/restore
HTTP methods: POST
This API restores the keys for an SVM from a configured AWS KMS.
* Endpoint: /security/key-managers/{security_key_manager.uuid}/auth-keys
HTTP methods: GET, POST, DELETE
These APIs allow for managing authentication keys.
* Endpoint: /storage/file/moves/{node.uuid}/{uuid}/{index}
HTTP methods: GET
This API retrieves the status of an on-going file move operation.
* Endpoint: /protocols/active-directory
HTTP methods: GET, POST
These APIs can be used to display Active Directory account-related information of all SVMs or create a new Active Directory account.
* Endpoint: /protocols/active-directory/{svm.uuid}
HTTP methods: GET, PATCH, DELETE
This API displays, modified, or deletes an Active Directory Account for the specified SVM.
* Endpoint: /protocols/active-directory/{svm.uuid}/preferred-domain-controllers
HTTP methods: GET, POST, DELETE
These APIs can be used to display or create the preferred domain controller configuration of an SVM.
* Endpoint: /protocols/active-directory/{svm.uuid}/preferred-domain-controllers/{fqdn}/{server_ip}
HTTP methods: GET, DELETE
These APIs retrieve and delete the Active Directory preferred DC configuration of the specified SVM and domain.
* Endpoint: /protocols/cifs/group-policies
HTTP methods: GET, PATCH
These APIs retrieve group policy objects that are yet to be applied. You can also use it to create a background task to update the GPO settings for a specific SVM.
* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-policies
HTTP methods: GET
This API retrieves applied central access policies for the specified SVM.
* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-policies/{name}
HTTP methods: GET
This API retrieves an applied central access policy for the specified SVM.
* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-rules
HTTP methods: GET
This API retrieves applied central access rules for specified SVM.
* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-rules/{name}
HTTP methods: GET
This API retrieves an applied central access rule for specified SVM.
* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/objects
HTTP methods: GET
This API retrieves applied group policy objects for specified SVM.
* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/restricted-groups
HTTP methods: GET
This API retrieves applied policies of restricted groups for specified SVM.
* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/restricted-groups/{policy_index}/{group_name}
HTTP methods: GET
This API retrieves an applied policy of a restricted group for specified SVM.
* Endpoint: /protocols/nfs/connected-client-settings
HTTP methods: GET, PATCH
These APIs allow for retrieving and modifying properties of the NFS connected-client cache settings.
**Fixed issues**
* [Bug ID 1506171](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1506171)
When calling post_collection on a resource, the library was not resetting the connection resulting in a no connection error.
* [Bug ID 1504927](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1504927)
The library was not polling on a job when a next link was returned in the response.
## 9.11.1 library updates
**New endpoints**
* Endpoint: /cluster/counter/tables
HTTP methods: GET
This API returns a collection of counter tables and their schema definitions.
* Endpoint: /cluster/counter/tables/{name}
HTTP methods: GET
This API returns the information about a single counter table.
* Endpoint: /cluster/counter/tables/{counter_table.name}/rows
HTTP methods: GET
This API returns a collection of counter rows.
* Endpoint: /cluster/counter/tables/{counter_table.name}/rows/{id}
HTTP methods: GET
This API returns a single counter rows.
* Endpoint: /cluster/metrocluster/svms
HTTP methods: GET
This API retrieves configuration information for all pairs of SVMs in MetroCluster.
* Endpoint: /cluster/metrocluster/svms/{cluster.uuid}/{svm.uuid}
HTTP methods: GET
This API retrieves configuration information for an SVM in a MetroCluster relationship.
* Endpoint: /cluster/sensors
HTTP methods: GET
This API retrieves environment sensors
* Endpoint: /cluster/sensors/{node.uuid}/{index}
HTTP methods: GET
This API retrieves environment sensors.
* Endpoint: /network/ethernet/switches
HTTP methods: POST, DELETE
This API can be used to get information about the Ethernet switches used for cluster and/or storage networks.
* Endpoint: /network/fc/fabrics
HTTP methods: GET
The Fibre Channel (FC) fabric REST APIs provide read-only access to FC network information. This includes connections between the ONTAP cluster and the FC fabric, the switches that comprise the fabric, and the zones of the active zoneset of the fabric.
* Endpoint: /network/ip/subnets
HTTP methods: GET, POST, PATCH, DELETE
This API manages IP subnets in the cluster.
* Endpoint: /svm/svms/{svm.uuid}/top-metrics/clients
HTTP methods: GET
This API retrieves a list of clients with the most IO activity for FlexVol and FlexGroup volumes belonging to a specified SVM.
* Endpoint: /svm/svms/{svm.uuid}/top-metrics/files
HTTP methods: GET
This API retrieves a list of files with the most IO activity for FlexVol and FlexGroup volumes belonging to a specified SVM.
* Endpoint: /svm/svms/{svm.uuid}/top-metrics/users
HTTP methods: GET
This API retrieves a list of users with the most IO activity for FlexVol and FlexGroup volumes belonging to a specified SVM.
* Endpoint: /name-services/cache/group-membership/settings
HTTP methods: GET, PATCH
This API is used to retrieve and manage group-membership cache settings.
* Endpoint: /name-services/cache/host/settings
HTTP methods: GET, PATCH
This API is used to retrieve and manage hosts cache settings.
* Endpoint: /name-services/cache/netgroup/settings
HTTP methods: GET, PATCH
This API is used to retrieve and manage netgroups cache settings.
* Endpoint: /name-services/cache/setting
HTTP methods: GET, PATCH
This API is used to retrieve and manage global nameservice cache settings.
* Endpoint: /name-services/cache/unix-group/settings
HTTP methods: GET, PATCH
This API is used to retrieve and manage unix-group settings.
* Endpoint: /name-services/cache/unix-user/settings
HTTP methods: GET, PATCH
This API is used to retrieve and manage unix-user settings.
* Endpoint: /name-services/ldap-schemas
HTTP methods: GET, POST, PATCH, DELETE
This API manages LDAP schemas.
* Endpoint: /name-services/netgroup-files/{svm.uuid}
HTTP methods: GET, PATCH
This API displays the netgroup file details or raw netgroup file of an SVM.
* Endpoint: /support/ems/application-logs
HTTP methods: POST
This API generates creates an app.log.* event.
* Endpoint: /security/azure-key-vaults/{azure_key_value.uuid}/rekey-external
HTTP methods: POST
This API rekeys the external key in the key hierarchy for an SVM with an AKV configuration.
* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/rekey-external
HTTP methods: POST
This API rekeys the external key in the key hierarchy for an SVM with a Google Cloud KMS configuration.
* Endpoint: /security/key-managers/{security_key_manager.uuid}/keys/{node.uuid}/key-ids
HTTP methods: GET
This API retrieves the key manager keys on the give node.
* Endpoint: /security/multi-admin-verify
HTTP methdos: GET, PATCH
These APIs provide information on the multi-admin verification global setting.
* Endpoint: /security/multi-admin-verify/approval-groups
HTTP methods: GET, POST
This API maanges multi-admin-verify approval groups.
* Endpoint: /security/multi-admin-verify/approval-groups/{owner.uuid}/{name}
HTTP methods: GET, PATCH, DELETE
These APIs provide information about a specific multi-admin verification approval-group.
* Endpoint: /security/multi-admin-verify/requests
HTTP methods: GET, POST
These APIs provide information about multi-admin verification requests.
* Endpoint: /security/multi-admin-verify/requests/{index}
HTTP methods: GET, PATCH, DELETE
These APIs provide information about a specific multi-admin verification request.
* Endpoint: /security/multi-admin-verify/rules
HTTP methods: GET, POST
This API manages multi-adming-verify rules.
* Endpoint: /security/multi-admin-verify/rules/{owner.uuid}/{operation}
HTTP methods: GET, PATCH, DELETE
These APIs provide information about a specific multi-admin verification rule.
* Endpoint: /storage/file/moves
HTTP methods: GET, POST
This API starts a file move operation between two FlexVol volumes or within a FlexGroup volume, and shows the status of all on-going file move operations in the cluster.
* Endpoint: /storage/pools
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage storage pools in a cluster.
* Endpoint: /storage/ports/{node.uuid}/{name}
HTTP methods: PATCH
This API updates a storage port.
* Endpoint: /storage/tape-devices/{node.uuid}/{device_id}
HTTP methods: PATCH
This API updates a specific tape device.
* Endpoint: /protocols/cifs/domains
HTTP methods: GET
This API retrieves the CIFS connection information for all SVMs.
* Endpoint: /protocols/cifs/netbios
HTTP methods: GET
This API retrieves NetBIOS information.
* Endpoint: /protocols/cifs/session/files
HTTP methods: GET, DELETE
These APIs manage files opened in a current session.
* Endpoint: /protocols/cifs/shadow-copies
HTTP methods: GET, PATCH
These APIs retrieve and modify Shadowcopies.
* Endpoint: /protocols/cifs/shadowcopy-sets
HTTP methods: GET, PATCH
These APIs retrieve and modify Shadowcopy Sets.
* Endpoint: /protocols/cifs/users-and-groups/build-import/{svm.uuid}
HTTP methods: GET, POST, PATCH
This API is used to bulk import from the specified URI, get the status of the last import and to upload the import status to the specified URI.
* Endpoint: /protocols/nfs/connected-client-maps
HTTP methods: GET
This API retrieves NFS clients information.
* Endpoint: /protocols/vscan/{svm.uuid}/events
HTTP methods: GET
This API retrieves Vscan events, which are generated by the cluster to capture important events.
## 9.10.1 library updates
**New endpoints**
* Endpoint: /cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter}
HTTP methods: PATCH
This API updates a MetroCluster interconnect interface.
* Endpoint: /cluster/web
HTTP methods: GET, PATCH
These APIs are for web services configuration.
* Endpoint: /svm/migrations
HTTP methods: GET, POST
These APIs allow creation and observation of the SVM migrations.
* Endpoint: /svm/migrations/{uuid}
HTTP methods: GET, PATCH, DELETE
These APIs allow management of a single SVM migration.
* Endpoint: /svm/migrations/{svm_migration.uuid}/volumes
HTTP methods: GET
This API retrieves the transfer status of the volumes in the SVM.
* Endpoint: /svm/migrations/{svm_migration.uuid}/volumes/{volume.uuid}
HTTP methods: GET
This API retrieves the transfer status for the specified volume.
* Endpoint: /svm/svms/{svm.uuid}/web
HTTP methods: GET, PATCH
These APIs manage the web services security configuration.
* Endpoint: /name-services/host-record/{svm.uuid}/host
HTTP methods: GET
This API retrieves the IP address of the specified hostname.
* Endpoint: /name-services/local-hosts
HTTP methods: GET, POST
These APIs are for managing IP to hostname mappings.
* Endpoint: /name-services/local-hosts/{owner.uuid}/{address}
HTTP methods: GET, PATCH, DELETE
These APIs manage a specified SVM and IP address.
* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users
HTTP methods: GET
This API retrieves users to the specified UNIX group and SVM.
* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users/{name}
HTTP methods: GET
This API retrieves a user from the specified UNIX group.
* Endpoint: /protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes
HTTP methods: GET, POST
These APIs are for managing LUN map reporting nodes.
* Endpoint: /protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes/{uuid}
HTTP methods: GET, DELETE
These APIs manage Lun map reports for the specified node.
* Endpoint: /protocols/san/vvol-bindings
HTTP methods: GET, POST
These APIs are for vVol bindings.
* Endpoint: /protocols/san/vvol-bindings/{protocol_endpoint.uuid}/{vvol.uuid}
HTTP methods: GET, DELETE
These APIs manage vVol bindings per vvol uuid.
* Endpoint: /storage/luns/{lun.uuid}/attributes
HTTP methods: GET, POST
These APIs are for LUN attributes.
* Endpoint: /storage/luns/{lun.uuid}/attributes/{name}
HTTP methods: GET, PATCH, DELETE
These APIs manage LUN attributes for the specific lun and name.
* Endpoint: /application/consistency-groups
HTTP methods: GET, POST
These APIs manage details of a collection or a specific consistency group.
* Endpoint: /application/consistency-groups/{uuid}
HTTP methods: GET, PATCH, DELETE
These APIs manage consistency groups.
* Endpoint: /application/consistency-groups/{uuid}/{consistency_group.uuid}/snapshots
HTTP methods: GET, POST
These APIs manage snapshot copies of a collection or a specific consistency group.
* Endpoint: /application/consistency-groups/{uuid}/{consistency_group.uuid}/snapshots/{uuid}
HTTP methods: GET, DELETE
These APIs manage details of a specific snapshot for a consistency group.
* Endpoint: /support/auto-update
HTTP methods: GET, PATCH
These APIs manage the current status of the automatic update feature and the End User License Agreement (EULA).
* Endpoint: /support/auto-update/configurations
HTTP methods: GET
This API retrieves the configuration for automatic updates.
* Endpoint: /support/auto-update/configurations/{uuid}
HTTP methods: GET, PATCH
These APIs manage the configuration for a specified automatic update.
* Endpoint: /support/auto-update/updates
HTTP methods: GET
This API retrieves the status of all updates.
* Endpoint: /support/auto-update/updates/{uuid}
HTTP methods: GET, PATCH
These APIs manage the status of an update.
* Endpoint: /support/coredump/coredumps
HTTP methods: GET
This API retrieves a collection of coredumps.
* Endpoint: /support/coredump/coredumps/{node.uuid}/{name}
HTTP methods: GET, DELETE
These APIs manage a specific core dump.
* Endpoint: /security/anti-ransomware/suspects
HTTP methods: GET
This API retrieves information on the suspects generated by the anti-ransomware analytics.
* Endpoint: /security/anti-ransomware/suspects/{volume.uuid}
HTTP methods: DELETE
This API clears either all the suspect files of a volume or suspect files of a volume based on file format or suspect time provided.
* Endpoint: /security/azure-key-vaults/{uuid}/rekey-internal
HTTP methods: POST
This API rekeys the internal key in the key hierarchy for an SVM with an AKV configuration.
* Endpoint: /security/azure-key-vaults/{uuid}/restore
HTTP methods: POST
This API restores the keys for an SVM from a configured AKV.
* Endpoint: /security/gcp-kms/{uuid}/rekey-internal
HTTP methods: POST
This API rekeys the internal key in the key hierarchy for an SVM with a Google Cloud KMS configuration.
* Endpoint: /security/gcp-kms/{uuid}/restore
HTTP methods: POST
This API restores the keys for an SVM from a configured Google Cloud KMS.
* Endpoint: /security/ipsec/ca-certificates
HTTP methods: GET, POST
These APIs are for the collection of IPsec CA certificates configured for all SVMs.
* Endpoint: /security/ipsec/ca-certificates/{svm.uuid}
HTTP methods: GET, PATCH, DELETE
These APIs manage the IPsec CA certificates configured for the specified SVM.
* Endpoint: /security/key-manager-configs
HTTP methods: GET, PATCH
These APIs are used for key manager configurations.
* Endpoint: /security/key-stores
HTTP methods: GET
This API retrieves keystores.
* Endpoint: /security/ssh/svms
HTTP methods: GET
This API retrieves the SSH server configuration for all the SVMs.
* Endpoint: /security/ssh/svms/{svm.uuid}
HTTP methods: GET, PATCH
These APIs manage the SSH server configuration for the specified SVM.
* Endpoint: /storage/file/clone/split-loads
HTTP methods: GET
This API retrieves the clone split load of a node.
* Endpoint: /storage/file/clone/split-loads/{node.uuid}
HTTP methods: GET, PATCH
These APIs manage Volume File Clone Split Load.
* Endpoint: /storage/file/clone/split-status
HTTP methods: GET
This API retrieves file clone split status of all volumes in the node.
* Endpoint: /storage/file/clone/split-status/{volume.uuid}
HTTP methods: GET
This API retrieves file clone split status of provided volume in the node.
* Endpoint: /storage/file/clone/tokens
HTTP methods: GET, POST
These APIs manage tokens to reserve the split load.
* Endpoint: /storage/file/clone/tokens/{node.uuid}/{uuid}
HTTP methods: GET, PATCH, DELETE
These APIs manage file clone tokens for the specified node.
* Endpoint: /storage/ports/{node.uuid}/{name}
HTTP methods: PATCH
This API updates a storage port.
* Endpoint: /storage/qos/workloads
HTTP methods: GET
This API retrieves a collection of QoS workloads.
* Endpoint: /storage/qos/workloads/{uuid}
HTTP methods: GET
This API retrieves a specific QoS workload.
* Endpoint: /storage/shelves/{uid}
HTTP methods: PATCH
This API updates a shelf location LED.
* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/clients
HTTP methods: GET
This API retrieves a list of clients with the most IO activity.
* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/directories
HTTP methods: GET
This API retrieves a list of directories with the most IO activity.
* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/files
HTTP methods: GET
This API retrieves a list of files with the most IO activity.
* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/users
HTTP methods: GET
This API retrieves a list of users with the most IO activity.
* Endpoint: /storage/snaplock/compliance-clocks
HTTP methods: POST
This API initializes the SnapLock ComplianceClock.
* Endpoint: /protocols/cifs/domains
HTTP methods: GET
This API retrieves the CIFS domain-related information of all SVMs.
* Endpoint: /protocols/cifs/domains/{svm.uuid}
HTTP methods: GET
This API retrieves the CIFS domain-related information for the specified SVM.
* Endpoint: /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers
HTTP methods: GET, POST
These APIs are for the CIFS domain preferred DC configuration of an SVM.
* Endpoint: /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers/{fqdn}/{server_ip}
HTTP methods: GET, DELETE
These APIs manage the CIFS domain preferred DC configuration for the specified SVM and domain.
* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{sid}
HTTP methods: GET, PATCH, DELETE
These APIs manage local group information for the specified group and SVM.
* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members
HTTP methods: GET, POST, DELETE
These APIs manage local users, Active Directory users and Active Directory groups which are members of the specified local group and SVM.
* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members/{name}
HTTP methods: GET, DELETE
These APIs manage the local user, Active Directory user and/or Active Directory group from the specified local group and SVM.
* Endpoint: /protocols/cifs/local-users/{svm.uuid}/{sid}
HTTP methods: GET, PATCH, DELETE
These APIs manage local user information for the specified user and SVM.
* Endpoint: /protocols/cifs/users-and-groups/bulk-import/{svm.uuid}
HTTP methods: GET, POST, PATCH
These APIs manage CIFS local users,groups and group memberships file from the specified URL.
* Endpoint: /protocols/event-selectors
HTTP methods: GET, POST
These APIs manage S3 audit event-selector configurations for all SVMs.
* Endpoint: /protocols/event-selectors/{svm.uuid}/{bucket}
HTTP methods: GET, PATCH, DELETE
These APIs manage an S3 audit event selector configuration for an SVM.
* Endpoint: /protocols/file-security/permissions/{svm.uuid}/{path}
HTTP methods: DELETE
This API removes all SLAG ACLs for specified path. Bulk deletion is supported only for SLAG.
* Endpoint: /protocols/fpolicy/{svm.uuid}/connections
HTTP methods: GET
This API retrieves the statuses of FPolicy servers.
* Endpoint: /protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server}
HTTP methods: GET, PATCH
These APIs manage the status of an FPolicy server.
* Endpoint: /protocols/locks
HTTP methods: GET
This API retrieves locks details.
* Endpoint: /protocols/locks/{uuid}
HTTP methods: GET, DELETE
These APIs manage locks for the specified Lock ID.
* Endpoint: /protocols/s3audits
HTTP methods: GET, POST
These APIs manage S3 audit configuration.
* Endpoint: /protocols/s3audits/{svm.uuid}
HTTP methods: GET, PATCH, DELETE
These APIs manage an S3 audit configuration for an SVM.
## 9.9.1 library updates
**New endpoints**
* Endpoint: /name-services/unix-groups
HTTP methods: GET, POST
These APIs allow management of the UNIX groups for all of the SVMs.
* Endpoint: /name-services/unix-groups/{svm.uuid}/{name}
HTTP methods: GET, PATCH, DELETE
These APIs manage UNIX group information for the specified group and SVM.
* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users
HTTP methods: POST
This API adds users to the specified UNIX group and SVM.
* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users/{name}
HTTP methods: DELETE
This API deletes a user from the specified UNIX group.
* Endpoint: /name-services/unix-users
HTTP methods: GET, POST
These APIs manage all local UNIX users and configuration for SVMs.
* Endpoint: /name-services/unix-users/{svm.uuid}/{name}
HTTP methods: GET, PATCH, DELETE
These APIs manage UNIX user information for the specified user and SVM.
* Endpoint: /protocols/san/igroups/{igroup.uuid}/igroups
HTTP methods: GET,POST
These APIs manage nested initiator groups of an initiator group.
* Endpoint: /protocols/san/igroups/{igroup.uuid}/igroups/{uuid}
HTTP methods: GET, DELETE
These APIs manage a nested initiator group of an initiator group.
* Endpoint: /protocols/san/igroups/{igroup.uuid}/initiators/{name}
HTTP methods: PATCH
Updates an initiator of an initiator group. This API only supports modification of initiators owned directly by the initiator group. Initiators of nested initiator groups must be modified on the initiator group that directly owns the initiator.
* Endpoint: /protocols/san/portsets
HTTP methods: GET, POST
These APIs are for portsets.
* Endpoint: /protocols/san/portsets/{uuid}
HTTP methods: GET, DELETE
These APIs used for a portset.
* Endpoint: /protocols/san/portsets/{portset.uuid}/interfaces
HTTP methods: GET, POST
These APIs are for interfaces of a portset.
* Endpoint: /protocols/san/portsets/{portset.uuid}/interfaces/{uuid}
HTTP methods: GET, DELETE
These APIs are for a network interface of a portset.
* Endpoint: /security/gcp-kms
HTTP methods: GET, POST
These APIs manage Google Cloud KMS configurations for all clusters and SVMs.
* Endpoint: /security/gcp-kms/{uuid}
HTTP methods: GET, PATCH, DELETE
These APIs are for managing the Google Cloud KMS configuration for the SVM specified by the UUID.
* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/rekey-internal
HTTP methods: POST
This API rekeys the internal key in the key hierarchy for an SVM with a Google Cloud KMS configuration.
* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/restore
HTTP methods: POST
This API restores the keys for an SVM from a configured Google Cloud KMS.
* Endpoint: /storage/bridges
HTTP methods: GET
This API retrieves a collection of bridges.
* Endpoint: /storage/bridges/{wwn}
HTTP methods: GET
This API retrieves a specific bridge
* Endpoint: /storage/flexcache/origins/{uuid}
HTTP methods: PATCH
This API modifies origin options for a origin volume in the cluster.
* Endpoint: /storage/switches
HTTP methods: GET
This API retrieves a collection of storage switches.
* Endpoint: /storage/switches/{name}
HTTP methods: GET
This API retrieves a specific storage switch.
* Endpoint: /storage/tape-devices
HTTP methods: GET
This API retrieves a collection of tape devices.
* Endpoint: /storage/tape-devices/{node.uuid}/{device_id}
HTTP methods: GET
This API retrieves a specific tape.
* Endpoint: /protocols/ndmp/svms/{svm.uuid}/passwords/{user}
HTTP methods: GET
This API generates and retrieves the password for the specified NDMP user.
* Endpoint: /protocols/cifs/local-groups
HTTP methods: GET, POST
These APIs are for the local groups for all of the SVMs.
* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{group_sid}
HTTP methods: GET, PATCH, DELETE
These APIs are for local group information of the specified group and SVM.
* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_group.group_sid}/members
HTTP methods: GET, POST, DELETE
These APIs manage local users, Active Directory users and Active Directory groups which are members of the specified local group and SVM.
* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_group.group_sid}/members/{name}
HTTP methods: GET, DELETE
These APIs are for the local user, Active Directory user and/or Active Directory group from the specified local group and SVM.
* Endpoint: /protocols/cifs/local-users
HTTP methods: GET, POST
These APIs are for local users of all of the SVMs.
* Endpoint: /protocols/cifs/local-users/{svm.uuid}/{user_sid}
HTTP methods: GET, PATCH, DELETE
These APIs manage local user information for the specified user and SVM.
* Endpoint: /protocols/cifs/sessions/{node.uuid}/{svm.uuid}/{identifier}/{connection_id}
HTTP methods: DELETE
This API deletes SMB session information on a node for an SVM.
* Endpoint: /protocols/cifs/users-and-groups/privileges
HTTP methods: GET, POST
These APIs manage privileges of the specified local or Active Directory user or group and SVM.
* Endpoint: /protocols/cifs/users-and-groups/privileges/{svm.uuid}/{name}
HTTP methods: GET, PATCH
These APIs are for privileges of the specified local or Active Directory user or group and SVM.
* Endpoint: /protocols/file-security/permissions/{svm.uuid}/{path}
HTTP methods: GET, POST, PATCH
These APIs manage file permissions
* Endpoint: /protocols/file-security/permissions/{svm.uuid}/{path}/acl
HTTP methods: POST, PATCH, DELETE
These APIs manage the new SACL/DACL ACL.
## 9.8.0 library updates
**Fixed issues**
* [Bug ID 1349122](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1349122)
Due to a type mismatch between documentation and implementation, some endpoints were failing because of a validation error.
## ONTAP 9.8 REST API updates ##
All new ONTAP APIs have corresponding library resource objects which can be used
to perform the operations. See the `netapp_ontap.resources` package for details
about each of the objects and their fields.
For a summary of the changes in the ONTAP REST API between versions of ONTAP 9, see the [ONTAP 9 Release Notes](https://library.netapp.com/ecm/ecm_download_file/ECMLP2492508).
**New endpoints**
* Endpoint: /cluster/firmware/history
HTTP methods: GET
This API retrieves the details history of firmware update requests for the cluster.
* Endpoint: /cluster/licensing/capacity-pools
HTTP methods: GET
This API retrieves information about associations between ONTAP nodes in the cluster and capacity pool licenses. It can also report how much capacity each node is consuming from the pool.
* Endpoint: /cluster/licensing/license-managers
HTTP methods: GET, PATCH
These APIs allow for managing information about the license manager associated with the cluster.
* Endpoint: /cluster/mediators
HTTP methods: GET, POST, DELETE
These APIs allow for adding or removing a mediator to MetroCluster over IP configuration as well as retrieving the status of the existing mediator.
* Endpoint: /cluster/metrocluster
HTTP methods: GET, POST, PATCH
These APIs allows for creating, performing operations, and retrieving relevant information pertaining to MetroCluster.
* Endpoint: /cluster/metrocluster/diagnostics
HTTP methods: GET, POST
This API can be used to initiate a MetroCluster diagnostics operation and fetch the results of a completed diagnostic operation.
* Endpoint: /cluster/metrocluster/dr-groups
HTTP methods: GET, POST, DELETE
These APIs allow for creating, performing operations, and retrieving relevant information about MetroCluster DR groups.
* Endpoint: /cluster/metrocluster/interconnects
HTTP methods: GET
This API retrieves information pertaining to MetroCluster interconnect status.
* Endpoint: /cluster/metrocluster/nodes
HTTP methods: GET
This API retrieves details about MetroCluster nodes.
* Endpoint: /cluster/metrocluster/operations
HTTP methods: GET
This API retrieves the list of MetroCluster operations on the local cluster.
* Endpoint: /cluster/nodes/{uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for a node.
* Endpoint: /cluster/software/upload
HTTP methods: POST
This API uploads a software or firmware package located on the local filesystem.
* Endpoint: /network/ethernet/ports/{uuid}/metrics
HTTP methdos: GET
This API retrieves historical performance metrics for a port.
* Endpoint: /network/ethernet/switch/ports
HTTP methods: GET
This API can be used to get the port information for an ethernet switch used in a cluster or storage networks.
* Endpoint: /network/ethernet/switches
HTTP methods: GET, PATCH
These APIs can be used to retrieve and modify ethernet switches used for the cluster and/or storage networks.
* Endpoint: /network/fc/interfaces/{uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for an FC interface.
* Endpoint: /network/fc/ports/{uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for an FC port.
* Endpoint: /network/ip/interfaces/{uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for an interface.
* Endpoint: /network/ip/service-policies
HTTP methods: POST, PATCH, DELETE
These APIs allow for creating, modifying, and deleting a servicy policy for network interfaces.
* Endpoint: /storage/namespaces/{uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for an NVMe namespace.
* Endpoint: /security
HTTP methods: PATCH
This API updates the software FIPS mode or enables conversion of non-encrypted metadata volumes to encrypted metadata volumes and non-NAE aggregates to NAE aggregates.
* Endpoint: /security/azure-key-vaults
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow for managing Azure Key Vaults on a cluster.
* Endpoint: /security/azure-key-vaults/{azure_key_vault.uuid}/rekey-internal
HTTP methods: POST
This API rekeys the internal key in the key hierarchy for an SVM with and AKV configuration.
* Endpoint: /security/azure-key-vaults/{azure_key_vault.uuid}/restore
HTTP methods: POST
This API restores the keys for an SVM from a configures AKV.
* Endpoint: /security/certificate-signing-request
HTTP methods: POST
This API generates a Certificate Signing Request and a private key pair.
* Endpoint: /security/gcp-kms
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow ONTAP to store encryption keys using Google Cloud Key Management Services.
* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/restore
HTTP methods: POST
This API restores the keys for an SVM from a configure Google Cloud Key Management Service.
* Endpoint: /security/ipsec
HTTP methods: GET, PATCH
These APIs allow for retrieving and updating IPsec status.
* Endpoint: /security/ipsec/policies
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow for creating, retrieving information about, and updating IPsec policies.
* Endpoint: /security/ipsec/security-associations
HTTP methods: GET
This API retrieves the IPsec and IKE(Internet Key Exchange) security associations.
* Endpoint: /storage/file/copy
HTTP methods: POST
This API starts a file copy operations which is only supported on flexible volumes.
* Endpoint: /storage/file/move
HTTP methods: POST
This API starts a file move operation which is only supported on flexible volumes.
* Endpoint: /storage/flexcache/flexcaches/{uuid}
HTTP methods: PATCH
This API prepopulates a FlexCache volume in the cluster.
* Endpoint: /storage/monitored-files
HTTP methods: GET, POST, DELETE
These APIs allow for creating, deleting, and retrieving information about monitored files.
* Endpoint: /storage/monitored-files/{monitored_file.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for the monitored file.
* Endpoint: /storage/snapshot-policies/{snapshot_policy.uuid}/schedules
HTTP methods: GET, POST, PATCH, DELETE
These APIs perform operations related to Snapshot copy policy schedules.
* Endpoint: /storage/volume-efficiency-policies
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow for configuring volume efficiency policies on a cluster.
* Endpoint: /storage/volumes/{volume.uuid}/files/{path}
HTTP methods: POST, PATCH, DELETE
These APIs allow for creating files, modifying files, and deleting files on a volume.
* Endpoint: /private/protocols/audit/audit-log-redirect
HTTP methods: GET, POST, PATCH, DELETE
These APIs can be used to specify a dedicated SVM for all NAS auditing event log to reside in.
* Endpoint: /protocols/cifs/sessions
HTTP methods: GET
This API retrieves the CIFS sessions information for all SVMs.
* Endpoint: /protocols/cifs/sessions/{node.uuid}/{svm.uuid}/{identifier}/{connection_id}
HTTP methods: GET
This API retrieves SMB session information for a specific SMF connection of a SVM in a node.
* Endpoint: /protocols/file-access-tracing/events
HTTP methods: GET, DELETE
These APIs retrieves or delete trace results for access allowed or denied events.
* Endpoint: /protocols/file-access-tracing/filters
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage security trace filter entries.
* Endpoint: /protocols/file-security/effective-permissions/{svm.uuid}/{path}
HTTP methods: GET
This API displays the effective permissions granted to a Windows or UNIX user on the specified file or folder path.
* Endpoint: /private/manage/event-remediations
HTTP methods: GET, PATCH
These APIs allow for retrieving about and performing event management actions.
* Endpoint: /protocols/s3/buckets
HTTP methods: POST
This API creates the S3 bucket configuration for an SVM.
* Endpoint: /protocols/s3/buckets/{svm.uuid}/{uuid}
HTTP methods: GET, PATCH, DELETE
These APIs manage S3 bucket configurations for the specified SVM.
* Endpoint: /protocols/s3/services/{svm.uuid}/groups
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage S3 group configurations for the specified SVM.
* Endpoint: /protocols/s3/services/{svm.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for the S3 protocol of an SVM.
* Endpoint: /protocols/s4/services/{svm.uuid}/policies
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow for configuring S3 policies for the specified SVM.
## 9.7.0 library updates
**New**
* A `count_collection()` method is now available on all resources which have a `get_collection()`. This method is a shortcut for getting only the number of items matching a query. For example: `Volume.count_collection(name="backup_vol*")` is roughly equivalent to `len(list(Volume.get_collection(name="backup_vol*")))`.
* The application can now add its own custom headers for each request as part of the `netapp_ontap.host_connection.HostConnection` object.
* When passing verify=False to the HostConnection, the library will now disable urllib3's InsecureRequestWarning from logging messages.
**Fixed issues**
* [Bug ID 1322090](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1322090)
When polling jobs, the certificate verification setting was hard-coded to False, so it would behave the same regardless of how the user set it.
* [Bug ID 1322095](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1322095)
The get_collection() call using the connection parameter was not correctly setting the connection on the returned resource objects.
* [Bug ID 1279507](ihttps://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1279507)
When doing a find() with the fields query parameter, the library was not returning the specified fields, instead, all fields were being returned.
* [Bug ID 1291333](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1291333)
When 0 records are found in a Resource.find() call and LOG_ALL_API_CALLS is set to True, then an uncaught exception is raised.
* [Bug ID 1271450](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1271450)
The library doesn't allow sending a body in a DELETE request.
* [Bug ID 1263312](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1263312)
When POSTing or PATCHing some objects with embedded objects, fields might incorrectly be dropped from the request.
* [Bug ID 1275238](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1275238)
Retrieving and setting the "from" field of Autosupport object fails.
**Incompatibilities**
* In prior versions, Resource.find() would raise an exception if no results were found as well as when more than one was found. In this version, when no results are found, None is returned instead of raising an exception. An exception is still raised when more than one result is found.
##ONTAP 9.7 REST API updates
All new ONTAP APIs have corresponding library resource objects which can be used
to perform the operations. See the `netapp_ontap.resources` package for details
about each of the objects and their fields.
For a summary of the changes in the ONTAP REST API between versions of ONTAP 9, see the [ONTAP 9 Release Notes](https://library.netapp.com/ecm/ecm_download_file/ECMLP2492508).
**New endpoints**
* Endpoint: /cluster/nodes/{uuid}
HTTP methods: DELETE
This API will remove a node from the cluster.
* Endpoint: /cluster/ntp/keys/{id}
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow for management of NTP server shared keys.
* Endpoint: /cluster/ntp/servers/{server}
HTTP methods: GET, POST, PATCH, DELETE
These APIs allow for management of keyed NTP servers.
* Endpoint: /cluster/software/download
HTTP methods: GET
This API allows monitoring the status of the image package download progress.
* Endpoint: /network/http-proxy/{uuid}
HTTP methods: GET, POST, PATCH, DELETE
This API allow configuration of an HTTP proxy for the cluster of SVM IP spaces.
* Endpoint: /network/ip/bgp/peer-groups/{uuid}
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage information pertaining to the BGP peer-groups configured in the cluster.
* Endpoint: /protocols/san/fcp/services/{svm.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for the FC Protocols service of an SVM.
* Endpoint: /protocos/san/iscsi/services/{svm.uuid}/metrics
HTTP methods: GET
This API retrieves history performance metrics for the iSCSI protocol of an SVM.
* Endpoint: /storage/luns/{uuid}/metrics
HTTP methods: GET
This API retrieves history performance metrics for a LUN.
* Endpoint: /protocls/nvme/services/{svm.uuid}/metrics
HTTP methods: GET
This API retrieve historical performance metrics for NVME protocol of an SVM.
* Endpoint: /support/configuration-backup/{node.uuid}/name
HTTP methods: GET, POST, DELETE
These APIs create, retrieve, and delete backup configuraiton for the cluster.
* Endpoint: /support/snmp/traphosts/{host}
HTTP methods: GET, POST, DELETE
These APIs configure SNMP traphosts which will receive SNMP traps from ONTAP.
* Endpoint: /support/snmp/users/{engine_id}/{name}
HTTP methods: GET, POST, PATCH, DELETE
These APIs configure SNMP users that are able to query for the ONTAP SNMP server.
* Endpoint: /security
HTTP methods: GET
This API retrieves information about the security configured on the cluster.
* Endpoint: /security/authentication/cluster/ad-proxy
HTTP methods: GET, POST, PATCH, DELETE
These APIs configure which data SVM will be use to proxy cluster management AD authentication.
* Endpoint: /security/authentiation/publickeys/{owner.uuid}/{account.name}/{index}
HTTP methods: GET, POST, PATCH, DELETE
These APIs configure the public keys for user accounts.
* Endpoint: /security/key-managers/{source.uuid}/migrate
HTTP methods: POST
This API migrates the keys belonging to an SVM between the cluster's key manager and the SVM's key manager.
* Endpoint: /security/ssh
HTTP methods: GET, PATCH
This API manages the SSH server running in ONTAP.
* Endpoint: /storage/aggregates/{uuid}/metrics
HTTP methods: GET
This API provide historical performance metrics for the specified aggregate.
* Endpoint: /storage/disks
HTTP methods: PATCH
This API updates the encryption controls of self-encrypting disks.
* Endpoint: /storage/snapshot-policies/{snapshot-policy.uuid}/schedules/{uuid}
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage the policies reqarding when snapshots are taken.
* Endpoint: /protocols/ndmp
HTTP methods: GET, PATCH
This API manages NDMP mode at either SVM-scope or node-scope.
* Endpoint: /protocols/ndmp/{node.uuid}
HTTP methods: GET, PATCH
This API manages node-scoped NDMP settings.
* Endpoint: /protocols/ndmp/sessions/{owner.uuid}/{session.id}
HTTP methods: GET, DELETE
These APIs manage diagnostics information on NDMP settings belonging to a specific SVM in the case of SVM-scope or to a specific node in the case of node-scope.
* Endpoint: /protocols/ndmp/svms/{svm.uuid}
HTTP methods: GET, PATCH
These APIs manage SVM-scoped NDMP settings.
* Endpoint: /storage/snaplock/audit-logs/{svm.uuid}
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage the loggin policies for a snaplock volume.
* Endpoint: /storage/snaplock/compliance-clocks/{node.uuid}
HTTP methods: GET
This API manages the Compliance Clock of the system which determines the expiry time of the SnapLock objects in the system.
* Endpoint: /storage/snaplock/event-retention/operations/{id}
HTTP methods: GET, POST
These APIs display all Event Based Retentions (EBR) operations and allow for applying an EBR policy on a specified volume.
* Endpoint: /storage/snaplock/event-retention/policies/{policy.name}
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage retention policies for snaplock files and directories.
* Endpoint: /storage/snaplock/files/{volume.uuid}/{path}
HTTP methods: GET, PATCH, DELETE
These APIs manage the SnapLock retention time of a file.
* Endpoint: /storage/snaplock/file-fingerprints/{id}
HTTP methods: GET, POST, DELETE
These APIs manage key information about snaplock files and volumes.
* Endpoint: /storage/snaplock/litigations/{id}
HTTP methods: GET, POST, DELETE
These APIs retain Compliance-mode WORM files for the duration of a litigation.
* Endpoint: /storage/snaplock/litigations/{litigation.id/files
HTTP methods: GET
This API displays the list of files under the specified litigation ID.
* Endpoint: /storage/snaplock/litigations/{litigation.id}/operations/{id}
HTTP methods: GET, POST, DELETE
This API manages the legal-hold operations for the specified litigation ID.
* Endpoint: /protocols/cifs/services/{svm.uuid}/metrics
HTTP methods: GET
This API retrieves history performance metrics for the CIFS protocol of an SVM.
* Endpoint: /protocols/nfs/connected-clients
HTTP methods: GET
This API provides a list of currently connected NFS clients or clients that can be connected but are currently idle.
* Endpoint: /protocols/nfs/services/{svm.uuid}/metrics
HTTP methods: GET
This API retrieves historical performance metrics for the NFS protocol of an SVM.
* Endpoint: /protocols/s3/buckets
HTTP methods: GET
This API retrieves all S3 buckets for all SVMs.
* Endpoint: /protocols/s3/services/{svm.uuid}
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage S3 servers which will allow you to store objects in ONTAP using Amazon S3 protocol.
* Endpoint: /protocols/s3/services/{svm.uuid}/buckets/{uuid}
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage S3 buckets which are a container of objects.
* Endpoint: /protocols/s3/services/{svm.uuid}/users/{name}
HTTP methods: GET, POST, PATCH, DELETE
These APIs manage S3 user accounts on the server. Buckets that are created are associate with a user.
## 9.6.0
(2019-07-16)
Initial release of the library
# Copyright, trademarks, and feedback
## Copyright information
Copyright © 2023 NetApp, Inc. All Rights Reserved. Printed in the U.S.
No part of this document covered by copyright may be reproduced in any form or by any means—graphic,
electronic, or mechanical, including photocopying, recording, taping, or storage in an electronic
retrieval system—without prior written permission of the copyright owner.
Software derived from copyrighted NetApp material is subject to the following license
and disclaimer:
THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP 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.
NetApp reserves the right to change any products described herein at any time, and without notice.
NetApp assumes no responsibility or liability arising from the use of products described herein,
except as expressly agreed to in writing by NetApp. The use or purchase of this product does not
convey a license under any patent rights, trademark rights, or any other intellectual property
rights of NetApp. The product described in this manual may be protected by one or more U.S.
patents, foreign patents, or pending applications.
RESTRICTED RIGHTS LEGEND: Use, duplication,or disclosure by the government is subject to
restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and
Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).
## Trademark information
NETAPP, the NETAPP logo, and the marks listed on the NetApp Trademarks page are trademarks of
NetApp, Inc. Other company and product names may be trademarks of their respective owners.
http://www.netapp.com/us/legal/netapptmlist.aspx
## Feedback
If you have questions about the library, suggestions, or find a bug, you may contact
by email.
<ng-ontap-rest-python-lib@netapp.com>
You can help us to improve the quality of our documentation by sending us your feedback.
If you have suggestions for improving this document, send us your comments by email.
<doccomments@netapp.com>
To help us direct your comments to the correct division, include in the subject line
the product name, version, and operating system.
If you want to be notified automatically when production-level documentation is released
or important changes are made to existing production-level documents,
follow Twitter account @NetAppDoc.
You can also contact us in the following ways:
NetApp, Inc., 3060 Olsen Drive, San Jose, CA 95128 U.S.
Telephone: +1 (408) 822-6000
Fax: +1 (408) 822-4501
Support telephone: +1 (888) 463-8277
Raw data
{
"_id": null,
"home_page": "https://devnet.netapp.com/restapi.php",
"name": "netapp-ontap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "NetApp ONTAP REST API development",
"author": "NetApp",
"author_email": "ng-ontap-rest-python-lib@netapp.com",
"download_url": "https://files.pythonhosted.org/packages/c3/e8/556ea0f26537c2f86b5d574b1f92bfbf1a4d8878b74f91cb15065022e0d1/netapp_ontap-9.14.1.0.tar.gz",
"platform": null,
"description": "\n\n# NetApp ONTAP\nThe Python client library is a package you can use when writing scripts to access the\nONTAP REST API. It provides support for several underlying services, including connection\nmanagement, asynchronous request processing, and exception handling. By using the Python\nclient library, you can quickly develop robust code to support the automation of your ONTAP\ndeployments.\n\n# Getting started\nThe Python client library is available as the package **netapp_ontap** at the Python Package\nIndex (PyPi) web site at https://pypi.org/project/netapp-ontap\n\n## Software requirements\nBefore installing the Python client library, you must make sure the following packages are\ninstalled on your system: \n\n* python 3.6 or later \n* requests 2.26.0 or later \n* requests-toolbelt 0.9.1 or later\n* marshmallow 3.2.1 or later \n\nThe library requires version 1.26.7 or later of urllib3 due to outstanding CVEs against\nolder versions. It also requires version 2022.12.7 of certifi due to a CVE that removed\nroot certificates from TrustCor from the root store. However, it will still work with older\nversions of urllib3 and certifi as long as the versions of urllib3 and certifi are compatible\nwith the requests package.\n\n\n## Installing and importing the package\nYou must install the package using the pip utility:\n\n```\npip install netapp-ontap\n```\n\nAfter installing the package, you can import the objects you need into your application:\n\n```python\nfrom netapp_ontap.resources import Volume, Snapshot\n```\n\n## Creating an object\n\nYou can create an object in several different ways. Here are three examples of\ncreating an equivalent `Volume` object.\n\n```python\nfrom netapp_ontap.resources import Volume\n\n# Example 1 - keyword arguments\nvolume = Volume(name='vol1', svm={'name': 'vs1'}, aggregates=[{'name': 'aggr1'}])\n\n# Example 2 - dict as keyword arguments\ndata = {\n 'name': 'vol1',\n 'svm': {'name': 'vs1'},\n 'aggregates': [{'name': 'aggr1'}],\n}\nvolume = Volume(**data)\n\n# Example 3 - using the from_dict() method\nvolume = Volume.from_dict({\n 'name': 'vol1',\n 'svm': {'name': 'vs1'},\n 'aggregates': [{'name': 'aggr1'}],\n})\n```\n\n## Performing actions on an object\n\nAfter you create an object, you can perform actions on the object based\non the purpose and design of your application. The example below illustrates\nhow to create a new volume and then take a snapshot.\n\nNote that when using the library, in all cases you must first establish a\nconnection to the management LIF of the ONTAP system using the\n`netapp_ontap.host_connection.HostConnection` object. In the example below,\nthe connection is created and then set as the global default.\nThis means that all objects and the associated actions reuse\nthis same connection. See *Host connections* for more information.\n\n```python\nfrom netapp_ontap import config, HostConnection\nfrom netapp_ontap.resources import Volume, Snapshot\n\nconfig.CONNECTION = HostConnection('myhost.mycompany.com', 'username', 'password')\n\nvolume = Volume(name='vol1', svm={'name': 'vs1'}, aggregates=[{'name': 'aggr1'}])\nvolume.post()\nsnapshot = Snapshot.from_dict({\n 'name': '%s_snapshot' % volume.name,\n 'comment': 'A snapshot of %s' % volume.name,\n 'volume': volume.to_dict(),\n})\nsnapshot.post()\n```\n\n# Host connections\n\nThe `netapp_ontap.host_connection.HostConnection` object allows a client application\nto store credentials once and reuse them for each subsequent operation.\nYou can do this in any of the following ways:\n\n* Call the function `set_connection()` on a specific resource so the connection is used for\nall actions on the resource.\n\n* Set the `netapp_ontap.config.CONNECTION` variable to establish a single connection instance for all\noperations within the scope of that block. This allows you to connect to ONTAP once\nand use the same connection everywhere, instead of providing credentials every time you make a\nrequest.\n\n* Use the connection object as a context manager with the **with** keyword. Note: This method\nis not recommended if you are using mutiple threads connecting to different hosts. This [issue](https://community.netapp.com/t5/ONTAP-Rest-API-Discussions/Python-with-context-manager-and-rest-apis-multi-threading/m-p/442026/highlight/true#M468)\nis currently being worked on and should be fixed in future releases.\n\nNote that you can call `get_connection()` to get the connection used by an object and use it for\nsubsequent operations.\n\nBy default, every operation attempts to verify the SSL certificate for the connection. If a\ncertificate cannot be verified, the **SSLError** exception is thrown. You can disable this\nverification by setting `netapp_ontap.host_connection.HostConnection.verify` to false when creating the\n`netapp_ontap.host_connection.HostConnection` instance.\n\n## Custom headers\n\nIn some cases, you might want to set and send custom headers with the REST request.\nThis can be done at the connection level. For a specific connection, you can pass in\nthe headers you would like to send for each request within the scope of that connection object.\nThe library provides full access to the request headers so that you can update, add, or delete\nheaders from the same connection object at any point. If a header is not recognized by ONTAP,\nit is ignored.\n\n```python\nfrom netapp_ontap import config, HostConnection\nheaders = {'my-header1':'my-header-value1', 'my-header2':'my-header-value2'}\n\n# Initialize a connection object with custom headers\nconfig.CONNECTION = HostConnection('myhost.mycompany.com', 'username', 'password', headers=headers)\n\n# Delete a header from a connection object\nconn = HostConnection('myhost.mycompany.com', 'username', 'password', headers=headers)\ndel conn.request_headers['my-header1']\n\n# Add a header to a connection object using the assignment operator\nconn = HostConnection('myhost.mycompany.com', 'username', 'password', headers=headers)\nconn.request_headers['mynew-header'] = 'mynew-header-value'\n\n# Add headers to a connection object\nconfig.CONNECTION = HostConnection('myhost.mycompany.com', 'username' 'password')\nconfig.CONNECTION.request_headers = headers\n\n# Update an existing header using the assignment operator\nconfig.CONNECTION = HostConnection('myhost.mycompany.com','username','password', headers=headers)\nconfig.CONNECTION.request_headers['my-header1'] = 'my-new-header'\n```\n\n# Asynchronous processing and jobs\n\nAll POST, PATCH, and DELETE requests that can take more than two seconds to complete are\ndesigned to run asynchronously as non-blocking operations. These operations are executed\nas background jobs at the ONTAP cluster. The HTTP response generated by an\nasynchronous request always contains a link to the associated job object. By default, an\nasynchronous request automatically polls the job using the unique job identifier in the link.\nControl is returned to your script when a terminal state is reached (success or failure) or\nthe configured timeout value expires. However, you can override this behavior by setting the\n**poll** value to false when calling the function, causing control to return before the job\ncompletes. Forcing an immediate return can be useful when a job might take a long time to\ncomplete and you want to continute execution of the script.\n\n# Responses\n\nA request always returns a `netapp_ontap.response.NetAppResponse` object which contains the details\nof the HTTP response. It contains information such as whether the response is an error\nor a job. Refer to `netapp_ontap.response.NetAppResponse` for further information on how\nto check the details of the response.\n\n# Exception handling\n\nBy default, an exception is returned if a request returns an HTTP status code of 400 or greater.\nThe exception object, which is of type `netapp_ontap.error.NetAppRestError`,\nholds the HTTP response object so that the exception can be handled in the client code.\nIf you wish not to raise exceptions, you can set `netapp_ontap.config.RAISE_API_ERRORS` to false. In this case,\nit is up to the client to check the HTTP response from the `netapp_ontap.response.NetAppResponse`\nobject and handle any errors. Refer to `netapp_ontap.error.NetAppRestError` for further information.\n\n```python\n# Set RAISE_API_ERRORS to False and check the HTTP response.\nconfig.RAISE_API_ERRORS = False\nresponse = Svm.find(name=\"nonexistent_vs\")\nassert \"entry doesn't exist\" in response.http_response.text\n```\n\n# Debugging\n\nWhile writing your application, it can often be useful to see the raw HTTP request and response\ntext that the library is sending to and from the server. There are two flags that can be set\nto help with this.\n\n## DEBUG flag\n\nThe first is the DEBUG flag. This can be set either by setting DEBUG=1 in the environment prior\nto executing your application or by setting `netapp_ontap.utils.DEBUG` to 1 inside of your application.\nThis flag, when set, will cause the library to log the request and response for any failed\nAPI call. This will be logged at DEBUG level (see the section on logging for setting up your\napplication). Here's an example of setting this value inside of your application:\n\n```python\nimport logging\n\nfrom netapp_ontap import HostConnection, NetAppRestError, config, utils\nfrom netapp_ontap.resources import Volume\n\nlogging.basicConfig(level=logging.DEBUG)\nconfig.CONNECTION = HostConnection('10.100.200.50', username='admin', password='password', verify=False)\n\n# Set the DEBUG flag to 1\nutils.DEBUG = 1\n\n# this API call will fail with a 404\ntry:\n volume = Volume(uuid=\"1\", name='does_not_exist')\n volume.get()\nexcept NetAppRestError:\n print('We got an expected exception')\n```\n\nHere is what the output would look like:\n\n```\n$ python test_debug.py\nDEBUG:urllib3.util.retry:Converted retries value: 5 -> Retry(total=5, connect=None, read=None, redirect=None, status=None)\nDEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): 10.100.200.50:443\nDEBUG:urllib3.connectionpool:https://10.100.200.50:443 \"GET /api/storage/volumes/1 HTTP/1.1\" 404 130\nDEBUG:netapp_ontap.utils:\n-----------REQUEST-----------\nGET https://10.100.200.50:443/api/storage/volumes/1\nAccept: */*\nUser-Agent: python-requests/2.21.0\nConnection: keep-alive\nAccept-Encoding: gzip, deflate\nX-Dot-Client-App: netapp-ontap-python-9.8.0\nAuthorization: Basic YWRtaW46cGFzc3dvcmQK\nNone\n-----------------------------\n\n-----------RESPONSE-----------\n404 Not Found\nDate:Tue, 12 Nov 2019 13:00:24 GMT\nServer:libzapid-httpd\nX-Content-Type-Options: nosniff\nCache-Control: no-cache,no-store,must-revalidate\nContent-Length: 130\nContent-Type: application/hal+json\nKeep-Alive: timeout=5, max=100\nConnection:Keep-Alive\n{\n \"error\": {\n \"message\": \"\"1\" is an invalid value for field \"uuid\" (<UUID>)\",\n \"code\": \"2\",\n \"target\": \"uuid\"\n }\n}\n------------------------------\nWe got an expected exception\n$\n```\n\n## LOG_ALL_API_CALLS flag\n\nThere is also a LOG_ALL_API_CALLS flag which can be set in the same ways. You can\nset it in the environment or during script execution by setting `netapp_ontap.utils.LOG_ALL_API_CALLS`\nto 1. This flag will produce the same output as above, but it will log the call no\nmatter if there was a failure or not. Here's an example of what that would look\nlike if we got an existing volume:\n\n```python\nimport logging\n\nfrom netapp_ontap import HostConnection, config, utils\nfrom netapp_ontap.resources import Volume\n\nlogging.basicConfig(level=logging.DEBUG)\nconfig.CONNECTION = HostConnection('10.100.200.50', username='admin', password='password', verify=False)\n\n# Set the LOG_ALL_API_CALLS flag to 1\nutils.LOG_ALL_API_CALLS = 1\n\n# this API call will succeed and be logged\nvolume = list(Volume.get_collection())[0]\n```\n\nHere is what the output would look like:\n\n```\n$ python test_debug.py\nDEBUG:urllib3.util.retry:Converted retries value: 5 -> Retry(total=5, connect=None, read=None, redirect=None, status=None)\nDEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): 10.100.200.50:443\nDEBUG:urllib3.connectionpool:https://10.100.200.50:443 \"GET /api/storage/volumes HTTP/1.1\" 200 567\nDEBUG:netapp_ontap.utils:\n-----------REQUEST-----------\nGET https://10.100.200.50:443/api/storage/volumes\nUser-Agent: python-requests/2.21.0\nConnection: keep-alive\nAccept: */*\nAccept-Encoding: gzip, deflate\nX-Dot-Client-App: netapp-ontap-python-9.8.0\nAuthorization: Basic YWRtaW46cGFzc3dvcmQK\nNone\n-----------------------------\n\n-----------RESPONSE-----------\n200 OK\nDate:Tue, 12 Nov 2019 13:14:01 GMT\nServer:libzapid-httpd\nX-Content-Type-Options: nosniff\nCache-Control: no-cache,no-store,must-revalidate\nContent-Length: 567\nContent-Type: application/hal+json\nKeep-Alive: timeout=5, max=100\nConnection:Keep-Alive\n{\n \"records\": [\n {\n \"uuid\": \"c68bdca8-d090-11e9-bb29-005056bb7f42\",\n \"name\": \"vs0_root\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/storage/volumes/c68bdca8-d090-11e9-bb29-005056bb7f42\"\n }\n }\n },\n {\n \"uuid\": \"ed3b6ebf-d48e-11e9-bb29-005056bb7f42\",\n \"name\": \"vs1_root\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/storage/volumes/ed3b6ebf-d48e-11e9-bb29-005056bb7f42\"\n }\n }\n }\n ],\n \"num_records\": 2,\n \"_links\": {\n \"self\": {\n \"href\": \"/api/storage/volumes\"\n }\n }\n}\n------------------------------\n$\n```\n\n# Additional considerations\n\nIn most cases, the objects and actions in the library can be mapped directly\nto equivalent cURL commands run against the ONTAP REST interface. However, there are a few\nexceptions you should be aware of.\n\n## Property names\n\nIf a property of a resource is named the same as one of the Python reserved names,\nthe name is transposed when accessing the member of the resource. For example,\nif there is a resource named \"Foo\" that has a property defined in the API named \"class\",\nthe property name would instead be \"class_\" when using the library. For example:\n\n```python\nfrom netapp_ontap.resources import Foo\n\nfoo = Foo()\nfoo.class_ = \"high\"\n```\n\n## Action methods\n\nSome resources may have additional methods aside from the generic get(), post(),\npatch(), etc. These are known as \"action methods\" and will send requests to an\nendpoint matching the same name. For example, the `netapp_ontap.resources.security_certificate.SecurityCertificate`\nresource has the `netapp_ontap.resources.security_certificate.SecurityCertificate.sign()` method.\nUsing this method will make a POST call to /api/security/certitficates/{uuid}/sign.\n\nIf a resource has a field with the same name as an action method, then the name of\nthe action method will be changed so as to not conflict. In the above example, if\nthe SecurityCertificate object had a field called `sign`, then the name of the action\nmethod would be `sign_action()` instead.\n\n# Documentation\n\nTo view the latest documentation, visit https://devnet.netapp.com/restapi.php , click on the\n\"Python Client Library\" tab, and then choose the latest version of the docs. You can also view\nthe ONTAP REST API docs linked from the same page under the \"Overview\" tab.\n\nIf you want to view this library's docs offline, then you can locate the copy installed in\n`<python_environment>/lib/<python_version>/site_packages/netapp_ontap/docs`.\n\n# Compatibility\n\nThe version assigned to the library consists of the major ONTAP release it is generated\nfrom and a minor version for the library within that release. For example: within the\nONTAP 9.7 product family, the library may ship several fix releases by incrementing the\nminor index: 9.7.0, 9.7.1, 9.7.2. The minor version\nallows the library to be updated at a cadence separate from ONTAP.\n\nClient libraries that have the same major version as ONTAP are completely compatible.\nFor example, the libraries netapp-ontap-9.6.1 and netapp-ontap-9.6.4 are fully\ncompatible with both ONTAP 9.6 and ONTAP 9.6P1.\n\nA client library will support N-1 major versions of ONTAP with full backwards compatiblity\nof all APIs and fields. For example, a program written using client library 9.6.1 and\ntalking to ONTAP 9.6 will continue to function consistently when the client library is\nupdated to 9.7.0.\n\nA client library with a major version less than the ONTAP release can still be\nused, however it will not be able to access any of the new REST APIs. For example, the library\nnetapp-ontap-9.6.4 is only partially compatible with ONTAP 9.7. In this case, the library will\nnot have access to the newer APIs or fields offered by ONTAP, but scripts can continue to\naccess any of the same 9.6 fields they were before without issue.\n\nFor example a new property **volume.is_svm_root** was added with ONTAP 9.7.\nThe following behaviors would be seen with different libraries and ONTAP combinations:\n\n* library 9.6.0 would ignore the value coming from an ONTAP 9.7 response\n\n* library 9.7.0 would fully support the property coming from an ONTAP 9.7+ response\n\n* library 9.7.0 would not produce any errors for that property coming from an ONTAP 9.6 response\n\n# Changelog\n\nThere are several changes to the Python Client Library and the ONTAP REST API, which are organized by release below.\n\n## 9.14.1 library updates\n\n**New `netapp_ontap` release cycle**\n\nStarting with 9.14.1, the Python Client Library (`netapp_ontap`) will have one release for each ONTAP release cycle\n(aligned with the ONTAP RC release). We will no longer have an RC and GA release for the library.\n\n**Resource properties can now be set to `None`**\n\nSome ONTAP REST endpoints accept null values in the request body, however, the Python library did not support this.\nStarting in 9.14.1 the Python client library will allow users to set resource properties to `None` and will include\nthese values as null in the request body. Here is an example:\n\n```python\n# Get an existing rule\nrule = S3BucketLifecycleRule(\"53714b3a-cd85-11ed-8980-005056aca578\",\"b51ed46b-cff7-11ed-8980-005056aca578\")\nrule.name = \"my_rule\"\nrule.get()\n# set the expiration to None\nrule.expiration = None\n# patch the rule\nrule.patch(hydrate=True)\n```\n\nHere is the resulting body of the request:\n\n```json\n{\"expiration\" : null}\n```\n\n**Resources can be more quickly retrieved using `fast_get_collection()`**\n\n`fast_get_collection()` is the quicker version of `get_collection()` that will fetch all records\nin the form of a RawResource type. It returns a generator that yields `netapp_ontap.raw_resource.RawResource` objects containing\ninformation about the resource as a dictionary. `netapp_ontap.raw_resource.RawResource` objects do not support, `get()`, `post()`,\n`patch()`, or `delete()`, but they can be converted to the appropriate resource type using\n`netapp_ontap.raw_resource.RawResource.promote`. `netapp_ontap.raw_resource.RawResource` objects should be treated as read-only.\n`fast_get_collection()` is significantly more efficient when there are many records in the response\nbecause it skips deserializing and validating the resource until the user explicitly\nasks by using `promote()`.\n\nHere is an example:\n\n```python\n# Get all the volumes quickly\nmy_volumes = list(Volume.fast_get_collection())\ndeleted_volumes = []\nfor record in my_volumes:\n # Get the current volume name and state\n volume_name = record.name\n volume_state = record.state\n # Delete the volume if the name starts with \"test_\" OR if the volume is offline\n if volume_name.startswith(\"test_\") or volume_state == \"offline\":\n # generate the resource object from this RawResource\n volume = record.promote()\n volume.delete()\n deleted_volumes.append(volume_name)\nprint(f\"The following {len(deleted_volumes)} volumes were deleted:\")\nprint(\"\\n\".join(deleted_volumes))\n\n```\n\n**New endpoints**\n\n* Endpoint: /name-services/cache/host/settings/{uuid} \n HTTP methods: GET, PATCH \n This API retrieves and updates a host cache setting for a given SVM.\n\n* Endpoint: /network/fc/interfaces/{fc_interface.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for a Fibre Channel interface.\n\n* Endpoint: /network/fc/interfaces/{fc_interface.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for a Fibre Channel interface for a specific time.\n\n* Endpoint: /network/fc/ports/{fc_port.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for a Fibre Channel port.\n\n* Endpoint: /network/fc/ports/{fc_port.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for a Fibre Channel port for a specific time.\n\n* Endpoint: /network/fc/ports/{fc_port.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for a Fibre Channel port for a specific time.\n\n* Endpoint: /protocols/fpolicy/{svm.uuid}/persistent-stores \n HTTP methods: GET, POST \n This API retrieves, and creates FPolicy persistent store configurations.\n\n* Endpoint: /protocols/fpolicy/{svm.uuid}/persistent-stores/{name} \n HTTP methods: GET, PATCH, DELETE \n This API retrieves, updates, and deletes a FPolicy persistent store configurations with the specified name.\n\n* Endpoint: /protocols/nvme/services/{svm.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for the NVMe protocol service of an SVM for a specific time.\n\n* Endpoint: /protocols/san/fcp/services/{svm.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for the FC Protocol service of an SVM for a specific time.\n\n* Endpoint: /protocols/san/initiators \n HTTP methods: GET \n This API retrieves SAN initiators.\n\n* Endpoint: /protocols/san/initiators/{svm.uuid}/{name} \n HTTP methods: GET \n This API retrieves a SAN initiator using it's name and SVM uuid.\n\n* Endpoint: /protocols/san/initiators/{svm.uuid}/{name} \n HTTP methods: GET \n This API retrieves a SAN initiator using it's name and SVM uuid.\n\n* Endpoint: /protocols/san/iscsi/services/{svm.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for the iSCSI protocol service of an SVM for a specific time.\n\n* Endpoint: /storage/luns/{lun.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for a LUN.\n\n* Endpoint: /storage/luns/{lun.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for a LUN for a specific time.\n\n* Endpoint: /storage/namespaces/{nvme_namespace.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for an NVMe namespace.\n\n* Endpoint: /storage/namespaces/{nvme_namespace.uuid}/metrics/{timestamp} \n HTTP methods: GET \n This API retrieves historical performance metrics for a NVMe namespace for a specific time.\n\n* Endpoint: /security/authentication/cluster/oauth2 \n HTTP methods: GET, PATCH \n This API retrieves and updates the OAuth 2.0 status.\n\n* Endpoint: /security/authentication/cluster/oauth2/clients \n HTTP methods: GET, POST \n This API retrieves and creates OAuth 2.0 configurations.\n\n* Endpoint: /security/authentication/cluster/oauth2/clients/{name} \n HTTP methods: GET, DELETE \n This API retrieves and deletes OAuth 2.0 configurations with the specified name.\n\n* Endpoint: /security/authentication/duo/groups \n HTTP methods: GET, POST \n This API retrieves and creates Duo groups.\n\n* Endpoint: /security/authentication/duo/groups/{owner.uuid}/{name} \n HTTP methods: GET, PATCH, DELETE \n This API retrieves, updates, and deletes a Duo group based on the owner id and group name.\n\n* Endpoint: /security/authentication/duo/profiles \n HTTP methods: GET, POST \n This API retrieves and creates Duo profile.\n\n* Endpoint: /security/authentication/duo/profiles/{owner.uuid} \n HTTP methods: GET, PATCH, DELETE \n This API retrieves, updates, and deletes a Duo profule based on the owner id.\n\n* Endpoint: /security/key-stores/{uuid} \n HTTP methods: GET, PATCH, DELETE \n This API retrieves, updates, and deletes the keystore configuration with the specified uuid.\n\n* Endpoint: /storage/qos/qos-options \n HTTP methods: GET, PATCH \n This API retrieves, and updates QoS options.\n\n* Endpoint: /support/autosupport/messages/{node.uuid}/{index}/{destination} \n HTTP methods: GET \n This API retrieves information about a single Autosupport message.\n\n## 9.13.1 library updates\n\n**New endpoints**\n\n* Endpoint: /resource-tags \n HTTP methods: GET \n This API retrieves the tags currently being used for resources in the API.\n\n* Endpoint: /resource-tags/{value} \n HTTP methods: GET \n This API retrieves a specific resource tag. \n\n* Endpoint: /resource-tags/{resource_tag.value}/resources \n HTTP methods: GET, POST \n These APIs can be used to retrieve the resources for a specific tag or create a new tag on a specific resource. \n\n* Endpoint: /resource-tags/{resource_tag.value}/resources/{href} \n HTTP methods: GET, DELETE \n These APIs can be used to retrieve or delete a specific resource for a specific tag. \n\n* Endpoint: /application/consistency-groups/{consistency_group.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance and capacity metrics for a consistency group. \n\n* Endpoint: /support/ems/role-configs \n HTTP methods: GET, POST \n These APIs can be used to retrieve a collection of the EMS role-based configurations or create an EMS role-based configuration for an access control role. \n\n* Endpoint: /support/ems/role-configs/{access_control_reol.name} \n HTTP methods: GET, PATCH, DELETE \n These APIs can be used to retrieve, update, or delete the EMS role-based configuration of the access control role. \n\n* Endpoint: /security/key-managers/{security_key_manager.uuid}/restore \n HTTP methods: POST \n This API retrieves and restores any current unrestored keys (associated with the storage controller) from the specified key management server. \n\n* Endpoint: /security/login/totps \n HTTP methods: GET, POST \n These APIs can be used to retrieve and create the TOTP profiles configured for user accounts. \n\n* Endpoint: /security/login/totps/{owner.uuid}/{account.name} \n HTTP methods: GET, PATCH, DELETE \n These APIs can be used to retrieve, update, or delete the TOTP profile configured for a user account. \n\n* Endpoint: /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules \n HTTP methods: GET, POST \n These APIs can be used to retrieve all S3 Lifecycle rules associated with a bucket or create the S3 bucket lifecycle rule configuration. \n\n* Endpoint: /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/rules/{name} \n HTTP methods: GET, PATCH, DELETE \n These APIs can be used to retrieve, update, or delete the S3 bucket lifecycle rule configuration. \n\n## 9.12.1 library updates\n\n**New endpoints**\n\n* Endpoint: /application/consistency-groups/{consistency_group.uuid}/snapshots/{uuid} \n HTTP methods: PATCH \n This API completes a Snapshot copy operation of a consistency group. \n\n* Endpoint: /security/aws-kms \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow ONTAP to securely store its encryption keys using AWS KMS. They allow for configuring, updating, and deleting AWS KMS configurations. \n\n* Endpoint: /security/aws-kms/{aws_kms.uuid}/rekey-external \n HTTP methods: POST \n This API rekeys or re-versions the AWS KMS Key Encryption Key (KEK) for the given AWS KMS. \n\n* Endpoint: /security/aws-kms/{aws_kms.uuid}/rekey-internal \n HTTP methods: POST \n This API rekeys SVM KEK for the given AWS KMS. \n\n* Endpoint: /security/aws-kms/{aws_kms.uuid}/restore \n HTTP methods: POST \n This API restores the keys for an SVM from a configured AWS KMS. \n\n* Endpoint: /security/key-managers/{security_key_manager.uuid}/auth-keys \n HTTP methods: GET, POST, DELETE \n These APIs allow for managing authentication keys. \n\n* Endpoint: /storage/file/moves/{node.uuid}/{uuid}/{index} \n HTTP methods: GET \n This API retrieves the status of an on-going file move operation. \n\n* Endpoint: /protocols/active-directory \n HTTP methods: GET, POST \n These APIs can be used to display Active Directory account-related information of all SVMs or create a new Active Directory account. \n\n* Endpoint: /protocols/active-directory/{svm.uuid} \n HTTP methods: GET, PATCH, DELETE \n This API displays, modified, or deletes an Active Directory Account for the specified SVM. \n\n* Endpoint: /protocols/active-directory/{svm.uuid}/preferred-domain-controllers \n HTTP methods: GET, POST, DELETE \n These APIs can be used to display or create the preferred domain controller configuration of an SVM. \n\n* Endpoint: /protocols/active-directory/{svm.uuid}/preferred-domain-controllers/{fqdn}/{server_ip} \n HTTP methods: GET, DELETE \n These APIs retrieve and delete the Active Directory preferred DC configuration of the specified SVM and domain. \n\n* Endpoint: /protocols/cifs/group-policies \n HTTP methods: GET, PATCH \n These APIs retrieve group policy objects that are yet to be applied. You can also use it to create a background task to update the GPO settings for a specific SVM. \n\n* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-policies \n HTTP methods: GET \n This API retrieves applied central access policies for the specified SVM. \n\n* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-policies/{name} \n HTTP methods: GET \n This API retrieves an applied central access policy for the specified SVM. \n\n* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-rules \n HTTP methods: GET \n This API retrieves applied central access rules for specified SVM. \n\n* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/central-access-rules/{name} \n HTTP methods: GET \n This API retrieves an applied central access rule for specified SVM. \n\n* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/objects \n HTTP methods: GET \n This API retrieves applied group policy objects for specified SVM. \n\n* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/restricted-groups \n HTTP methods: GET \n This API retrieves applied policies of restricted groups for specified SVM. \n\n* Endpoint: /protocols/cifs/group-policies/{svm.uuid}/restricted-groups/{policy_index}/{group_name} \n HTTP methods: GET \n This API retrieves an applied policy of a restricted group for specified SVM. \n\n* Endpoint: /protocols/nfs/connected-client-settings \n HTTP methods: GET, PATCH \n These APIs allow for retrieving and modifying properties of the NFS connected-client cache settings. \n\n**Fixed issues**\n\n* [Bug ID 1506171](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1506171) \n When calling post_collection on a resource, the library was not resetting the connection resulting in a no connection error.\n\n* [Bug ID 1504927](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1504927) \n The library was not polling on a job when a next link was returned in the response.\n\n## 9.11.1 library updates\n\n**New endpoints**\n\n* Endpoint: /cluster/counter/tables \n HTTP methods: GET \n This API returns a collection of counter tables and their schema definitions. \n\n* Endpoint: /cluster/counter/tables/{name} \n HTTP methods: GET \n This API returns the information about a single counter table. \n\n* Endpoint: /cluster/counter/tables/{counter_table.name}/rows \n HTTP methods: GET \n This API returns a collection of counter rows. \n\n* Endpoint: /cluster/counter/tables/{counter_table.name}/rows/{id} \n HTTP methods: GET\n This API returns a single counter rows. \n\n* Endpoint: /cluster/metrocluster/svms \n HTTP methods: GET \n This API retrieves configuration information for all pairs of SVMs in MetroCluster. \n\n* Endpoint: /cluster/metrocluster/svms/{cluster.uuid}/{svm.uuid} \n HTTP methods: GET \n This API retrieves configuration information for an SVM in a MetroCluster relationship. \n\n* Endpoint: /cluster/sensors \n HTTP methods: GET \n This API retrieves environment sensors \n\n* Endpoint: /cluster/sensors/{node.uuid}/{index} \n HTTP methods: GET \n This API retrieves environment sensors. \n\n* Endpoint: /network/ethernet/switches \n HTTP methods: POST, DELETE \n This API can be used to get information about the Ethernet switches used for cluster and/or storage networks. \n\n* Endpoint: /network/fc/fabrics \n HTTP methods: GET \n The Fibre Channel (FC) fabric REST APIs provide read-only access to FC network information. This includes connections between the ONTAP cluster and the FC fabric, the switches that comprise the fabric, and the zones of the active zoneset of the fabric. \n\n* Endpoint: /network/ip/subnets \n HTTP methods: GET, POST, PATCH, DELETE \n This API manages IP subnets in the cluster. \n\n* Endpoint: /svm/svms/{svm.uuid}/top-metrics/clients \n HTTP methods: GET \n This API retrieves a list of clients with the most IO activity for FlexVol and FlexGroup volumes belonging to a specified SVM. \n\n* Endpoint: /svm/svms/{svm.uuid}/top-metrics/files \n HTTP methods: GET \n This API retrieves a list of files with the most IO activity for FlexVol and FlexGroup volumes belonging to a specified SVM. \n\n* Endpoint: /svm/svms/{svm.uuid}/top-metrics/users \n HTTP methods: GET \n This API retrieves a list of users with the most IO activity for FlexVol and FlexGroup volumes belonging to a specified SVM. \n\n* Endpoint: /name-services/cache/group-membership/settings \n HTTP methods: GET, PATCH \n This API is used to retrieve and manage group-membership cache settings. \n\n* Endpoint: /name-services/cache/host/settings \n HTTP methods: GET, PATCH \n This API is used to retrieve and manage hosts cache settings. \n\n* Endpoint: /name-services/cache/netgroup/settings \n HTTP methods: GET, PATCH \n This API is used to retrieve and manage netgroups cache settings. \n\n* Endpoint: /name-services/cache/setting \n HTTP methods: GET, PATCH \n This API is used to retrieve and manage global nameservice cache settings. \n\n* Endpoint: /name-services/cache/unix-group/settings \n HTTP methods: GET, PATCH \n This API is used to retrieve and manage unix-group settings. \n\n* Endpoint: /name-services/cache/unix-user/settings \n HTTP methods: GET, PATCH \n This API is used to retrieve and manage unix-user settings. \n\n* Endpoint: /name-services/ldap-schemas \n HTTP methods: GET, POST, PATCH, DELETE \n This API manages LDAP schemas. \n\n* Endpoint: /name-services/netgroup-files/{svm.uuid} \n HTTP methods: GET, PATCH \n This API displays the netgroup file details or raw netgroup file of an SVM. \n\n* Endpoint: /support/ems/application-logs \n HTTP methods: POST \n This API generates creates an app.log.* event. \n\n* Endpoint: /security/azure-key-vaults/{azure_key_value.uuid}/rekey-external \n HTTP methods: POST \n This API rekeys the external key in the key hierarchy for an SVM with an AKV configuration. \n\n* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/rekey-external \n HTTP methods: POST \n This API rekeys the external key in the key hierarchy for an SVM with a Google Cloud KMS configuration. \n\n* Endpoint: /security/key-managers/{security_key_manager.uuid}/keys/{node.uuid}/key-ids \n HTTP methods: GET \n This API retrieves the key manager keys on the give node. \n\n* Endpoint: /security/multi-admin-verify \n HTTP methdos: GET, PATCH \n These APIs provide information on the multi-admin verification global setting. \n\n* Endpoint: /security/multi-admin-verify/approval-groups \n HTTP methods: GET, POST \n This API maanges multi-admin-verify approval groups. \n\n* Endpoint: /security/multi-admin-verify/approval-groups/{owner.uuid}/{name} \n HTTP methods: GET, PATCH, DELETE \n These APIs provide information about a specific multi-admin verification approval-group. \n\n* Endpoint: /security/multi-admin-verify/requests \n HTTP methods: GET, POST \n These APIs provide information about multi-admin verification requests. \n\n* Endpoint: /security/multi-admin-verify/requests/{index} \n HTTP methods: GET, PATCH, DELETE \n These APIs provide information about a specific multi-admin verification request. \n\n* Endpoint: /security/multi-admin-verify/rules \n HTTP methods: GET, POST \n This API manages multi-adming-verify rules. \n\n* Endpoint: /security/multi-admin-verify/rules/{owner.uuid}/{operation} \n HTTP methods: GET, PATCH, DELETE \n These APIs provide information about a specific multi-admin verification rule. \n\n* Endpoint: /storage/file/moves \n HTTP methods: GET, POST \n This API starts a file move operation between two FlexVol volumes or within a FlexGroup volume, and shows the status of all on-going file move operations in the cluster. \n\n* Endpoint: /storage/pools \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage storage pools in a cluster. \n\n* Endpoint: /storage/ports/{node.uuid}/{name} \n HTTP methods: PATCH \n This API updates a storage port. \n\n* Endpoint: /storage/tape-devices/{node.uuid}/{device_id} \n HTTP methods: PATCH \n This API updates a specific tape device. \n\n* Endpoint: /protocols/cifs/domains \n HTTP methods: GET \n This API retrieves the CIFS connection information for all SVMs. \n\n* Endpoint: /protocols/cifs/netbios \n HTTP methods: GET \n This API retrieves NetBIOS information. \n\n* Endpoint: /protocols/cifs/session/files \n HTTP methods: GET, DELETE \n These APIs manage files opened in a current session. \n\n* Endpoint: /protocols/cifs/shadow-copies \n HTTP methods: GET, PATCH \n These APIs retrieve and modify Shadowcopies. \n\n* Endpoint: /protocols/cifs/shadowcopy-sets \n HTTP methods: GET, PATCH \n These APIs retrieve and modify Shadowcopy Sets. \n\n* Endpoint: /protocols/cifs/users-and-groups/build-import/{svm.uuid} \n HTTP methods: GET, POST, PATCH \n This API is used to bulk import from the specified URI, get the status of the last import and to upload the import status to the specified URI. \n\n* Endpoint: /protocols/nfs/connected-client-maps \n HTTP methods: GET \n This API retrieves NFS clients information. \n\n* Endpoint: /protocols/vscan/{svm.uuid}/events \n HTTP methods: GET \n This API retrieves Vscan events, which are generated by the cluster to capture important events. \n\n## 9.10.1 library updates\n\n**New endpoints**\n\n* Endpoint: /cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter} \n HTTP methods: PATCH \n This API updates a MetroCluster interconnect interface. \n\n* Endpoint: /cluster/web \n HTTP methods: GET, PATCH \n These APIs are for web services configuration. \n\n* Endpoint: /svm/migrations \n HTTP methods: GET, POST \n These APIs allow creation and observation of the SVM migrations. \n\n* Endpoint: /svm/migrations/{uuid} \n HTTP methods: GET, PATCH, DELETE \n These APIs allow management of a single SVM migration. \n\n* Endpoint: /svm/migrations/{svm_migration.uuid}/volumes \n HTTP methods: GET \n This API retrieves the transfer status of the volumes in the SVM. \n\n* Endpoint: /svm/migrations/{svm_migration.uuid}/volumes/{volume.uuid} \n HTTP methods: GET \n This API retrieves the transfer status for the specified volume. \n\n* Endpoint: /svm/svms/{svm.uuid}/web \n HTTP methods: GET, PATCH \n These APIs manage the web services security configuration. \n\n* Endpoint: /name-services/host-record/{svm.uuid}/host \n HTTP methods: GET \n This API retrieves the IP address of the specified hostname. \n\n* Endpoint: /name-services/local-hosts \n HTTP methods: GET, POST \n These APIs are for managing IP to hostname mappings. \n\n* Endpoint: /name-services/local-hosts/{owner.uuid}/{address} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage a specified SVM and IP address. \n\n* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users \n HTTP methods: GET \n This API retrieves users to the specified UNIX group and SVM. \n\n* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users/{name} \n HTTP methods: GET \n This API retrieves a user from the specified UNIX group. \n\n* Endpoint: /protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes \n HTTP methods: GET, POST \n These APIs are for managing LUN map reporting nodes. \n\n* Endpoint: /protocols/san/lun-maps/{lun.uuid}/{igroup.uuid}/reporting-nodes/{uuid} \n HTTP methods: GET, DELETE \n These APIs manage Lun map reports for the specified node. \n\n* Endpoint: /protocols/san/vvol-bindings \n HTTP methods: GET, POST \n These APIs are for vVol bindings. \n\n* Endpoint: /protocols/san/vvol-bindings/{protocol_endpoint.uuid}/{vvol.uuid} \n HTTP methods: GET, DELETE \n These APIs manage vVol bindings per vvol uuid. \n\n* Endpoint: /storage/luns/{lun.uuid}/attributes \n HTTP methods: GET, POST \n These APIs are for LUN attributes. \n\n* Endpoint: /storage/luns/{lun.uuid}/attributes/{name} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage LUN attributes for the specific lun and name. \n\n* Endpoint: /application/consistency-groups \n HTTP methods: GET, POST \n These APIs manage details of a collection or a specific consistency group. \n\n* Endpoint: /application/consistency-groups/{uuid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage consistency groups. \n\n* Endpoint: /application/consistency-groups/{uuid}/{consistency_group.uuid}/snapshots \n HTTP methods: GET, POST \n These APIs manage snapshot copies of a collection or a specific consistency group. \n\n* Endpoint: /application/consistency-groups/{uuid}/{consistency_group.uuid}/snapshots/{uuid} \n HTTP methods: GET, DELETE \n These APIs manage details of a specific snapshot for a consistency group. \n\n* Endpoint: /support/auto-update \n HTTP methods: GET, PATCH \n These APIs manage the current status of the automatic update feature and the End User License Agreement (EULA). \n\n* Endpoint: /support/auto-update/configurations \n HTTP methods: GET \n This API retrieves the configuration for automatic updates. \n\n* Endpoint: /support/auto-update/configurations/{uuid} \n HTTP methods: GET, PATCH \n These APIs manage the configuration for a specified automatic update. \n\n* Endpoint: /support/auto-update/updates \n HTTP methods: GET \n This API retrieves the status of all updates. \n\n* Endpoint: /support/auto-update/updates/{uuid} \n HTTP methods: GET, PATCH \n These APIs manage the status of an update. \n\n* Endpoint: /support/coredump/coredumps \n HTTP methods: GET \n This API retrieves a collection of coredumps. \n\n* Endpoint: /support/coredump/coredumps/{node.uuid}/{name} \n HTTP methods: GET, DELETE \n These APIs manage a specific core dump. \n\n* Endpoint: /security/anti-ransomware/suspects \n HTTP methods: GET \n This API retrieves information on the suspects generated by the anti-ransomware analytics. \n\n* Endpoint: /security/anti-ransomware/suspects/{volume.uuid} \n HTTP methods: DELETE \n This API clears either all the suspect files of a volume or suspect files of a volume based on file format or suspect time provided. \n\n* Endpoint: /security/azure-key-vaults/{uuid}/rekey-internal \n HTTP methods: POST \n This API rekeys the internal key in the key hierarchy for an SVM with an AKV configuration. \n\n* Endpoint: /security/azure-key-vaults/{uuid}/restore \n HTTP methods: POST \n This API restores the keys for an SVM from a configured AKV. \n\n* Endpoint: /security/gcp-kms/{uuid}/rekey-internal \n HTTP methods: POST \n This API rekeys the internal key in the key hierarchy for an SVM with a Google Cloud KMS configuration. \n\n* Endpoint: /security/gcp-kms/{uuid}/restore \n HTTP methods: POST \n This API restores the keys for an SVM from a configured Google Cloud KMS. \n\n* Endpoint: /security/ipsec/ca-certificates \n HTTP methods: GET, POST \n These APIs are for the collection of IPsec CA certificates configured for all SVMs. \n\n* Endpoint: /security/ipsec/ca-certificates/{svm.uuid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage the IPsec CA certificates configured for the specified SVM. \n\n* Endpoint: /security/key-manager-configs \n HTTP methods: GET, PATCH \n These APIs are used for key manager configurations. \n\n* Endpoint: /security/key-stores \n HTTP methods: GET \n This API retrieves keystores. \n\n* Endpoint: /security/ssh/svms \n HTTP methods: GET \n This API retrieves the SSH server configuration for all the SVMs. \n\n* Endpoint: /security/ssh/svms/{svm.uuid} \n HTTP methods: GET, PATCH \n These APIs manage the SSH server configuration for the specified SVM. \n\n* Endpoint: /storage/file/clone/split-loads \n HTTP methods: GET \n This API retrieves the clone split load of a node. \n\n* Endpoint: /storage/file/clone/split-loads/{node.uuid} \n HTTP methods: GET, PATCH \n These APIs manage Volume File Clone Split Load. \n\n* Endpoint: /storage/file/clone/split-status \n HTTP methods: GET \n This API retrieves file clone split status of all volumes in the node. \n\n* Endpoint: /storage/file/clone/split-status/{volume.uuid} \n HTTP methods: GET \n This API retrieves file clone split status of provided volume in the node. \n\n* Endpoint: /storage/file/clone/tokens \n HTTP methods: GET, POST \n These APIs manage tokens to reserve the split load. \n\n* Endpoint: /storage/file/clone/tokens/{node.uuid}/{uuid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage file clone tokens for the specified node. \n\n* Endpoint: /storage/ports/{node.uuid}/{name} \n HTTP methods: PATCH \n This API updates a storage port. \n\n* Endpoint: /storage/qos/workloads \n HTTP methods: GET \n This API retrieves a collection of QoS workloads. \n\n* Endpoint: /storage/qos/workloads/{uuid} \n HTTP methods: GET \n This API retrieves a specific QoS workload. \n\n* Endpoint: /storage/shelves/{uid} \n HTTP methods: PATCH \n This API updates a shelf location LED. \n\n* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/clients \n HTTP methods: GET \n This API retrieves a list of clients with the most IO activity. \n\n* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/directories \n HTTP methods: GET \n This API retrieves a list of directories with the most IO activity. \n\n* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/files \n HTTP methods: GET \n This API retrieves a list of files with the most IO activity. \n\n* Endpoint: /storage/volumes/{volume.uuid}/top-metrics/users \n HTTP methods: GET \n This API retrieves a list of users with the most IO activity. \n\n* Endpoint: /storage/snaplock/compliance-clocks \n HTTP methods: POST \n This API initializes the SnapLock ComplianceClock. \n\n* Endpoint: /protocols/cifs/domains \n HTTP methods: GET \n This API retrieves the CIFS domain-related information of all SVMs. \n\n* Endpoint: /protocols/cifs/domains/{svm.uuid} \n HTTP methods: GET \n This API retrieves the CIFS domain-related information for the specified SVM. \n\n* Endpoint: /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers \n HTTP methods: GET, POST \n These APIs are for the CIFS domain preferred DC configuration of an SVM. \n\n* Endpoint: /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers/{fqdn}/{server_ip} \n HTTP methods: GET, DELETE \n These APIs manage the CIFS domain preferred DC configuration for the specified SVM and domain. \n\n* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{sid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage local group information for the specified group and SVM. \n\n* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members \n HTTP methods: GET, POST, DELETE \n These APIs manage local users, Active Directory users and Active Directory groups which are members of the specified local group and SVM. \n\n* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_cifs_group.sid}/members/{name} \n HTTP methods: GET, DELETE \n These APIs manage the local user, Active Directory user and/or Active Directory group from the specified local group and SVM. \n\n* Endpoint: /protocols/cifs/local-users/{svm.uuid}/{sid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage local user information for the specified user and SVM. \n\n* Endpoint: /protocols/cifs/users-and-groups/bulk-import/{svm.uuid} \n HTTP methods: GET, POST, PATCH \n These APIs manage CIFS local users,groups and group memberships file from the specified URL. \n\n* Endpoint: /protocols/event-selectors \n HTTP methods: GET, POST \n These APIs manage S3 audit event-selector configurations for all SVMs. \n\n* Endpoint: /protocols/event-selectors/{svm.uuid}/{bucket} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage an S3 audit event selector configuration for an SVM. \n\n* Endpoint: /protocols/file-security/permissions/{svm.uuid}/{path} \n HTTP methods: DELETE \n This API removes all SLAG ACLs for specified path. Bulk deletion is supported only for SLAG. \n\n* Endpoint: /protocols/fpolicy/{svm.uuid}/connections \n HTTP methods: GET \n This API retrieves the statuses of FPolicy servers. \n\n* Endpoint: /protocols/fpolicy/{svm.uuid}/connections/{node.uuid}/{policy.name}/{server} \n HTTP methods: GET, PATCH \n These APIs manage the status of an FPolicy server. \n\n* Endpoint: /protocols/locks \n HTTP methods: GET \n This API retrieves locks details. \n\n* Endpoint: /protocols/locks/{uuid} \n HTTP methods: GET, DELETE \n These APIs manage locks for the specified Lock ID. \n\n* Endpoint: /protocols/s3audits \n HTTP methods: GET, POST \n These APIs manage S3 audit configuration. \n\n* Endpoint: /protocols/s3audits/{svm.uuid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage an S3 audit configuration for an SVM. \n\n\n## 9.9.1 library updates\n\n**New endpoints**\n\n* Endpoint: /name-services/unix-groups \n HTTP methods: GET, POST \n These APIs allow management of the UNIX groups for all of the SVMs. \n\n* Endpoint: /name-services/unix-groups/{svm.uuid}/{name} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage UNIX group information for the specified group and SVM. \n\n* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users \n HTTP methods: POST \n This API adds users to the specified UNIX group and SVM. \n\n* Endpoint: /name-services/unix-groups/{svm.uuid}/{unix_group.name}/users/{name} \n HTTP methods: DELETE \n This API deletes a user from the specified UNIX group. \n\n* Endpoint: /name-services/unix-users \n HTTP methods: GET, POST \n These APIs manage all local UNIX users and configuration for SVMs. \n\n* Endpoint: /name-services/unix-users/{svm.uuid}/{name} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage UNIX user information for the specified user and SVM. \n\n* Endpoint: /protocols/san/igroups/{igroup.uuid}/igroups \n HTTP methods: GET,POST \n These APIs manage nested initiator groups of an initiator group. \n\n* Endpoint: /protocols/san/igroups/{igroup.uuid}/igroups/{uuid} \n HTTP methods: GET, DELETE \n These APIs manage a nested initiator group of an initiator group. \n\n* Endpoint: /protocols/san/igroups/{igroup.uuid}/initiators/{name} \n HTTP methods: PATCH \n Updates an initiator of an initiator group. This API only supports modification of initiators owned directly by the initiator group. Initiators of nested initiator groups must be modified on the initiator group that directly owns the initiator. \n\n* Endpoint: /protocols/san/portsets \n HTTP methods: GET, POST \n These APIs are for portsets. \n\n* Endpoint: /protocols/san/portsets/{uuid} \n HTTP methods: GET, DELETE \n These APIs used for a portset. \n\n* Endpoint: /protocols/san/portsets/{portset.uuid}/interfaces \n HTTP methods: GET, POST \n These APIs are for interfaces of a portset. \n\n* Endpoint: /protocols/san/portsets/{portset.uuid}/interfaces/{uuid} \n HTTP methods: GET, DELETE \n These APIs are for a network interface of a portset. \n\n* Endpoint: /security/gcp-kms \n HTTP methods: GET, POST \n These APIs manage Google Cloud KMS configurations for all clusters and SVMs. \n\n* Endpoint: /security/gcp-kms/{uuid} \n HTTP methods: GET, PATCH, DELETE \n These APIs are for managing the Google Cloud KMS configuration for the SVM specified by the UUID. \n\n* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/rekey-internal \n HTTP methods: POST \n This API rekeys the internal key in the key hierarchy for an SVM with a Google Cloud KMS configuration. \n\n* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/restore \n HTTP methods: POST \n This API restores the keys for an SVM from a configured Google Cloud KMS. \n\n* Endpoint: /storage/bridges \n HTTP methods: GET \n This API retrieves a collection of bridges. \n\n* Endpoint: /storage/bridges/{wwn} \n HTTP methods: GET \n This API retrieves a specific bridge \n\n* Endpoint: /storage/flexcache/origins/{uuid} \n HTTP methods: PATCH \n This API modifies origin options for a origin volume in the cluster. \n\n* Endpoint: /storage/switches \n HTTP methods: GET \n This API retrieves a collection of storage switches. \n\n* Endpoint: /storage/switches/{name} \n HTTP methods: GET \n This API retrieves a specific storage switch. \n\n* Endpoint: /storage/tape-devices \n HTTP methods: GET \n This API retrieves a collection of tape devices. \n\n* Endpoint: /storage/tape-devices/{node.uuid}/{device_id} \n HTTP methods: GET \n This API retrieves a specific tape. \n\n* Endpoint: /protocols/ndmp/svms/{svm.uuid}/passwords/{user} \n HTTP methods: GET \n This API generates and retrieves the password for the specified NDMP user. \n\n* Endpoint: /protocols/cifs/local-groups \n HTTP methods: GET, POST \n These APIs are for the local groups for all of the SVMs. \n\n* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{group_sid} \n HTTP methods: GET, PATCH, DELETE \n These APIs are for local group information of the specified group and SVM. \n\n* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_group.group_sid}/members \n HTTP methods: GET, POST, DELETE \n These APIs manage local users, Active Directory users and Active Directory groups which are members of the specified local group and SVM. \n\n* Endpoint: /protocols/cifs/local-groups/{svm.uuid}/{local_group.group_sid}/members/{name} \n HTTP methods: GET, DELETE \n These APIs are for the local user, Active Directory user and/or Active Directory group from the specified local group and SVM. \n\n* Endpoint: /protocols/cifs/local-users \n HTTP methods: GET, POST \n These APIs are for local users of all of the SVMs. \n\n* Endpoint: /protocols/cifs/local-users/{svm.uuid}/{user_sid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage local user information for the specified user and SVM. \n\n* Endpoint: /protocols/cifs/sessions/{node.uuid}/{svm.uuid}/{identifier}/{connection_id} \n HTTP methods: DELETE \n This API deletes SMB session information on a node for an SVM. \n\n* Endpoint: /protocols/cifs/users-and-groups/privileges \n HTTP methods: GET, POST \n These APIs manage privileges of the specified local or Active Directory user or group and SVM. \n\n* Endpoint: /protocols/cifs/users-and-groups/privileges/{svm.uuid}/{name} \n HTTP methods: GET, PATCH \n These APIs are for privileges of the specified local or Active Directory user or group and SVM. \n\n* Endpoint: /protocols/file-security/permissions/{svm.uuid}/{path} \n HTTP methods: GET, POST, PATCH \n These APIs manage file permissions \n\n* Endpoint: /protocols/file-security/permissions/{svm.uuid}/{path}/acl \n HTTP methods: POST, PATCH, DELETE \n These APIs manage the new SACL/DACL ACL. \n\n\n## 9.8.0 library updates\n\n**Fixed issues**\n\n* [Bug ID 1349122](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1349122)\n\nDue to a type mismatch between documentation and implementation, some endpoints were failing because of a validation error.\n\n## ONTAP 9.8 REST API updates ##\nAll new ONTAP APIs have corresponding library resource objects which can be used\nto perform the operations. See the `netapp_ontap.resources` package for details\nabout each of the objects and their fields.\n\nFor a summary of the changes in the ONTAP REST API between versions of ONTAP 9, see the [ONTAP 9 Release Notes](https://library.netapp.com/ecm/ecm_download_file/ECMLP2492508).\n\n**New endpoints**\n\n* Endpoint: /cluster/firmware/history \n HTTP methods: GET \n This API retrieves the details history of firmware update requests for the cluster. \n\n* Endpoint: /cluster/licensing/capacity-pools \n HTTP methods: GET \n This API retrieves information about associations between ONTAP nodes in the cluster and capacity pool licenses. It can also report how much capacity each node is consuming from the pool. \n\n* Endpoint: /cluster/licensing/license-managers \n HTTP methods: GET, PATCH \n These APIs allow for managing information about the license manager associated with the cluster. \n\n* Endpoint: /cluster/mediators \n HTTP methods: GET, POST, DELETE \n These APIs allow for adding or removing a mediator to MetroCluster over IP configuration as well as retrieving the status of the existing mediator. \n\n* Endpoint: /cluster/metrocluster \n HTTP methods: GET, POST, PATCH \n These APIs allows for creating, performing operations, and retrieving relevant information pertaining to MetroCluster. \n\n* Endpoint: /cluster/metrocluster/diagnostics \n HTTP methods: GET, POST\n This API can be used to initiate a MetroCluster diagnostics operation and fetch the results of a completed diagnostic operation. \n\n* Endpoint: /cluster/metrocluster/dr-groups \n HTTP methods: GET, POST, DELETE \n These APIs allow for creating, performing operations, and retrieving relevant information about MetroCluster DR groups. \n\n* Endpoint: /cluster/metrocluster/interconnects \n HTTP methods: GET \n This API retrieves information pertaining to MetroCluster interconnect status. \n\n* Endpoint: /cluster/metrocluster/nodes \n HTTP methods: GET \n This API retrieves details about MetroCluster nodes. \n\n* Endpoint: /cluster/metrocluster/operations \n HTTP methods: GET \n This API retrieves the list of MetroCluster operations on the local cluster. \n\n* Endpoint: /cluster/nodes/{uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for a node. \n\n* Endpoint: /cluster/software/upload \n HTTP methods: POST \n This API uploads a software or firmware package located on the local filesystem. \n\n* Endpoint: /network/ethernet/ports/{uuid}/metrics \n HTTP methdos: GET \n This API retrieves historical performance metrics for a port. \n\n* Endpoint: /network/ethernet/switch/ports \n HTTP methods: GET \n This API can be used to get the port information for an ethernet switch used in a cluster or storage networks. \n\n* Endpoint: /network/ethernet/switches \n HTTP methods: GET, PATCH \n These APIs can be used to retrieve and modify ethernet switches used for the cluster and/or storage networks. \n\n* Endpoint: /network/fc/interfaces/{uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for an FC interface. \n\n* Endpoint: /network/fc/ports/{uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for an FC port. \n\n* Endpoint: /network/ip/interfaces/{uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for an interface. \n\n* Endpoint: /network/ip/service-policies \n HTTP methods: POST, PATCH, DELETE \n These APIs allow for creating, modifying, and deleting a servicy policy for network interfaces. \n\n* Endpoint: /storage/namespaces/{uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for an NVMe namespace. \n\n* Endpoint: /security \n HTTP methods: PATCH \n This API updates the software FIPS mode or enables conversion of non-encrypted metadata volumes to encrypted metadata volumes and non-NAE aggregates to NAE aggregates. \n\n* Endpoint: /security/azure-key-vaults \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow for managing Azure Key Vaults on a cluster. \n\n* Endpoint: /security/azure-key-vaults/{azure_key_vault.uuid}/rekey-internal \n HTTP methods: POST \n This API rekeys the internal key in the key hierarchy for an SVM with and AKV configuration. \n\n* Endpoint: /security/azure-key-vaults/{azure_key_vault.uuid}/restore \n HTTP methods: POST \n This API restores the keys for an SVM from a configures AKV. \n\n* Endpoint: /security/certificate-signing-request \n HTTP methods: POST \n This API generates a Certificate Signing Request and a private key pair. \n\n* Endpoint: /security/gcp-kms \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow ONTAP to store encryption keys using Google Cloud Key Management Services. \n\n* Endpoint: /security/gcp-kms/{gcp_kms.uuid}/restore \n HTTP methods: POST \n This API restores the keys for an SVM from a configure Google Cloud Key Management Service. \n\n* Endpoint: /security/ipsec \n HTTP methods: GET, PATCH \n These APIs allow for retrieving and updating IPsec status. \n\n* Endpoint: /security/ipsec/policies \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow for creating, retrieving information about, and updating IPsec policies. \n\n* Endpoint: /security/ipsec/security-associations \n HTTP methods: GET \n This API retrieves the IPsec and IKE(Internet Key Exchange) security associations. \n\n* Endpoint: /storage/file/copy \n HTTP methods: POST \n This API starts a file copy operations which is only supported on flexible volumes. \n\n* Endpoint: /storage/file/move \n HTTP methods: POST \n This API starts a file move operation which is only supported on flexible volumes. \n\n* Endpoint: /storage/flexcache/flexcaches/{uuid} \n HTTP methods: PATCH \n This API prepopulates a FlexCache volume in the cluster. \n\n* Endpoint: /storage/monitored-files \n HTTP methods: GET, POST, DELETE \n These APIs allow for creating, deleting, and retrieving information about monitored files. \n\n* Endpoint: /storage/monitored-files/{monitored_file.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for the monitored file. \n\n* Endpoint: /storage/snapshot-policies/{snapshot_policy.uuid}/schedules \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs perform operations related to Snapshot copy policy schedules. \n\n* Endpoint: /storage/volume-efficiency-policies \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow for configuring volume efficiency policies on a cluster. \n\n* Endpoint: /storage/volumes/{volume.uuid}/files/{path} \n HTTP methods: POST, PATCH, DELETE \n These APIs allow for creating files, modifying files, and deleting files on a volume. \n\n* Endpoint: /private/protocols/audit/audit-log-redirect \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs can be used to specify a dedicated SVM for all NAS auditing event log to reside in. \n\n* Endpoint: /protocols/cifs/sessions \n HTTP methods: GET \n This API retrieves the CIFS sessions information for all SVMs. \n\n* Endpoint: /protocols/cifs/sessions/{node.uuid}/{svm.uuid}/{identifier}/{connection_id} \n HTTP methods: GET \n This API retrieves SMB session information for a specific SMF connection of a SVM in a node. \n* Endpoint: /protocols/file-access-tracing/events \n HTTP methods: GET, DELETE \n These APIs retrieves or delete trace results for access allowed or denied events. \n\n* Endpoint: /protocols/file-access-tracing/filters \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage security trace filter entries. \n\n* Endpoint: /protocols/file-security/effective-permissions/{svm.uuid}/{path} \n HTTP methods: GET \n This API displays the effective permissions granted to a Windows or UNIX user on the specified file or folder path. \n\n* Endpoint: /private/manage/event-remediations \n HTTP methods: GET, PATCH \n These APIs allow for retrieving about and performing event management actions. \n\n* Endpoint: /protocols/s3/buckets \n HTTP methods: POST \n This API creates the S3 bucket configuration for an SVM. \n\n* Endpoint: /protocols/s3/buckets/{svm.uuid}/{uuid} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage S3 bucket configurations for the specified SVM. \n\n* Endpoint: /protocols/s3/services/{svm.uuid}/groups \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage S3 group configurations for the specified SVM. \n\n* Endpoint: /protocols/s3/services/{svm.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for the S3 protocol of an SVM. \n\n* Endpoint: /protocols/s4/services/{svm.uuid}/policies \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow for configuring S3 policies for the specified SVM. \n\n\n## 9.7.0 library updates \n\n**New**\n\n* A `count_collection()` method is now available on all resources which have a `get_collection()`. This method is a shortcut for getting only the number of items matching a query. For example: `Volume.count_collection(name=\"backup_vol*\")` is roughly equivalent to `len(list(Volume.get_collection(name=\"backup_vol*\")))`.\n\n* The application can now add its own custom headers for each request as part of the `netapp_ontap.host_connection.HostConnection` object.\n\n* When passing verify=False to the HostConnection, the library will now disable urllib3's InsecureRequestWarning from logging messages.\n\n**Fixed issues**\n\n* [Bug ID 1322090](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1322090) \n When polling jobs, the certificate verification setting was hard-coded to False, so it would behave the same regardless of how the user set it.\n\n* [Bug ID 1322095](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1322095) \n The get_collection() call using the connection parameter was not correctly setting the connection on the returned resource objects.\n\n* [Bug ID 1279507](ihttps://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1279507) \n When doing a find() with the fields query parameter, the library was not returning the specified fields, instead, all fields were being returned.\n\n* [Bug ID 1291333](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1291333) \n When 0 records are found in a Resource.find() call and LOG_ALL_API_CALLS is set to True, then an uncaught exception is raised.\n\n* [Bug ID 1271450](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1271450) \n The library doesn't allow sending a body in a DELETE request.\n\n* [Bug ID 1263312](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1263312) \n When POSTing or PATCHing some objects with embedded objects, fields might incorrectly be dropped from the request.\n\n* [Bug ID 1275238](https://mysupport.netapp.com/site/bugs-online/product/ONTAP/BURT/1275238) \n Retrieving and setting the \"from\" field of Autosupport object fails.\n\n**Incompatibilities**\n\n* In prior versions, Resource.find() would raise an exception if no results were found as well as when more than one was found. In this version, when no results are found, None is returned instead of raising an exception. An exception is still raised when more than one result is found.\n\n\n\n##ONTAP 9.7 REST API updates\n\nAll new ONTAP APIs have corresponding library resource objects which can be used\nto perform the operations. See the `netapp_ontap.resources` package for details\nabout each of the objects and their fields.\n\nFor a summary of the changes in the ONTAP REST API between versions of ONTAP 9, see the [ONTAP 9 Release Notes](https://library.netapp.com/ecm/ecm_download_file/ECMLP2492508).\n\n**New endpoints**\n\n* Endpoint: /cluster/nodes/{uuid} \n HTTP methods: DELETE \n This API will remove a node from the cluster. \n\n* Endpoint: /cluster/ntp/keys/{id} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow for management of NTP server shared keys.\n\n* Endpoint: /cluster/ntp/servers/{server} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs allow for management of keyed NTP servers.\n\n* Endpoint: /cluster/software/download \n HTTP methods: GET \n This API allows monitoring the status of the image package download progress.\n\n* Endpoint: /network/http-proxy/{uuid} \n HTTP methods: GET, POST, PATCH, DELETE \n This API allow configuration of an HTTP proxy for the cluster of SVM IP spaces.\n\n* Endpoint: /network/ip/bgp/peer-groups/{uuid} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage information pertaining to the BGP peer-groups configured in the cluster.\n\n* Endpoint: /protocols/san/fcp/services/{svm.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for the FC Protocols service of an SVM.\n\n* Endpoint: /protocos/san/iscsi/services/{svm.uuid}/metrics \n HTTP methods: GET \n This API retrieves history performance metrics for the iSCSI protocol of an SVM.\n\n* Endpoint: /storage/luns/{uuid}/metrics \n HTTP methods: GET \n This API retrieves history performance metrics for a LUN.\n\n* Endpoint: /protocls/nvme/services/{svm.uuid}/metrics \n HTTP methods: GET \n This API retrieve historical performance metrics for NVME protocol of an SVM.\n\n* Endpoint: /support/configuration-backup/{node.uuid}/name \n HTTP methods: GET, POST, DELETE \n These APIs create, retrieve, and delete backup configuraiton for the cluster.\n\n* Endpoint: /support/snmp/traphosts/{host} \n HTTP methods: GET, POST, DELETE \n These APIs configure SNMP traphosts which will receive SNMP traps from ONTAP.\n\n* Endpoint: /support/snmp/users/{engine_id}/{name} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs configure SNMP users that are able to query for the ONTAP SNMP server.\n\n* Endpoint: /security \n HTTP methods: GET \n This API retrieves information about the security configured on the cluster.\n\n* Endpoint: /security/authentication/cluster/ad-proxy \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs configure which data SVM will be use to proxy cluster management AD authentication.\n\n* Endpoint: /security/authentiation/publickeys/{owner.uuid}/{account.name}/{index} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs configure the public keys for user accounts.\n\n* Endpoint: /security/key-managers/{source.uuid}/migrate \n HTTP methods: POST \n This API migrates the keys belonging to an SVM between the cluster's key manager and the SVM's key manager.\n\n* Endpoint: /security/ssh \n HTTP methods: GET, PATCH \n This API manages the SSH server running in ONTAP.\n\n* Endpoint: /storage/aggregates/{uuid}/metrics \n HTTP methods: GET \n This API provide historical performance metrics for the specified aggregate.\n\n* Endpoint: /storage/disks \n HTTP methods: PATCH \n This API updates the encryption controls of self-encrypting disks.\n\n* Endpoint: /storage/snapshot-policies/{snapshot-policy.uuid}/schedules/{uuid} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage the policies reqarding when snapshots are taken.\n\n* Endpoint: /protocols/ndmp \n HTTP methods: GET, PATCH \n This API manages NDMP mode at either SVM-scope or node-scope.\n\n* Endpoint: /protocols/ndmp/{node.uuid} \n HTTP methods: GET, PATCH \n This API manages node-scoped NDMP settings.\n\n* Endpoint: /protocols/ndmp/sessions/{owner.uuid}/{session.id} \n HTTP methods: GET, DELETE \n These APIs manage diagnostics information on NDMP settings belonging to a specific SVM in the case of SVM-scope or to a specific node in the case of node-scope.\n\n* Endpoint: /protocols/ndmp/svms/{svm.uuid} \n HTTP methods: GET, PATCH \n These APIs manage SVM-scoped NDMP settings.\n\n* Endpoint: /storage/snaplock/audit-logs/{svm.uuid} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage the loggin policies for a snaplock volume.\n\n* Endpoint: /storage/snaplock/compliance-clocks/{node.uuid} \n HTTP methods: GET \n This API manages the Compliance Clock of the system which determines the expiry time of the SnapLock objects in the system.\n\n* Endpoint: /storage/snaplock/event-retention/operations/{id} \n HTTP methods: GET, POST \n These APIs display all Event Based Retentions (EBR) operations and allow for applying an EBR policy on a specified volume.\n\n* Endpoint: /storage/snaplock/event-retention/policies/{policy.name} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage retention policies for snaplock files and directories.\n\n* Endpoint: /storage/snaplock/files/{volume.uuid}/{path} \n HTTP methods: GET, PATCH, DELETE \n These APIs manage the SnapLock retention time of a file.\n\n* Endpoint: /storage/snaplock/file-fingerprints/{id} \n HTTP methods: GET, POST, DELETE \n These APIs manage key information about snaplock files and volumes.\n\n* Endpoint: /storage/snaplock/litigations/{id} \n HTTP methods: GET, POST, DELETE \n These APIs retain Compliance-mode WORM files for the duration of a litigation.\n\n* Endpoint: /storage/snaplock/litigations/{litigation.id/files \n HTTP methods: GET \n This API displays the list of files under the specified litigation ID.\n\n* Endpoint: /storage/snaplock/litigations/{litigation.id}/operations/{id} \n HTTP methods: GET, POST, DELETE \n This API manages the legal-hold operations for the specified litigation ID.\n\n* Endpoint: /protocols/cifs/services/{svm.uuid}/metrics \n HTTP methods: GET \n This API retrieves history performance metrics for the CIFS protocol of an SVM.\n\n* Endpoint: /protocols/nfs/connected-clients \n HTTP methods: GET \n This API provides a list of currently connected NFS clients or clients that can be connected but are currently idle.\n\n* Endpoint: /protocols/nfs/services/{svm.uuid}/metrics \n HTTP methods: GET \n This API retrieves historical performance metrics for the NFS protocol of an SVM.\n\n* Endpoint: /protocols/s3/buckets \n HTTP methods: GET \n This API retrieves all S3 buckets for all SVMs.\n\n* Endpoint: /protocols/s3/services/{svm.uuid} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage S3 servers which will allow you to store objects in ONTAP using Amazon S3 protocol.\n\n* Endpoint: /protocols/s3/services/{svm.uuid}/buckets/{uuid} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage S3 buckets which are a container of objects.\n\n* Endpoint: /protocols/s3/services/{svm.uuid}/users/{name} \n HTTP methods: GET, POST, PATCH, DELETE \n These APIs manage S3 user accounts on the server. Buckets that are created are associate with a user.\n\n## 9.6.0 \n(2019-07-16)\n\nInitial release of the library\n\n# Copyright, trademarks, and feedback\n## Copyright information\nCopyright © 2023 NetApp, Inc. All Rights Reserved. Printed in the U.S.\n\nNo part of this document covered by copyright may be reproduced in any form or by any means\u2014graphic,\nelectronic, or mechanical, including photocopying, recording, taping, or storage in an electronic\nretrieval system\u2014without prior written permission of the copyright owner.\n\nSoftware derived from copyrighted NetApp material is subject to the following license\nand disclaimer:\n\nTHIS SOFTWARE IS PROVIDED BY NETAPP \"AS IS\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,\nINCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY\nDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\nBUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\nWHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN\nANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\nNetApp reserves the right to change any products described herein at any time, and without notice.\nNetApp assumes no responsibility or liability arising from the use of products described herein,\nexcept as expressly agreed to in writing by NetApp. The use or purchase of this product does not\nconvey a license under any patent rights, trademark rights, or any other intellectual property\nrights of NetApp. The product described in this manual may be protected by one or more U.S.\npatents, foreign patents, or pending applications.\n\nRESTRICTED RIGHTS LEGEND: Use, duplication,or disclosure by the government is subject to\nrestrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and\nComputer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).\n\n## Trademark information\nNETAPP, the NETAPP logo, and the marks listed on the NetApp Trademarks page are trademarks of\nNetApp, Inc. Other company and product names may be trademarks of their respective owners.\nhttp://www.netapp.com/us/legal/netapptmlist.aspx\n\n## Feedback\nIf you have questions about the library, suggestions, or find a bug, you may contact\nby email.\n\n<ng-ontap-rest-python-lib@netapp.com>\n\nYou can help us to improve the quality of our documentation by sending us your feedback.\nIf you have suggestions for improving this document, send us your comments by email.\n\n<doccomments@netapp.com>\n\nTo help us direct your comments to the correct division, include in the subject line\nthe product name, version, and operating system.\n\nIf you want to be notified automatically when production-level documentation is released\nor important changes are made to existing production-level documents,\nfollow Twitter account @NetAppDoc.\n\nYou can also contact us in the following ways:\n\nNetApp, Inc., 3060 Olsen Drive, San Jose, CA 95128 U.S.\n\nTelephone: +1 (408) 822-6000\n\nFax: +1 (408) 822-4501\n\nSupport telephone: +1 (888) 463-8277\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A library for working with ONTAP's REST APIs simply in Python",
"version": "9.14.1.0",
"project_urls": {
"Documentation": "https://library.netapp.com/ecmdocs/ECMLP2886776/html/index.html",
"Homepage": "https://devnet.netapp.com/restapi.php"
},
"split_keywords": [
"netapp",
"ontap",
"rest",
"api",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32dbbf77b7a608d25462996bef8ba0d69f2ca20e150fffff54e1a782643a46d0",
"md5": "cde4f49236c1c6a968efd2f095740013",
"sha256": "495e679e10e61b9bb2cf5a432a5cdaf9f2ec56855540ba221c021d31a6b91eb7"
},
"downloads": -1,
"filename": "netapp_ontap-9.14.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cde4f49236c1c6a968efd2f095740013",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 26459166,
"upload_time": "2023-11-22T16:34:07",
"upload_time_iso_8601": "2023-11-22T16:34:07.680598Z",
"url": "https://files.pythonhosted.org/packages/32/db/bf77b7a608d25462996bef8ba0d69f2ca20e150fffff54e1a782643a46d0/netapp_ontap-9.14.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3e8556ea0f26537c2f86b5d574b1f92bfbf1a4d8878b74f91cb15065022e0d1",
"md5": "1dffe97ac78bc5064ec320ca83bbe692",
"sha256": "9e1ed21dccae8d35574a0c506a3440e04b9e37a1dff1c2ae7906ec6e7afafaac"
},
"downloads": -1,
"filename": "netapp_ontap-9.14.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1dffe97ac78bc5064ec320ca83bbe692",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8649608,
"upload_time": "2023-11-22T16:34:18",
"upload_time_iso_8601": "2023-11-22T16:34:18.305603Z",
"url": "https://files.pythonhosted.org/packages/c3/e8/556ea0f26537c2f86b5d574b1f92bfbf1a4d8878b74f91cb15065022e0d1/netapp_ontap-9.14.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 16:34:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "netapp-ontap"
}
JSON