# Module `netapp_ontap.resources.network_http_proxy`

Copyright © 2021 NetApp Inc. All rights reserved.

## Overview

Configuration of an HTTP proxy for an SVM or a Cluster IPspace.

## Retrieve HTTP proxy information

The HTTP proxy GET operation retrieves all configurations for an SVM or a Cluster IPspace via '/api/cluster'.

## Examples

### Retrieving all fields for all HTTP proxy configurations

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NetworkHttpProxy

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

Try it out

    [
        NetworkHttpProxy(
            {
                "server": "server1.example.com",
                "uuid": "4133a1fc-7228-11e9-b40c-005056bb4f0c",
                "svm": {"name": "vs1", "uuid": "4133a1fc-7228-11e9-b40c-005056bb4f0c"},
                "port": 3128,
                "authentication_enabled": False,
            }
        ),
        NetworkHttpProxy(
            {
                "server": "1.1.1.",
                "ipspace": {
                    "name": "Default",
                    "uuid": "7433520f-7214-11e9-828c-005056bb4f0c",
                },
                "uuid": "96219ce3-7214-11e9-828c-005056bb4f0c",
                "svm": {
                    "name": "cluster-1",
                    "uuid": "96219ce3-7214-11e9-828c-005056bb4f0c",
                },
                "port": 3128,
                "authentication_enabled": True,
            }
        ),
    ]

### Retrieving the HTTP proxy configuration for a specific SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NetworkHttpProxy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = NetworkHttpProxy(uuid="96219ce3-7214-11e9-828c-005056bb4f0c")
        resource.get()
        print(resource)

Try it out

    NetworkHttpProxy(
        {
            "server": "1.1.1.1",
            "ipspace": {"name": "Default", "uuid": "7433520f-7214-11e9-828c-005056bb4f0c"},
            "uuid": "96219ce3-7214-11e9-828c-005056bb4f0c",
            "svm": {"name": "cluster-1", "uuid": "96219ce3-7214-11e9-828c-005056bb4f0c"},
            "port": 3128,
            "authentication_enabled": False,
        }
    )

## Creating an HTTP proxy configuration

You can use the HTTP proxy POST operation to create an HTTP proxy configuration for the specified SVM.

## Examples

### Creating an HTTP proxy configuration for a particular SVM

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NetworkHttpProxy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = NetworkHttpProxy()
        resource.port = 3128
        resource.server = "1.1.1.1"
        resource.svm.name = "cluster-1"
        resource.post(hydrate=True)
        print(resource)

### Creating an HTTP proxy configuration for a particular IPspace

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NetworkHttpProxy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = NetworkHttpProxy()
        resource.ipspace.name = "Default"
        resource.port = 3128
        resource.server = "1.1.1.1"
        resource.post(hydrate=True)
        print(resource)

### Creating an HTTP proxy configuration with authentication enabled

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NetworkHttpProxy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = NetworkHttpProxy()
        resource.ipspace.name = "Default"
        resource.port = 3128
        resource.server = "1.1.1.1"
        resource.authentication_enabled = True
        resource.username = "test"
        resource.password = "test"
        resource.post(hydrate=True)
        print(resource)

## Update an HTTP proxy configuration for a specified SVM

You can use the HTTP proxy PATCH operation to update the HTTP proxy configuration for the specified SVM.

## Example

The following example shows how a PATCH operation is used to update an HTTP proxy configuration for a specific SVM:

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NetworkHttpProxy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = NetworkHttpProxy(uuid="96219ce3-7214-11e9-828c-005056bb4f0c")
        resource.port = 3128
        resource.server = "server2.example.com"
        resource.patch()

## Delete an HTTP proxy configuration for a specified SVM

You can use the HTTP proxy DELETE operation to delete the HTTP proxy configuration for the specified SVM.

## Example

The following example shows how a DELETE operation is used to delete an HTTP proxy configuration for a specific SVM:

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import NetworkHttpProxy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = NetworkHttpProxy(uuid="96219ce3-7214-11e9-828c-005056bb4f0c")
        resource.delete()

