Module `netapp_ontap.resources.s3_service`

Overview

An S3 server is an object store server that is compatible with the Amazon S3 protocol. In the initial version, only a subset of the protocol features necessary to support Fabric Pool capacity tier usecases are implemented. S3 server allows you to store objects in ONTAP using Amazon S3 protocol. This feature can be used as a target object store server for ONTAP FabricPools.

Performance monitoring

Performance of the SVM can be monitored by the metric.* and statistics.* properties. These show the performance of the SVM in terms of IOPS, latency and throughput. The metric.* properties denote an average whereas statistics.* properties denote a real-time monotonically increasing value aggregated across all nodes.

Examples

Retrieving all of the S3 configurations

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(S3Service.get_collection(fields="*", return_timeout=15)))

Try it out

[
    S3Service(
        {
            "enabled": False,
            "svm": {"uuid": "cf90b8f2-8071-11e9-8190-0050568eae21", "name": "vs2"},
            "comment": "S3 server",
            "name": "s1",
        }
    ),
    S3Service(
        {
            "enabled": True,
            "buckets": [
                {
                    "uuid": "e08665af-8114-11e9-8190-0050568eae21",
                    "logical_used_size": 157286400,
                    "volume": {
                        "uuid": "de146bff-8114-11e9-8190-0050568eae21",
                        "name": "fg_oss_1559026220",
                    },
                    "comment": "s3 bucket",
                    "size": 209715200,
                    "encryption": {"enabled": False},
                    "name": "bucket-1",
                },
                {
                    "uuid": "fb1912ef-8114-11e9-8190-0050568eae21",
                    "logical_used_size": 78643200,
                    "volume": {
                        "uuid": "f9b1cdd0-8114-11e9-8190-0050568eae21",
                        "name": "fg_oss_1559026269",
                    },
                    "comment": "s3 bucket",
                    "size": 104857600,
                    "encryption": {"enabled": False},
                    "name": "bucket-2",
                },
            ],
            "users": [
                {
                    "comment": "S3 user",
                    "name": "user-1",
                    "access_key": "3333_w162ypaTi7_aAQuJo76Z16zc9Gz_W3IN83bDQWkcCN3jYU_z_xn20XATMKKa90509KCH__r4lh1IPU58vf1QlWAJt8k2F1BPjPtM6CsDRX_dOP_QZkF5N9fBuz3",
                },
                {
                    "comment": "",
                    "name": "user-2",
                    "access_key": "g6T24qhH92dOA6gc1WTcDO_2oNZhQ6Drl2zu5_s5Id_QK1wLgghgxsD2xP1xqG7oX1T_9AI0D39q65CY3FAg0CbAtVU_903bSnCnht3xqjbrF5_3Cs9RnY8nE_az1Ltc",
                },
            ],
            "svm": {"uuid": "d7f1219c-7f8e-11e9-9124-0050568eae21", "name": "vs1"},
            "comment": "S3 server",
            "name": "Server-1",
        }
    ),
]

Retrieving all S3 configurations for a particular SVM

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3Service(**{"svm.uuid": "24c2567a-f269-11e8-8852-0050568e5298"})
    resource.get(fields="*")
    print(resource)

Try it out

S3Service(
    {
        "enabled": True,
        "buckets": [
            {
                "uuid": "e08665af-8114-11e9-8190-0050568eae21",
                "logical_used_size": 157286400,
                "policy": {
                    "statements": [
                        {
                            "principals": ["mike"],
                            "effect": "deny",
                            "resources": [
                                "bucket-1/policy-docs/*",
                                "bucket-1/confidential-*",
                            ],
                            "actions": ["*Object"],
                            "sid": "DenyAccessToGetPutDeleteObjectForMike",
                        },
                        {
                            "principals": ["*"],
                            "effect": "allow",
                            "resources": ["bucket-1/readme"],
                            "actions": ["GetObject"],
                            "sid": "AccessToGetObjectForAnonymousUser",
                        },
                    ]
                },
                "volume": {
                    "uuid": "de146bff-8114-11e9-8190-0050568eae21",
                    "name": "fg_oss_1559026220",
                },
                "comment": "s3 bucket",
                "size": 209715200,
                "encryption": {"enabled": False},
                "name": "bucket-1",
            },
            {
                "uuid": "fb1912ef-8114-11e9-8190-0050568eae21",
                "logical_used_size": 1075838976,
                "volume": {
                    "uuid": "f9b1cdd0-8114-11e9-8190-0050568eae21",
                    "name": "fg_oss_1559026269",
                },
                "comment": "s3 bucket",
                "size": 1677721600,
                "encryption": {"enabled": False},
                "name": "bucket-2",
            },
        ],
        "users": [
            {
                "comment": "s3 user",
                "name": "user-1",
                "access_key": "3333_w162ypaTi7_aAQuJo76Z16zc9Gz_W3IN83bDQWkcCN3jYU_z_xn20XATMKKa90509KCH__r4lh1IPU58vf1QlWAJt8k2F1BPjPtM6CsDRX_dOP_QZkF5N9fBuz3",
            },
            {
                "comment": "",
                "name": "user-2",
                "access_key": "g6T24qhH92dOA6gc1WTcDO_2oNZhQ6Drl2zu5_s5Id_QK1wLgghgxsD2xP1xqG7oX1T_9AI0D39q65CY3FAg0CbAtVU_903bSnCnht3xqjbrF5_3Cs9RnY8nE_az1Ltc",
            },
        ],
        "svm": {"uuid": "d7f1219c-7f8e-11e9-9124-0050568eae21", "name": "vs1"},
        "comment": "S3 server",
        "name": "Server-1",
    }
)

