File manager - Edit - /usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/usn/execute/__pycache__/v1.cpython-310.pyc
Back
o �(�f�" � @ s d dl mZmZ d dlmZ d dlmZ d dlmZm Z d dl m Z m Z m Z mZmZ d dlmZmZ d dlmZ d dlmZmZmZmZ G d d � d e�ZG d d � d e�ZG d d� de�Z G dd� dee�Z dede fdd�Z dedede fdd�Z edde ed�Z dd d e g d d d d!�Z!d"S )#� )�List�Optional)� APIEndpoint)�AdditionalInfo)� FixStatus�get_expected_overall_status)� FailedUpgrade�FixExecuteError�FixExecuteResult�UpgradedPackage� _execute_fix)�USNFixPlanOptions�_plan)�UAConfig)� DataObject�Field�StringDataValue� data_listc @ s2 e Zd Zedee�dd�gZdee fdd�Z dS )�USNFixExecuteOptions�usnsz'A list of USNs (i.e. USN-6188-1) titles��docc C � || _ d S �N�r )�selfr � r �P/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/usn/execute/v1.py�__init__% � z USNFixExecuteOptions.__init__N) �__name__� __module__� __qualname__r r r �fieldsr �strr r r r r r s ��r c @ sL e Zd Zededd�edee�ddd�gZ d dedeee fd d �Z dS ) �FixExecuteUSNResult� target_usnz+The ``FixExecuteResult`` for the target USNr � related_usnsFz;A list of ``FixExecuteResult`` objects for the related USNs)�requiredr Nc C � || _ || _d S r )r& r' )r r& r' r r r r 8 s z FixExecuteUSNResult.__init__r ) r r! r" r r r r# r r r r r r r r% ) s& ����� �r% c @ sB e Zd Zededd�edee�dd�gZdede e fdd�Z dS ) �USNAPIFixExecuteResult�statusz The status of fixing the USNsr r z)A list of ``FixExecuteUSNResult`` objectsc C r) r �r+ r )r r+ r r r r r K s z USNAPIFixExecuteResult.__init__N) r r! r" r r r r% r# r$ r r r r r r r* A s �� r* c @ s* e Zd Zededd�gZdefdd�ZdS )�USNSAPIFixExecuteResult� usns_dataz,A list of ``USNAPIFixExecuteResult`` objectsr c C r r �r. )r r. r r r r Y r z USNSAPIFixExecuteResult.__init__N)r r! r" r r* r# r r r r r r- P s ��r- �options�returnc C s t | t� �S r )�_executer )r0 r r r �execute] s r3 �cfgc C s� t t| jd�|d�}g }tjjj}|jjD ]1}t|j �}t ||j �}t |d�}|j tj jjkrAg }|jD ] } |�t| �� q4||_|�|� qtt||d�d�S )z@ This endpoint fixes the specified USNs on the machine. r )r4 )r& r, r/ )r r r r �SYSTEM_NOT_AFFECTED�value�msgr. r �target_usn_planr r+ r% �SYSTEM_STILL_VULNERABLE�related_usns_plan�appendr' r- r* ) r0 r4 �fix_plan� usns_result�all_usns_status�usn�target_usn_result�usn_fix_execute_result�related_usns_result� related_usnr r r r2 a s0 ��� ��r2 �v1� USNFixExecute)�version�name�fn� options_cls�30Tz� from uaclient.api.u.pro.security.fix.usn.execute.v1 import execute, USNFixExecuteOptions options = USNFixExecuteOptions(usns=["USN-1234-1", "USN-1235-1"]) result = execute(options) zYpro api u.pro.security.fix.usn.execute.v1 --data '{"usns": ["USN-1234-1", "USN-1235-1"]}'a { "usns_data": { "status": "fixed", "usns": [ { "target_usn": { "title": "CVE-1234-56789", "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "error": null }, "related_usns": [] } ] } } a� .. tab-item:: Explanation :sync: explanation When using the USN endpoint, the expected output is as follows: .. code-block:: json { "usns_data": { "status": "fixed", "usns": [ { "target_usn": { "title": "CVE-1234-56789", "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "error": null }, "related_usns": [] } ] } } From this output, we can see that the **usns_data** object contains two attributes: * **usns**: A list of USN objects detailing what happened during the fix operation. * **status**: The status of the fix operation considering **all** USNs. This means that if one USN cannot be fixed, this field will reflect that. Note that related USNs don't interfere with this attribute, meaning that a related USN can fail to be fixed without modifying the **status** value. Each **usn** object contains a reference for both **target_usn** and **related_usns**. The target is the USN requested to be fixed by the user, while related USNs are USNs that are related to the main USN and an attempt to fix them will be performed by the endpoint too. To better understand that distinction, please refer to :ref:`our explanation of CVEs and USNs <expl-cve-usn>`. With that said both **target_usn** object and any object from **related_usns** follow this structure: * **title**: The title of the USN. * **description**: The USN description. * **error**: Any error captured when fixing the USN will appear here. The error object will be detailed in a following section. * **status**: The expected status of the USN after the fix operation. There are three possible scenarios: **fixed**, **still-affected** and **not-affected**. The system is considered **still-affected** if there is something that prevents any required packages from being upgraded. The system is considered **not-affected** if the USN doesn't affect the system at all. * **upgraded_packages**: A list of UpgradedPackage objects referencing each package that was upgraded during the fix operation. The UpgradedPackage object always contain the **name** of the package, the **version** it was upgraded to and the **pocket** where the package upgrade came from. **What errors can be generated?** There some errors that can happen when executing this endpoint. For example, the system might require the user to attach to a Pro subscription to install the upgrades, or the user might run the command as non-root when a package upgrade is needed. In those situations, the error JSON error object will follow this representation: .. code-block:: json { "error_type": "error-type", "reason": "reason", "failed_upgrades": [ { "name": "pkg1", "pocket": "esm-infra" } ] } We can see that the representation has the following fields: * **error_type**: The error type * **reason**: The explanation of why the error happened * **failed_upgrade**: A list of objects that always contain the name of the package that was not upgraded and the pocket where the upgrade would have come from. )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json�extraN)"�typingr r �uaclient.api.apir �uaclient.api.data_typesr �'uaclient.api.u.pro.security.fix._commonr r �2uaclient.api.u.pro.security.fix._common.execute.v1r r r r r �+uaclient.api.u.pro.security.fix.usn.plan.v1r r �uaclient.configr �uaclient.data_typesr r r r r r% r* r- r3 r2 �endpoint�_docr r r r �<module> sF �� �)� �
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.02 |
proxy
|
phpinfo
|
Settings