OsManagementClient

class oci.os_management.OsManagementClient(config, **kwargs)

API for the OS Management service. Use these API operations for working with Managed instances and Managed instance groups.

Methods

__init__(config, **kwargs) Creates a new service client
add_packages_to_software_source(…) Adds a given list of Software Packages to a specific Software Source.
attach_child_software_source_to_managed_instance(…) Adds a child software source to a managed instance.
attach_managed_instance_to_managed_instance_group(…) Adds a Managed Instance to a Managed Instance Group.
attach_parent_software_source_to_managed_instance(…) Adds a parent software source to a managed instance.
change_managed_instance_group_compartment(…) Moves a resource into a different compartment.
change_scheduled_job_compartment(…) Moves a resource into a different compartment.
change_software_source_compartment(…) Moves a resource into a different compartment.
create_managed_instance_group(…) Creates a new Managed Instance Group on the management system.
create_scheduled_job(…) Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups.
create_software_source(…) Creates a new custom Software Source on the management system.
delete_managed_instance_group(…) Deletes a Managed Instance Group from the management system
delete_scheduled_job(scheduled_job_id, **kwargs) Cancels an existing Scheduled Job on the management system
delete_software_source(software_source_id, …) Deletes a custom Software Source on the management system
detach_child_software_source_from_managed_instance(…) Removes a child software source from a managed instance.
detach_managed_instance_from_managed_instance_group(…) Removes a Managed Instance from a Managed Instance Group.
detach_parent_software_source_from_managed_instance(…) Removes a software source from a managed instance.
get_erratum(erratum_id, **kwargs) Returns a specific erratum.
get_managed_instance(managed_instance_id, …) Returns a specific Managed Instance.
get_managed_instance_group(…) Returns a specific Managed Instance Group.
get_scheduled_job(scheduled_job_id, **kwargs) Gets the detailed information for the Scheduled Job with the given ID.
get_software_package(software_source_id, …) Returns a specific Software Package.
get_software_source(software_source_id, **kwargs) Returns a specific Software Source.
get_windows_update(windows_update, **kwargs) Returns a Windows Update object.
get_work_request(work_request_id, **kwargs) Gets the detailed information for the work request with the given ID.
install_all_package_updates_on_managed_instance(…) Install all of the available package updates for the managed instance.
install_all_windows_updates_on_managed_instance(…) Install all of the available Windows updates for the managed instance.
install_package_on_managed_instance(…) Installs a package on a managed instance.
install_package_update_on_managed_instance(…) Updates a package on a managed instance.
install_windows_update_on_managed_instance(…) Installs a Windows update on a managed instance.
list_available_packages_for_managed_instance(…) Returns a list of packages available for install on the Managed Instance.
list_available_software_sources_for_managed_instance(…) Returns a list of available software sources for a Managed Instance.
list_available_updates_for_managed_instance(…) Returns a list of available updates for a Managed Instance.
list_available_windows_updates_for_managed_instance(…) Returns a list of available Windows updates for a Managed Instance.
list_managed_instance_groups(compartment_id, …) Returns a list of all Managed Instance Groups.
list_managed_instances(compartment_id, **kwargs) Returns a list of all Managed Instances.
list_packages_installed_on_managed_instance(…) Returns a list of installed packages on the Managed Instance.
list_scheduled_jobs(compartment_id, **kwargs) Returns a list of all of the currently active Scheduled Jobs in the system
list_software_source_packages(…) Lists Software Packages in a Software Source
list_software_sources(compartment_id, **kwargs) Returns a list of all Software Sources.
list_upcoming_scheduled_jobs(compartment_id, …) Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
list_windows_updates(**kwargs) Returns a list of Windows Updates.
list_windows_updates_installed_on_managed_instance(…) Returns a list of installed Windows updates for a Managed Instance.
list_work_request_errors(work_request_id, …) Gets the errors for the work request with the given ID.
list_work_request_logs(work_request_id, **kwargs) Lists the log entries for the work request with the given ID.
list_work_requests(compartment_id, **kwargs) Lists the work requests in a compartment.
remove_package_from_managed_instance(…) Removes an installed package from a managed instance.
remove_packages_from_software_source(…) Removes a given list of Software Packages from a specific Software Source.
run_scheduled_job_now(scheduled_job_id, **kwargs) This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
search_software_packages(**kwargs) Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
skip_next_scheduled_job_execution(…) This will force an already created Scheduled Job to skip its
update_managed_instance_group(…) Updates a specific Managed Instance Group.
update_scheduled_job(scheduled_job_id, …) Updates an existing Scheduled Job on the management system.
update_software_source(software_source_id, …) Updates an existing custom Software Source on the management system.
__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.

