# Module `netapp_ontap.resources.web_svm`

Copyright © 2022 NetApp Inc. All rights reserved.

You can use this API to update and retrieve the web services security configuration for each data SVM.

## Updating the web services security configuration

The following fields can be used to update the web services security configuration:

- certificate.uuid
- client_enabled
- ocsp_enabled When updating the certificate, the certificate UUID of an existing certificate known to ONTAP must be provided. The certificate must be of type "server". A "client-ca" certificate must be installed on ONTAP to enable "client_enabled".

## Examples

### Retrieving the web services security configuration

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import WebSvm

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = WebSvm("3c1b259d-5789-a2eb-9301-10705682b34f")
        resource.get()
        print(resource)

Try it out

    WebSvm(
        {
            "svm": {
                "_links": {
                    "self": {"href": "/api/svm/svms/3c1b259d-5789-a2eb-9301-10705682b34f"}
                },
                "uuid": "3c1b259d-5789-a2eb-9301-10705682b34f",
                "name": "svm2",
            },
            "certificate": {
                "name": "cert1",
                "uuid": "a3bb219d-4382-1fe0-9c06-1070568ea23d",
                "_links": {
                    "self": {
                        "href": "/api/security/certificates/a3bb219d-4382-1fe0-9c06-1070568ea23d"
                    }
                },
            },
            "client_enabled": False,
            "ocsp_enabled": False,
            "_links": {
                "self": {"href": "/api/svm/svms/3c1b259d-5789-a2eb-9301-10705682b34f/web"}
            },
        }
    )

### Updating the web services security configuration

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import WebSvm

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = WebSvm("3c1b259d-5789-a2eb-9301-10705682b34f")
        resource.certificate = {"uuid": "56da2799-13bc-2ae4-0c16-0c71244ea2ca"}
        resource.patch()

## Classes

`class WebSvm (*args, **kwargs)`

  Allows interaction with WebSvm objects on the host

  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

  ### Methods

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

    Retrieves the web services security configuration.

    ### Learn more

    - `DOC /svm/svms/{svm.uuid}/web`

    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 web services security configuration.

    ### Learn more

    - `DOC /svm/svms/{svm.uuid}/web`

    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

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class WebSvmSchema (*, 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 WebSvm object

  ### Ancestors

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

  ### Class variables

  `certificate GET POST PATCH`

    The certificate field of the web_svm.

  `client_enabled GET POST PATCH`

    Indicates whether client authentication is enabled.

  `links GET`

    The links field of the web_svm.

  `ocsp_enabled GET POST PATCH`

    Indicates whether online certificate status protocol verification is enabled.

  `svm GET POST PATCH`

    The svm field of the web_svm.