# Module `netapp_ontap.resources.coredump`

Copyright © 2023 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Overview

The core dump GET API retrieves all of the core dumps on the cluster or a node. The core dump DELETE API deletes a specified core dump. Some fields are only populated for core dump type "kernel". Refer to the model for further information. Fields will not be displayed if they are not populated. A core can be deleted even if the core is in the process of being saved.

## Examples

### 1) Retrieving a list of core dumps from the cluster

## The following example returns a list of core dumps on the cluster:

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Coredump

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        print(list(Coredump.get_collection()))

Try it out

    [
        Coredump(
            {
                "name": "core.4136886422.2021-07-21.20_20_53.nz",
                "type": "kernel",
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/227683c1-e9c7-11eb-b995-005056bbbfb3"
                        }
                    },
                    "uuid": "227683c1-e9c7-11eb-b995-005056bbbfb3",
                    "name": "node2",
                },
                "_links": {
                    "self": {
                        "href": "/api/support/coredump/coredumps/227683c1-e9c7-11eb-b995-005056bbbfb3/core.4136886422.2021-07-21.20_20_53.nz"
                    }
                },
            }
        ),
        Coredump(
            {
                "name": "mlogd.968.4136886422.2021-07-22.01_10_01.ucore.bz2",
                "type": "application",
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/227683c1-e9c7-11eb-b995-005056bbbfb3"
                        }
                    },
                    "uuid": "227683c1-e9c7-11eb-b995-005056bbbfb3",
                    "name": "node2",
                },
                "_links": {
                    "self": {
                        "href": "/api/support/coredump/coredumps/227683c1-e9c7-11eb-b995-005056bbbfb3/mlogd.968.4136886422.2021-07-22.01_10_01.ucore.bz2"
                    }
                },
            }
        ),
        Coredump(
            {
                "name": "core.4136886421.2021-07-21.17_57_02.nz",
                "type": "kernel",
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/d583d44e-e9c6-11eb-a270-005056bb47f9"
                        }
                    },
                    "uuid": "d583d44e-e9c6-11eb-a270-005056bb47f9",
                    "name": "node1",
                },
                "_links": {
                    "self": {
                        "href": "/api/support/coredump/coredumps/d583d44e-e9c6-11eb-a270-005056bb47f9/core.4136886421.2021-07-21.17_57_02.nz"
                    }
                },
            }
        ),
        Coredump(
            {
                "name": "mlogd.979.4136886421.2021-07-22.01_11_37.ucore.bz2",
                "type": "application",
                "node": {
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/d583d44e-e9c6-11eb-a270-005056bb47f9"
                        }
                    },
                    "uuid": "d583d44e-e9c6-11eb-a270-005056bb47f9",
                    "name": "node1",
                },
                "_links": {
                    "self": {
                        "href": "/api/support/coredump/coredumps/d583d44e-e9c6-11eb-a270-005056bb47f9/mlogd.979.4136886421.2021-07-22.01_11_37.ucore.bz2"
                    }
                },
            }
        ),
    ]

### 2) Retrieving a specific core dump

## The following example returns the requested core dump. If there is no core dump with the requested node UUID and name, an error is returned.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Coredump

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Coredump(
            name="core.4136886421.2021-07-21.17_57_02.nz",
            **{"node.uuid": "d583d44e-e9c6-11eb-a270-005056bb47f9"}
        )
        resource.get()
        print(resource)

Try it out

    Coredump(
        {
            "name": "core.4136886421.2021-07-21.17_57_02.nz",
            "panic_time": "2021-07-21T13:57:02-04:00",
            "type": "kernel",
            "size": 945111148,
            "node": {
                "_links": {
                    "self": {
                        "href": "/api/cluster/nodes/d583d44e-e9c6-11eb-a270-005056bb47f9"
                    }
                },
                "uuid": "d583d44e-e9c6-11eb-a270-005056bb47f9",
                "name": "node1",
            },
            "_links": {
                "self": {
                    "href": "/api/support/coredump/coredumps/d583d44e-e9c6-11eb-a270-005056bb47f9/core.4136886421.2021-07-21.17_57_02.nz"
                }
            },
            "is_saved": True,
        }
    )

### 3) Deleting a core dump

## The following example deletes the requested core dump. If there is no core dump with the requested node UUID and name to delete, an error is returned.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Coredump

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Coredump(
            name="mlogd.979.4136886421.2021-07-22.01_11_37.ucore.bz2",
            **{"node.uuid": "d583d44e-e9c6-11eb-a270-005056bb47f9"}
        )
        resource.delete()

## Classes

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

  Allows interaction with Coredump 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`

    Returns a count of all Coredump resources that match the provided query

    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('Coredump')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes a core dump.

    ### Related ONTAP commands

    - `system node coredump delete`

    ### Learn more

    - `DOC /support/coredump/coredumps`

    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 fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]`

    Returns a list of RawResources that represent Coredump resources that match the provided query

    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
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**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 find (*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves a collection of coredumps.

    ### Related ONTAP commands

    - `system node coredump show`

    ### Learn more

    - `DOC /support/coredump/coredumps`

    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 a collection of coredumps.

    ### Related ONTAP commands

    - `system node coredump show`

    ### Learn more

    - `DOC /support/coredump/coredumps`

    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
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**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.

  ### Methods

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

    Deletes a core dump.

    ### Related ONTAP commands

    - `system node coredump delete`

    ### Learn more

    - `DOC /support/coredump/coredumps`

    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.
    `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 `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 a specific core dump.

    ### Related ONTAP commands

    - `system node coredump show`

    ### Learn more

    - `DOC /support/coredump/coredumps`

    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

  ### Inherited members

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

  ### Ancestors

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

  ### Class variables

  `is_partial: bool GET`

    Specifies whether or not the core is a partial core. Applicable only to kernel core dump type.

  `is_saved: bool GET`

    Specifies whether or not the core file is saved.

  `links: SelfLink GET`

    The links field of the coredump.

  `md5_data_checksum: str GET`

    MD5 checksum of the compressed data of core. Applicable only to kernel core dump type.

    Example: 5118488cc5065e33a16986001b1ffa48

  `name: str GET`

    Core name

    Example: core.4136886413.2021-03-01.22_09_11.nz

  `node: Node GET`

    The node field of the coredump.

  `panic_time: ImpreciseDateTime GET`

    Time of panic that generated the core.

    Example: 2021-03-01T22:09:11.000+0000

  `size: Size GET`

    Size of core, in bytes. Applicable only to kernel core dump type.

    Example: 1161629804

  `type: str GET`

    Core type, kernel or application

    Valid choices:

    - kernel
    - application