## Classes

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

  Allows interaction with NetworkHttpProxy 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

  ### Static methods

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

    Retrieves the HTTP proxy configurations of all the SVMs and Cluster IPspaces.

    ### Related ONTAP commands

    - `vserver http-proxy show`

    ### Learn more

    - `DOC /network/http-proxy`

    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, body: typing.Union = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes the HTTP proxy configuration of the specified SVM or Cluster IPspace.

    ### Related ONTAP commands

    - `vserver http-proxy delete`

    ### Learn more

    - `DOC /network/http-proxy`

    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.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `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 HTTP proxy configurations of all the SVMs and Cluster IPspaces.

    ### Related ONTAP commands

    - `vserver http-proxy show`

    ### Learn more

    - `DOC /network/http-proxy`

    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) -> typing.Iterable`

    Retrieves the HTTP proxy configurations of all the SVMs and Cluster IPspaces.

    ### Related ONTAP commands

    - `vserver http-proxy show`

    ### Learn more

    - `DOC /network/http-proxy`

    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, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Updates the proxy server, port, username, and password parameters. Important notes: * IPv6 must be enabled if IPv6 family addresses are specified in the "server" field. * The server and the port combination specified using the "server" and "port" fields is validated during this operation. The validation will fail in the following scenarios: * The HTTP proxy service is not configured on the server. * The HTTP proxy service is not running on the specified port. * The server is unreachable.

    ### Related ONTAP commands

    - `vserver http-proxy modify`

    ### Learn more

    - `DOC /network/http-proxy`

    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.
    `*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.
    `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

  ### Methods

  `def delete(self, body: typing.Union = None, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Deletes the HTTP proxy configuration of the specified SVM or Cluster IPspace.

    ### Related ONTAP commands

    - `vserver http-proxy delete`

    ### Learn more

    - `DOC /network/http-proxy`

    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`

    Displays the HTTP proxy server, port, and IPspace of the specified SVM or Cluster IPspace.

    ### Related ONTAP commands

    - `vserver http-proxy show`

    ### Learn more

    - `DOC /network/http-proxy`

    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: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Updates the proxy server, port, username, and password parameters. Important notes: * IPv6 must be enabled if IPv6 family addresses are specified in the "server" field. * The server and the port combination specified using the "server" and "port" fields is validated during this operation. The validation will fail in the following scenarios: * The HTTP proxy service is not configured on the server. * The HTTP proxy service is not running on the specified port. * The server is unreachable.

    ### Related ONTAP commands

    - `vserver http-proxy modify`

    ### Learn more

    - `DOC /network/http-proxy`

    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: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Creates an HTTP proxy configuration for an SVM or a Cluster IPspace. Important notes: * IPv6 must be enabled if IPv6 family addresses are specified in the "server" field. * The server and the port combination specified using the "server" and "port" fields is validated during this operation. The validation will fail in the following scenarios: * The HTTP proxy service is not configured on the server. * The HTTP proxy service is not running on the specified port. * The server is unreachable.

    ### Required properties

    - SVM-scoped HTTP proxy
    - `svm.uuid` or `svm.name` - Existing SVM in which to create the HTTP proxy.
    - Cluster-scoped HTTP proxy
    - `ipspace.uuid` or `ipspace.name` - Exisitng Cluster IPspace in which to create the HTTP proxy.
    - `server` - HTTP proxy server FQDN or IP address.
    - `port` - HTTP proxy server port.

    ### Optional properties

    - `authentication_enabled` - Specifies if authentication is required for the HTTP proxy server.
    - `username` - Username used to authenticate with the HTTP proxy server.
    - `password` - Password used to authenticate with the HTTP proxy server.

    ### Related ONTAP commands

    - `vserver http-proxy create`

    ### Learn more

    - `DOC /network/http-proxy`

    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 NetworkHttpProxySchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)`

  The fields of the NetworkHttpProxy object

  ### Ancestors

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

  ### Class variables

  `authentication_enabled GET POST PATCH`

    Specifies whether or not authentication with the HTTP proxy server is enabled.

  `ipspace GET POST`

    The ipspace field of the network_http_proxy.

  `links GET`

    The links field of the network_http_proxy.

  `password POST PATCH`

    Password to authenticate with the HTTP proxy server when authentication_enabled is set to "true".

  `port GET POST PATCH`

    The port number on which the HTTP proxy service is configured on the proxy server.

    Example: 3128

  `scope GET`

    Set to “svm” for HTTP proxy owned by an SVM. Otherwise, set to "cluster".

    Valid choices:

    - svm
    - cluster
  `server GET POST PATCH`

    Fully qualified domain name (FQDN) or IP address of the HTTP proxy server.

  `svm GET POST`

    The svm field of the network_http_proxy.

  `username POST PATCH`

    Username to authenticate with the HTTP proxy server when authentication_enabled is set to "true".

  `uuid GET`

    The UUID that uniquely identifies the HTTP proxy.