ScheduledJobClient¶

class oci.os_management_hub.ScheduledJobClient(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
`change_scheduled_job_compartment`(…)	Moves a scheduled job to another compartment.
`create_scheduled_job`(…)	Creates a new scheduled job.
`delete_scheduled_job`(scheduled_job_id, **kwargs)	Deletes the specified scheduled job.
`get_scheduled_job`(scheduled_job_id, **kwargs)	Gets information about the specified scheduled job.
`list_scheduled_jobs`(**kwargs)	Lists scheduled jobs that match the specified compartment or scheduled job `OCID`__.
`run_scheduled_job_now`(scheduled_job_id, **kwargs)	Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly scheduled time.
`update_scheduled_job`(scheduled_job_id, …)	Updates the specified scheduled job’s name, description, and other details, such as next execution and recurrence.

__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.

change_scheduled_job_compartment(scheduled_job_id, change_scheduled_job_compartment_details, **kwargs)¶

Moves a scheduled job to another compartment.

Parameters:	scheduled_job_id (str) – (required) The `OCID`__ of the scheduled job. change_scheduled_job_compartment_details (oci.os_management_hub.models.ChangeScheduledJobCompartmentDetails) – (required) The `OCID`__ of the compartment to move the scheduled job to. 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. 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 None
Return type:	`Response`
Example:

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

create_scheduled_job(create_scheduled_job_details, **kwargs)¶

Creates a new scheduled job.

Parameters:	create_scheduled_job_details (oci.os_management_hub.models.CreateScheduledJobDetails) – (required) Provides the information used to create the scheduled job. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. 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 `ScheduledJob`
Return type:	`Response`
Example:

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

delete_scheduled_job(scheduled_job_id, **kwargs)¶

Deletes the specified scheduled job.

Parameters:	scheduled_job_id (str) – (required) The `OCID`__ of the scheduled job. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 None
Return type:	`Response`
Example:

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

get_scheduled_job(scheduled_job_id, **kwargs)¶

Gets information about the specified scheduled job.

Parameters:	scheduled_job_id (str) – (required) The `OCID`__ of the scheduled job. 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 `ScheduledJob`
Return type:	`Response`
Example:

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

list_scheduled_jobs(**kwargs)¶

Lists scheduled jobs that match the specified compartment or scheduled job `OCID`__.

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. display_name (str) – (optional) A filter to return resources that match the given user-friendly name. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. lifecycle_state (str) – (optional) A filter to return only scheduled jobs currently in the given state. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED” managed_instance_id (str) – (optional) The `OCID`__ of the managed instance. This filter returns resources associated with this managed instance. managed_instance_group_id (str) – (optional) The `OCID`__ of the managed instance group. This filter returns resources associated with this group. managed_compartment_id (str) – (optional) The `OCID`__ of the managed compartment. This filter returns resources associated with this compartment. lifecycle_stage_id (str) – (optional) The `OCID`__ of the lifecycle stage. This resource returns resources associated with this lifecycle stage. operation_type (str) – (optional) A filter to return only scheduled jobs with the given operation type. Allowed values are: “INSTALL_PACKAGES”, “UPDATE_PACKAGES”, “REMOVE_PACKAGES”, “UPDATE_ALL”, “UPDATE_SECURITY”, “UPDATE_BUGFIX”, “UPDATE_ENHANCEMENT”, “UPDATE_OTHER”, “UPDATE_KSPLICE_USERSPACE”, “UPDATE_KSPLICE_KERNEL”, “MANAGE_MODULE_STREAMS”, “SWITCH_MODULE_STREAM”, “ATTACH_SOFTWARE_SOURCES”, “DETACH_SOFTWARE_SOURCES”, “SYNC_MANAGEMENT_STATION_MIRROR”, “PROMOTE_LIFECYCLE”, “INSTALL_WINDOWS_UPDATES”, “INSTALL_ALL_WINDOWS_UPDATES”, “INSTALL_SECURITY_WINDOWS_UPDATES”, “INSTALL_BUGFIX_WINDOWS_UPDATES”, “INSTALL_ENHANCEMENT_WINDOWS_UPDATES”, “INSTALL_OTHER_WINDOWS_UPDATES” schedule_type (str) – (optional) A filter to return only scheduled jobs of the given scheduling type (one-time or recurring). Allowed values are: “ONETIME”, “RECURRING” time_start (datetime) – (optional) A filter to return only resources with a date on or after the given value, in ISO 8601 format. Example: 2017-07-14T02:40:00.000Z time_end (datetime) – (optional) A filter to return only resources with a date on or before the given value, in ISO 8601 format. Example: 2017-07-14T02:40:00.000Z 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 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 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. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName” 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. is_restricted (bool) – (optional) A filter to return only restricted scheduled jobs. id (str) – (optional) The `OCID`__ of the scheduled job. A filter to return the specified job. compartment_id_in_subtree (bool) – (optional) Indicates whether to include subcompartments in the returned results. Default is false. location (list[str]) – (optional) A filter to return only resources whose location matches the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” location_not_equal_to (list[str]) – (optional) A filter to return only resources whose location does not match the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” 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 `ScheduledJobCollection`
Return type:	`Response`
Example:

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

run_scheduled_job_now(scheduled_job_id, **kwargs)¶

Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly scheduled time. This operation only applies to recurring jobs, not one-time scheduled jobs.

Parameters:	scheduled_job_id (str) – (required) The `OCID`__ of the scheduled job. 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. 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 None
Return type:	`Response`
Example:

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

update_scheduled_job(scheduled_job_id, update_scheduled_job_details, **kwargs)¶

Updates the specified scheduled job’s name, description, and other details, such as next execution and recurrence.

Parameters:	scheduled_job_id (str) – (required) The `OCID`__ of the scheduled job. update_scheduled_job_details (oci.os_management_hub.models.UpdateScheduledJobDetails) – (required) Provides the information used to update the job. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. 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 `ScheduledJob`
Return type:	`Response`
Example:

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