# Module `netapp_ontap.resources.software_package_download`

Copyright © 2020 NetApp Inc. All rights reserved.

## Classes

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

  Allows interaction with SoftwarePackageDownload 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 software download status.

    ### Related ONTAP commands

    - `cluster image package check-download-progress`

    ### Learn more

    - `DOC /cluster/software`

    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 post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Downloads a software package from the server.

    ### Required properties

    - `url` - URL location of the software package

    ### Recommended optional parameters

    - `username` - Username of HTTPS/FTP server
    - `password` - Password of HTTPS/FTP server

    ### Related ONTAP commands

    - `cluster image package get`

    ### Learn more

    - `DOC /cluster/software`

    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

  `async def software_package_download_create(password: str = None, url: str = None, username: str = None) -> netapp_ontap.resource_table.ResourceTable`

    Create an instance of a SoftwarePackageDownload resource

    ## Args

    `password`
      Password for download
    `url`
      HTTP or FTP URL of the package through a server
    `username`
      Username for download
  `def software_package_download_show(password: cliche.arg_types.choices.Choices.define.._Choices = None, url: cliche.arg_types.choices.Choices.define.._Choices = None, username: cliche.arg_types.choices.Choices.define.._Choices = None, fields: typing.List = None) -> netapp_ontap.resource_table.ResourceTable`

    Fetch a single SoftwarePackageDownload resource

    ## Args

    `password`
      Password for download
    `url`
      HTTP or FTP URL of the package through a server
    `username`
      Username for download

  ### Inherited members

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

  ### Ancestors

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

  ### Class variables

  `password POST`

    Password for download

    Example: admin_password

  `url POST`

    HTTP or FTP URL of the package through a server

    Example: http://server/package

  `username POST`

    Username for download

    Example: admin