add_packages_to_software_source(software_source_id, add_packages_to_software_source_details, **kwargs)

Adds a given list of Software Packages to a specific Software Source.

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • add_packages_to_software_source_details (AddPackagesToSoftwareSourceDetails) – (required) A list of package identifiers
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

attach_child_software_source_to_managed_instance(managed_instance_id, attach_child_software_source_to_managed_instance_details, **kwargs)

Adds a child software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • attach_child_software_source_to_managed_instance_details (AttachChildSoftwareSourceToManagedInstanceDetails) – (required) Details for attaching a Software Source to a Managed Instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

attach_managed_instance_to_managed_instance_group(managed_instance_group_id, managed_instance_id, **kwargs)

Adds a Managed Instance to a Managed Instance Group. After the Managed Instance has been added, then operations can be performed on the Managed Instance Group which will then apply to all Managed Instances in the group.

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • managed_instance_id (str) – (required) OCID for the managed instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

attach_parent_software_source_to_managed_instance(managed_instance_id, attach_parent_software_source_to_managed_instance_details, **kwargs)

Adds a parent software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance. Software sources that have this software source as a parent will be able to be added to this managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • attach_parent_software_source_to_managed_instance_details (AttachParentSoftwareSourceToManagedInstanceDetails) – (required) Details for attaching a Software Source to a Managed Instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

change_managed_instance_group_compartment(managed_instance_group_id, change_managed_instance_group_compartment_details, **kwargs)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • change_managed_instance_group_compartment_details (ChangeManagedInstanceGroupCompartmentDetails) – (required) OCID for the compartment to which the resource will be moved.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

change_scheduled_job_compartment(scheduled_job_id, change_scheduled_job_compartment_details, **kwargs)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • change_scheduled_job_compartment_details (ChangeScheduledJobCompartmentDetails) – (required) OCID for the compartment to which the resource will be moved.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

change_software_source_compartment(software_source_id, change_software_source_compartment_details, **kwargs)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • change_software_source_compartment_details (ChangeSoftwareSourceCompartmentDetails) – (required) OCID for the compartment to which the resource will be moved.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

create_managed_instance_group(create_managed_instance_group_details, **kwargs)

Creates a new Managed Instance Group on the management system. This will not contain any managed instances after it is first created, and they must be added later.

Parameters:
  • create_managed_instance_group_details (CreateManagedInstanceGroupDetails) – (required) Details about a Managed Instance Group to create
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ManagedInstanceGroup

Return type:

Response

create_scheduled_job(create_scheduled_job_details, **kwargs)

Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups. Can be created as a one-time execution in the future, or as a recurring execution that repeats on a defined interval.

Parameters:
  • create_scheduled_job_details (CreateScheduledJobDetails) – (required) Details about a Scheduled Job to create
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ScheduledJob

Return type:

Response

create_software_source(create_software_source_details, **kwargs)

Creates a new custom Software Source on the management system. This will not contain any packages after it is first created, and they must be added later.

Parameters:
  • create_software_source_details (CreateSoftwareSourceDetails) – (required) Details about a Sofware Source to create
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type SoftwareSource

Return type:

Response

delete_managed_instance_group(managed_instance_group_id, **kwargs)

Deletes a Managed Instance Group from the management system

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

delete_scheduled_job(scheduled_job_id, **kwargs)

Cancels an existing Scheduled Job on the management system

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

delete_software_source(software_source_id, **kwargs)

Deletes a custom Software Source on the management system

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

detach_child_software_source_from_managed_instance(managed_instance_id, detach_child_software_source_from_managed_instance_details, **kwargs)

Removes a child software source from a managed instance. Packages will no longer be able to be installed from these software sources.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • detach_child_software_source_from_managed_instance_details (DetachChildSoftwareSourceFromManagedInstanceDetails) – (required) Details for detaching a Software Source from a Managed Instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

detach_managed_instance_from_managed_instance_group(managed_instance_group_id, managed_instance_id, **kwargs)

Removes a Managed Instance from a Managed Instance Group.

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • managed_instance_id (str) – (required) OCID for the managed instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

detach_parent_software_source_from_managed_instance(managed_instance_id, detach_parent_software_source_from_managed_instance_details, **kwargs)