Creating an S3 server, users, and buckets configurations with required fields specified

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3Service()
    resource.buckets = [{"name": "bucket-1"}, {"name": "bucket-2"}]
    resource.enabled = True
    resource.name = "Server-1"
    resource.svm = {"uuid": "d49ef663-7f8e-11e9-9b2c-0050568e4594"}
    resource.users = [{"name": "user-1"}, {"name": "user-2"}]
    resource.post(hydrate=True)
    print(resource)

Try it out

S3Service(
    {
        "users": [
            {
                "name": "user-1",
                "access_key": "x129aL0q9bu3J_4_2S0OcU34AA5DJXXB_j9R34_60tqiqAS5_c8PAgN6Lg1zkv_76P4IxNWir9st9uhhgldb31u364Cczq_c39C1fUP7HDheUmYY6u4xt61_N7Sw6c33",
            },
            {
                "name": "user-2",
                "access_key": "nntYZrNN65mKn57yS04o1sDp_D0AY58jdwCW573_5x2OPW09AbyFl86DB7r30N2373_bA12n08aovQp8ySItRss9AjsYoSj7TsIiHOW_Y21DaqYPl5I2a849b11y8X4c",
            },
        ],
        "_links": {"self": {"href": "/api/protocols/s3/services/"}},
    }
)

Creating an S3 server, users, and buckets configurations

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3Service()
    resource.buckets = [
        {
            "aggregates": [
                {"name": "aggr1", "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"}
            ],
            "constituents_per_aggregate": 4,
            "name": "bucket-1",
            "size": "209715200",
            "policy": {
                "statements": [
                    {
                        "actions": ["*"],
                        "conditions": [
                            {
                                "operator": "ip_address",
                                "source_ips": ["1.1.1.1/23", "1.2.2.2/20"],
                            }
                        ],
                        "effect": "allow",
                        "resources": ["bucket-1", "bucket-1*"],
                        "sid": "fullAccessForAllPrincipalsToBucket",
                    }
                ]
            },
        },
        {
            "aggregates": [
                {"name": "aggr1", "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"},
                {"name": "aggr2", "uuid": "982fc4d0-d1a2-4da4-9c47-5b433f24757d"},
            ],
            "constituents_per_aggregate": 4,
            "name": "bucket-2",
        },
    ]
    resource.enabled = True
    resource.name = "Server-1"
    resource.svm = {"name": "vs1", "uuid": "d49ef663-7f8e-11e9-9b2c-0050568e4594"}
    resource.users = [{"name": "user-1"}, {"name": "user-2"}]
    resource.post(hydrate=True)
    print(resource)

Try it out

S3Service(
    {
        "users": [
            {
                "name": "user-1",
                "access_key": "x129aL0q9bu3J_4_2S0OcU34AA5DJXXB_j9R34_60tqiqAS5_c8PAgN6Lg1zkv_76P4IxNWir9st9uhhgldb31u364Cczq_c39C1fUP7HDheUmYY6u4xt61_N7Sw6c33",
            },
            {
                "name": "user-2",
                "access_key": "nntYZrNN65mKn57yS04o1sDp_D0AY58jdwCW573_5x2OPW09AbyFl86DB7r30N2373_bA12n08aovQp8ySItRss9AjsYoSj7TsIiHOW_Y21DaqYPl5I2a849b11y8X4c",
            },
        ],
        "_links": {"self": {"href": "/api/protocols/s3/services/"}},
    }
)

