WorkRequestClient

class oci.os_management_hub.WorkRequestClient(config, **kwargs)

Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).

Methods

__init__(config, **kwargs) Creates a new service client
get_work_request(work_request_id, **kwargs) Gets information about the specified work request.
list_work_request_errors(work_request_id, …) Gets the errors for the specified work request.
list_work_request_logs(work_request_id, **kwargs) Gets the logs for the specified work request.
list_work_requests(**kwargs) Lists work requests that match the specified compartment or work request OCID.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
get_work_request(work_request_id, **kwargs)

Gets information about the specified work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the work request.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequest
Return type:

Response
Example:

Click here to see an example of how to use get_work_request API.

list_work_request_errors(work_request_id, **kwargs)

Gets the errors for the specified work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the work request.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

    Example: 3

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.

    Allowed values are: “timeCreated”, “displayName”

  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestErrorCollection
Return type:

Response
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

Gets the logs for the specified work request.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the work request.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

    Example: 3

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.

    Allowed values are: “timeCreated”, “displayName”

  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestLogEntryCollection
Return type:

Response
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(**kwargs)

Lists work requests that match the specified compartment or work request OCID. Filter the list against a variety of criteria including but not limited to its name, status, and operation type.

Parameters:
  • compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.
  • work_request_id (str) –

    (optional) The OCID of the work request.

  • status (list[str]) –

    (optional) A filter to return work requests that match the given status.

    Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

  • resource_id (str) –

    (optional) The OCID of the resource. This filter returns resources associated with the specified resource.

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

    Example: 3

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.

    Allowed values are: “timeCreated”, “displayName”

  • initiator_id (str) –

    (optional) The OCID of the schedule job that initiated the work request.

  • parent_id (str) –

    (optional) The OCID of the parent work request.

  • parent_resources_not_equal_to (list[str]) –

    (optional) A filter to return the resources whose parent resources are not the same as the given resource OCIDs.

  • operation_type (list[str]) –

    (optional) The asynchronous operation tracked by this work request. The filter returns only resources that match the given OperationType.

    Allowed values are: “INSTALL_PACKAGES”, “REMOVE_PACKAGES”, “UPDATE_PACKAGES”, “UPDATE_ALL_PACKAGES”, “UPDATE_SECURITY”, “UPDATE_BUGFIX”, “UPDATE_ENHANCEMENT”, “UPDATE_OTHER”, “UPDATE_KSPLICE_KERNEL”, “UPDATE_KSPLICE_USERSPACE”, “ENABLE_MODULE_STREAMS”, “DISABLE_MODULE_STREAMS”, “SWITCH_MODULE_STREAM”, “INSTALL_MODULE_PROFILES”, “REMOVE_MODULE_PROFILES”, “SET_SOFTWARE_SOURCES”, “LIST_PACKAGES”, “SET_MANAGEMENT_STATION_CONFIG”, “SYNC_MANAGEMENT_STATION_MIRROR”, “UPDATE_MANAGEMENT_STATION_SOFTWARE”, “UPDATE”, “MODULE_ACTIONS”, “LIFECYCLE_PROMOTION”, “CREATE_SOFTWARE_SOURCE”, “UPDATE_SOFTWARE_SOURCE”, “IMPORT_CONTENT”, “SYNC_AGENT_CONFIG”, “INSTALL_WINDOWS_UPDATES”, “LIST_WINDOWS_UPDATE”, “GET_WINDOWS_UPDATE_DETAILS”, “INSTALL_ALL_WINDOWS_UPDATES”, “INSTALL_SECURITY_WINDOWS_UPDATES”, “INSTALL_BUGFIX_WINDOWS_UPDATES”, “INSTALL_ENHANCEMENT_WINDOWS_UPDATES”, “INSTALL_OTHER_WINDOWS_UPDATES”, “REMOVE_CONTENT”, “UNREGISTER_MANAGED_INSTANCE”

  • display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name.
  • retry_of_id (str) –

    (optional) A filter to return the work requests that are a retry of the given work request OCIDs.

  • time_created_less_than (datetime) –

    (optional) A filter to return work requests that were created before the date provided (in RFC 3339 format). Example: ‘2023-08-25T21:10:29.600Z’

  • time_created_greater_than_or_equal_to (datetime) –

    (optional) A filter to return work requests that were created on or after the date provided (in RFC 3339 format). Example: ‘2023-08-25T21:10:29.600Z’

  • is_managed_by_autonomous_linux (bool) – (optional) Indicates whether to list only resources managed by the Autonomous Linux service.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestSummaryCollection
Return type:

Response
Example:

Click here to see an example of how to use list_work_requests API.