Removes a software source from a managed instance. All child software sources will also be removed from the managed instance. Packages will no longer be able to be installed from these software sources.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • detach_parent_software_source_from_managed_instance_details (DetachParentSoftwareSourceFromManagedInstanceDetails) – (required) Details for detaching a Software Source from a Managed Instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

get_erratum(erratum_id, **kwargs)

Returns a specific erratum.

Parameters:
  • erratum_id (str) – (required) The OCID of the erratum.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type Erratum

Return type:

Response

get_managed_instance(managed_instance_id, **kwargs)

Returns a specific Managed Instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ManagedInstance

Return type:

Response

get_managed_instance_group(managed_instance_group_id, **kwargs)

Returns a specific Managed Instance Group.

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ManagedInstanceGroup

Return type:

Response

get_scheduled_job(scheduled_job_id, **kwargs)

Gets the detailed information for the Scheduled Job with the given ID.

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ScheduledJob

Return type:

Response

get_software_package(software_source_id, software_package_name, **kwargs)

Returns a specific Software Package.

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • software_package_name (str) – (required) The id of the software package.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type SoftwarePackage

Return type:

Response

get_software_source(software_source_id, **kwargs)

Returns a specific Software Source.

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type SoftwareSource

Return type:

Response

get_windows_update(windows_update, **kwargs)

Returns a Windows Update object.

Parameters:
  • windows_update (str) – (required) The Windows Update
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WindowsUpdate

Return type:

Response

get_work_request(work_request_id, **kwargs)

Gets the detailed information for the work request with the given ID.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type WorkRequest

Return type:

Response

install_all_package_updates_on_managed_instance(managed_instance_id, **kwargs)

Install all of the available package updates for the managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

install_all_windows_updates_on_managed_instance(managed_instance_id, **kwargs)

Install all of the available Windows updates for the managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

install_package_on_managed_instance(managed_instance_id, software_package_name, **kwargs)

Installs a package on a managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • software_package_name (str) – (required) Package name
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

install_package_update_on_managed_instance(managed_instance_id, software_package_name, **kwargs)

Updates a package on a managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • software_package_name (str) – (required) Package name
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

install_windows_update_on_managed_instance(managed_instance_id, windows_update_name, **kwargs)

Installs a Windows update on a managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • windows_update_name (str) – (required) Unique identifier for the Windows update. NOTE - This is not an OCID, but is a unique identifier assigned by Microsoft. Example: 6981d463-cd91-4a26-b7c4-ea4ded9183ed
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

list_available_packages_for_managed_instance(managed_instance_id, **kwargs)

Returns a list of packages available for install on the Managed Instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of InstallablePackageSummary

Return type:

Response

list_available_software_sources_for_managed_instance(managed_instance_id, **kwargs)

Returns a list of available software sources for a Managed Instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of AvailableSoftwareSourceSummary

Return type:

Response

list_available_updates_for_managed_instance(managed_instance_id, **kwargs)

Returns a list of available updates for a Managed Instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of AvailableUpdateSummary

Return type:

Response

list_available_windows_updates_for_managed_instance(managed_instance_id, **kwargs)

Returns a list of available Windows updates for a Managed Instance. This is only applicable to Windows instances.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • is_eligible_for_installation (str) –

    (optional) Indicator of whether the update can be installed using OSMS.

    Allowed values are: “INSTALLABLE”, “NOT_INSTALLABLE”, “UNKNOWN”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of AvailableWindowsUpdateSummary

Return type:

Response

list_managed_instance_groups(compartment_id, **kwargs)

Returns a list of all Managed Instance Groups.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • lifecycle_state (str) –

    (optional) The current lifecycle state for the object.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • os_family (str) –

    (optional) The OS family for which to list resources.

    Allowed values are: “LINUX”, “WINDOWS”, “ALL”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of ManagedInstanceGroupSummary

Return type:

Response

list_managed_instances(compartment_id, **kwargs)

Returns a list of all Managed Instances.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (str) –

    (optional) The OS family for which to list resources.

    Allowed values are: “LINUX”, “WINDOWS”, “ALL”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of ManagedInstanceSummary

Return type:

Response

list_packages_installed_on_managed_instance(managed_instance_id, **kwargs)

Returns a list of installed packages on the Managed Instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of InstalledPackageSummary

Return type:

Response

list_scheduled_jobs(compartment_id, **kwargs)