Creating an S3 server configuration

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3Service()
    resource.comment = "S3 server"
    resource.enabled = True
    resource.name = "Server-1"
    resource.svm = {"name": "vs1", "uuid": "db2ec036-8375-11e9-99e1-0050568e3ed9"}
    resource.post(hydrate=True)
    print(resource)

Disable s3 server for the specified SVM

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3Service(**{"svm.uuid": "03ce5c36-f269-11e8-8852-0050568e5298"})
    resource.enabled = False
    resource.patch()

Deleting the S3 server for a specified SVM

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3Service(**{"svm.uuid": "a425f10b-ad3b-11e9-b559-0050568e8222"})
    resource.delete(delete_all=False)

Deleting all of the S3 server configuration for a specified SVM

from netapp_ontap import HostConnection
from netapp_ontap.resources import S3Service

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = S3Service(**{"svm.uuid": "03ce5c36-f269-11e8-8852-0050568e5298"})
    resource.delete(delete_all=True)

Classes

class S3Service (*args, **kwargs)

Specifies the S3 server configuration.

Initialize the instance of the resource.

Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

MyResource(name='foo').name == 'foo'

Args

*args: Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs: each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

Ancestors

Resource

Static methods

def count_collection(*args, connection: HostConnection = None, **kwargs) -> int

Fetch a count of all objects of this type from the host.

This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

Returns

On success, returns an integer count of the objects of this type. On failure, returns -1.

Raises

NetAppRestError: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

