Module netapp_ontap.resources.auto_update_status
Copyright © 2023 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
Overview
Use this API to retrieve the status for a specific automatic package update.
This API supports GET and PATCH calls. PATCH can be used to perform an action on an automatic update.Examples
Retrieving the status of an update
The following example shows how to retrieve the status of an automatic update:
from netapp_ontap import HostConnection
from netapp_ontap.resources import AutoUpdateStatus
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = AutoUpdateStatus(uuid="440ae2e4-fd8f-4225-9bee-94e2da3f8d9d")
resource.get()
print(resource)
AutoUpdateStatus(
{
"package_id": "572361f3-e769-439d-9c04-2ba48a08ff47",
"creation_time": "2020-12-01T09:12:03+00:00",
"percent_complete": 25,
"_links": {"self": {}},
"start_time": "2020-12-01T09:12:23+00:00",
"uuid": "440ae2e4-fd8f-4225-9bee-94e2da3f8d9d",
"content_type": "disk_fw",
"state": "downloading",
"remaining_time": "PT1M30S",
"content_category": "Firmware",
"expiry_time": "2021-06-01T09:12:03+00:00",
"last_state_change_time": "2020-12-01T09:12:23+00:00",
"description": "disk_fw version 3.0",
"status": {
"code": "8650878",
"message": "Get-url request to AutoSupport OnDemand Server failed. Error: Couldn't connect to server.",
},
}
)
Updating the state of an automatic update
The following example shows how to trigger an automatic update that is waiting for user confirmation:
from netapp_ontap import HostConnection
from netapp_ontap.resources import AutoUpdateStatus
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = AutoUpdateStatus(uuid="440ae2e4-fd8f-4225-9bee-94e2da3f8d9d")
resource.patch(hydrate=True, action="schedule_now")
The following example shows how to dismiss an automatic update that is waiting for user confirmation:
from netapp_ontap import HostConnection
from netapp_ontap.resources import AutoUpdateStatus
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = AutoUpdateStatus(uuid="440ae2e4-fd8f-4225-9bee-94e2da3f8d9d")
resource.patch(hydrate=True, action="dismiss")
Classes
class AutoUpdateStatus (*args, **kwargs)
-
Allows interaction with AutoUpdateStatus 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
Static methods
def count_collection (*args, connection: HostConnection = None, **kwargs) -> int
-
Returns a count of all AutoUpdateStatus 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 find (*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves the status of all updates.
Learn more
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 status of all updates.
Learn more
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
objectsRaises
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('AutoUpdateStatus')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Perform an action on the update.
Learn more
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
Methods
def get (self, **kwargs) -> NetAppResponse
-
Retrieves the status of an update.
Learn more
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: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse
-
Perform an action on the update.
Learn more
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.
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 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
class AutoUpdateStatusSchema (*, 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 AutoUpdateStatus object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
action: str PATCH
-
Action to be applied to the automatic update.
Valid choices:
- cancel_schedule
- dismiss
- schedule
- schedule_now
- abort
- undismiss
-
content_category: str GET
-
Category of the update
Example: Firmware
-
content_type: str GET
-
Image or package type.
Example: disk_fw
-
creation_time: ImpreciseDateTime GET
-
The date and time at which the update request was received.
Example: 2020-12-01T09:12:23.000+0000
-
description: str GET
-
Description of the update.
Example: disk_fw version 3.0
-
end_time: ImpreciseDateTime GET
-
The date and time at which the update request processing ended.
Example: 2020-12-01T09:12:23.000+0000
-
expiry_time: ImpreciseDateTime GET
-
The date and time at which the update request will expire.
Example: 2021-06-01T09:12:23.000+0000
-
last_state_change_time: ImpreciseDateTime GET
-
The date and time at which the state of the update changed last.
Example: 2020-12-01T09:12:23.000+0000
-
links: ApplicationNvmeAccessSubsystemMapSubsystemHostsLinks GET POST PATCH
-
The links field of the auto_update_status.
-
package_id: str GET
-
Unique identifier provided by the back-end.
Example: 572361f3-e769-439d-9c04-2ba48a08ff47
-
percent_complete: Size GET
-
Percentage of update completed
Example: 85
-
remaining_time: str GET
-
The time remaining for the update processing to complete in an ISO-8601 duration formatted string.
Example: PT1H45M13S
-
schedule_time: ImpreciseDateTime PATCH
-
Date and time when an automatic update action is scheduled. This field is required when the action field is set to "schedule".
Example: 2020-12-20T21:00:00.000+0000
-
scheduled_time: ImpreciseDateTime GET
-
The date and time at which the update request is currently scheduled for.
Example: 2020-12-05T09:12:23.000+0000
-
start_time: ImpreciseDateTime GET
-
The date and time at which the update request processing started.
Example: 2020-12-01T09:12:23.000+0000
-
state: str GET
-
Current state of the update.
Valid choices:
- pending_confirmation
- downloading
- applying
- applied
- dismissed
- scheduled
- failed
- aborted
-
status: Error GET
-
The status field of the auto_update_status.
-
uuid: str GET
-
Unique identifier for this update.
Example: 440ae2e4-fd8f-4225-9bee-94e2da3f9d8d