Returns a list of all of the currently active Scheduled Jobs in the system

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • managed_instance_id (str) – (optional) The ID of the managed instance for which to list resources.
  • managed_instance_group_id (str) – (optional) The ID of the managed instace group for which to list resources.
  • operation_type (str) –

    (optional) The operation type for which to list resources

    Allowed values are: “INSTALL”, “UPDATE”, “REMOVE”, “UPDATEALL”

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • lifecycle_state (str) –

    (optional) The current lifecycle state for the object.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (str) –

    (optional) The OS family for which to list resources.

    Allowed values are: “LINUX”, “WINDOWS”, “ALL”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of ScheduledJobSummary

Return type:

Response

list_software_source_packages(software_source_id, **kwargs)

Lists Software Packages in a Software Source

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of SoftwarePackageSummary

Return type:

Response

list_software_sources(compartment_id, **kwargs)

Returns a list of all Software Sources.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • lifecycle_state (str) –

    (optional) The current lifecycle state for the object.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of SoftwareSourceSummary

Return type:

Response

list_upcoming_scheduled_jobs(compartment_id, time_end, **kwargs)

Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • time_end (datetime) –

    (required) The cut-off time before which to list all upcoming schedules, in ISO 8601 format

    Example: 2017-07-14T02:40:00.000Z

  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • tag_name (str) – (optional) The name of the tag.
  • tag_value (str) – (optional) The value for the tag.
  • lifecycle_state (str) –

    (optional) The current lifecycle state for the object.

    Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (str) –

    (optional) The OS family for which to list resources.

    Allowed values are: “LINUX”, “WINDOWS”, “ALL”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of ScheduledJobSummary

Return type:

Response

list_windows_updates(**kwargs)

Returns a list of Windows Updates.

Parameters:
  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WindowsUpdateSummary

Return type:

Response

list_windows_updates_installed_on_managed_instance(managed_instance_id, **kwargs)

Returns a list of installed Windows updates for a Managed Instance. This is only applicable to Windows instances.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of InstalledWindowsUpdateSummary

Return type:

Response

list_work_request_errors(work_request_id, **kwargs)

Gets the errors for the work request with the given ID.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

list_work_request_logs(work_request_id, **kwargs)

Lists the log entries for the work request with the given ID.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestLogEntry

Return type:

Response

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • managed_instance_id (str) – (optional) The ID of the managed instance for which to list resources.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • os_family (str) –

    (optional) The OS family for which to list resources.

    Allowed values are: “LINUX”, “WINDOWS”, “ALL”

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of WorkRequestSummary

Return type:

Response

remove_package_from_managed_instance(managed_instance_id, software_package_name, **kwargs)

Removes an installed package from a managed instance.

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • software_package_name (str) – (required) Package name
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

remove_packages_from_software_source(software_source_id, remove_packages_from_software_source_details, **kwargs)

Removes a given list of Software Packages from a specific Software Source.

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • remove_packages_from_software_source_details (RemovePackagesFromSoftwareSourceDetails) – (required) A list of package identifiers
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

run_scheduled_job_now(scheduled_job_id, **kwargs)

This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

search_software_packages(**kwargs)

Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.

Parameters:
  • software_package_name (str) – (optional) the identifier for the software package (not an OCID)
  • display_name (str) –

    (optional) A user-friendly name. Does not have to be unique, and it’s changeable.

    Example: My new resource

  • cve_name (str) – (optional) The name of the CVE as published. Example: CVE-2006-4535
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • 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. If no value is specified TIMECREATED is default.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type list of SoftwarePackageSearchSummary

Return type:

Response

skip_next_scheduled_job_execution(scheduled_job_id, **kwargs)

This will force an already created Scheduled Job to skip its next regularly scheduled execution

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type None

Return type:

Response

update_managed_instance_group(managed_instance_group_id, update_managed_instance_group_details, **kwargs)

Updates a specific Managed Instance Group.

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • update_managed_instance_group_details (UpdateManagedInstanceGroupDetails) – (required) Details about a Managed Instance Group to update
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ManagedInstanceGroup

Return type:

Response

update_scheduled_job(scheduled_job_id, update_scheduled_job_details, **kwargs)

Updates an existing Scheduled Job on the management system.

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • update_scheduled_job_details (UpdateScheduledJobDetails) – (required) Details about a Scheduled Job to update
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type ScheduledJob

Return type:

Response

update_software_source(software_source_id, update_software_source_details, **kwargs)

Updates an existing custom Software Source on the management system.

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • update_software_source_details (UpdateSoftwareSourceDetails) – (required) Details about a Sofware Source to update
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • 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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

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

Returns:

A Response object with data of type SoftwareSource

Return type:

Response