def delete_collection(*args, records: Iterable[_ForwardRef('S3Service')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Deletes the S3 server configuration of an SVM. If the 'delete_all' parameter is set to false, only the S3 server is deleted. Otherwise S3 users and buckets present on the SVM are also deleted. Note that only empty buckets can be deleted. This endpoint returns the S3 server delete job-uuid in response. To monitor the job status follow /api/cluster/jobs/.

vserver object-store-server delete

Learn more

DOC /protocols/s3/services

Delete all objects in a collection which match the given query.

All records on the host which match the query will be deleted.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
records: Can be provided in place of a query. If so, this list of objects will be deleted from the host.
body: The body of the delete request. This could be a Resource instance or a dictionary object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be deleted.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def find(*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves the S3 server configuration for all SVMs. Note that in order to retrieve S3 bucket policy conditions, 'fields' option should be set to '**'.

Expensive properties

There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more. * statistics.* * metric.*

vserver object-store-server show

Learn more

DOC /protocols/s3/services

Find an instance of an object on the host given a query.

The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host.

Returns

A Resource object containing the details of the object or None if no matches were found.

Raises

NetAppRestError: If the API call returned more than 1 matching resource.

def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]

Retrieves the S3 server configuration for all SVMs. Note that in order to retrieve S3 bucket policy conditions, 'fields' option should be set to '**'.

Expensive properties

vserver object-store-server show

Learn more

DOC /protocols/s3/services

Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records: The maximum number of records to return per call
**kwargs: Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

def patch_collection(body: dict, *args, records: Iterable[_ForwardRef('S3Service')] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Updates the S3 Server configuration of an SVM.

vserver object-store-server modify

Learn more

DOC /protocols/s3/services

Patch all objects in a collection which match the given query.

All records on the host which match the query will be patched with the provided body.

Args

body: A dictionary of name/value pairs to set on all matching members of the collection. The body argument will be ignored if records is provided.
*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to patch the collection of bars for a particular foo, the foo.name value should be passed.
records: Can be provided in place of a query. If so, this list of objects will be patched on the host.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def post_collection(records: Iterable[_ForwardRef('S3Service')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> Union[List[S3Service], NetAppResponse]

Creates an S3 server, users, and buckets configurations.

Important notes

Each SVM can have one S3 server configuration.
One or more buckets and users can also be created using this end-point.
If creating a user configuration fails, buckets are not created either and already created users are not saved.
If creating a bucket configuration fails, all buckets already created are saved with no new buckets created.

Required properties

svm.uuid - Existing SVM in which to create an S3 server configuration.

Recommended optional properties

enabled - Specifies the state of the server created.
comment - Any information related to the server created.

Default property values

comment - ""
enabled - true

vserver object-store-server create
vserver object-store-server bucket create
vserver object-store-server bucket policy statement create
vserver object-store-server bucket policy-statement-condition create
vserver object-store-server user create

Learn more

DOC /protocols/s3/services

Send this collection of objects to the host as a creation request.

Args

records: A list of Resource objects to send to the server to be created.
*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to create a bar for a particular foo, the foo.name value should be passed.
hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of each object. When hydrate is set to True, poll must also be set to True.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A list of Resource objects matching the provided
type which have been created by the host and returned. This is _not_
the same list that was provided, so to continue using the object, you

should save this list. If poll is set to False, then a NetAppResponse object is returned instead.

Raises

NetAppRestError: If the API call returned a status code >= 400

Methods

def delete(self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

vserver object-store-server delete

Learn more

DOC /protocols/s3/services

Send a deletion request to the host for this object.

Args

body: The body of the delete request. This could be a Resource instance or a dictionary object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def get(self, **kwargs) -> NetAppResponse

Retrieves the S3 Server configuration of an SVM. Note that in order to retrieve S3 bucket policy conditions, the 'fields' option should be set to '**'.

vserver object-store-server show

Learn more

DOC /protocols/s3/services

Fetch the details of the object from the host.

Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def patch(self, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

Updates the S3 Server configuration of an SVM.

vserver object-store-server modify

Learn more

DOC /protocols/s3/services

Send the difference in the object's state to the host as a modification request.

Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.

Args

hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs: Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def post(self, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

Creates an S3 server, users, and buckets configurations.

Important notes

Each SVM can have one S3 server configuration.
One or more buckets and users can also be created using this end-point.
If creating a user configuration fails, buckets are not created either and already created users are not saved.
If creating a bucket configuration fails, all buckets already created are saved with no new buckets created.

Required properties

svm.uuid - Existing SVM in which to create an S3 server configuration.

Recommended optional properties

enabled - Specifies the state of the server created.
comment - Any information related to the server created.

Default property values

comment - ""
enabled - true

vserver object-store-server create
vserver object-store-server bucket create
vserver object-store-server bucket policy statement create
vserver object-store-server bucket policy-statement-condition create
vserver object-store-server user create

Learn more

DOC /protocols/s3/services

Send this object to the host as a creation request.

Args

hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs: Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Inherited members

Resource:
- from_dict
- get_collection_url
- get_connection
- instance_location
- path_keys
- poll
- set_connection
- to_dict

class S3ServiceSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)

The fields of the S3Service object

Ancestors

netapp_ontap.resource.ResourceSchema
marshmallow.schema.Schema
marshmallow.base.SchemaABC

Class variables

buckets GET POST: The buckets field of the s3_service.
certificate GET POST PATCH: The certificate field of the s3_service.
comment GET POST PATCH: Can contain any additional information about the server being created or modified.

Example: S3 server
enabled GET POST PATCH: Specifies whether the S3 server being created or modified should be up or down.
is_http_enabled GET POST PATCH: Specifies whether HTTP is enabled on the S3 server being created or modified. By default, HTTP is disabled on the S3 server.
is_https_enabled GET POST PATCH: Specifies whether HTTPS is enabled on the S3 server being created or modified. By default, HTTPS is enabled on the S3 server.
links GET: The links field of the s3_service.
metric GET: The metric field of the s3_service.
name GET POST PATCH: Specifies the name of the S3 server. A server name can contain 1 to 253 characters using only the following combination of characters':' 0-9, A-Z, a-z, ".", and "-".

Example: Server-1
port GET POST PATCH: Specifies the HTTP listener port for the S3 server. By default, HTTP is enabled on port 80.
secure_port GET POST PATCH: Specifies the HTTPS listener port for the S3 server. By default, HTTPS is enabled on port 443.
statistics GET: The statistics field of the s3_service.
svm GET POST: The svm field of the s3_service.
users GET POST: The users field of the s3_service.

Overview

Performance monitoring

Examples

Retrieving all of the S3 configurations

Retrieving all S3 configurations for a particular SVM

Creating an S3 server, users, and buckets configurations with required fields specified

Creating an S3 server, users, and buckets configurations

Creating an S3 server configuration

Disable s3 server for the specified SVM

Deleting the S3 server for a specified SVM

Deleting all of the S3 server configuration for a specified SVM

Classes

Args

Ancestors

Static methods

Args

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Expensive properties

Related ONTAP commands

Learn more

Args

Returns

Raises

Expensive properties

Related ONTAP commands

Learn more

Args

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Important notes

Required properties

Recommended optional properties

Default property values

Related ONTAP commands

Learn more

Args

Returns

Raises

Methods

Related ONTAP commands

Learn more

Args

Returns

Raises

Related ONTAP commands

Learn more

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Important notes

Required properties

Recommended optional properties

Default property values

Related ONTAP commands

Learn more

Args

Returns

Raises

Inherited members

Ancestors

Class variables