SoftwareSourceClient

class oci.os_management_hub.SoftwareSourceClient(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
add_packages_to_software_source(…) Adds packages to a software source.
change_availability_of_software_sources(…) Updates the availability for a list of specified software sources.
change_software_source_compartment(…) Moves the specified software sources to a different compartment within the same tenancy.
create_entitlement(…) Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.
create_software_source(…) Creates a new versioned or custom software source.
delete_software_source(software_source_id, …) Deletes the specified software source.
get_erratum(compartment_id, name, **kwargs) Returns information about the specified erratum based on its advisory name.
get_module_stream(software_source_id, …) Returns information about the specified module stream in a software source.
get_module_stream_profile(…) Returns information about the specified module stream profile in a software source.
get_package_group(software_source_id, …) Returns information about the specified package group from a software source.
get_software_package(software_source_id, …) Returns information about the specified software package.
get_software_package_by_name(…) Returns information about the specified software package based on its fully qualified name.
get_software_source(software_source_id, **kwargs) Returns information about the specified software source.
list_all_software_packages(**kwargs) Lists software packages available through the OS Management Hub service.
list_entitlements(compartment_id, **kwargs) Lists entitlements in the specified tenancy `OCID`__.
list_errata(compartment_id, **kwargs) Lists all of the currently available errata.
list_module_stream_profiles(…) Lists module stream profiles from the specified software source `OCID`__.
list_module_streams(software_source_id, **kwargs) Lists module streams from the specified software source `OCID`__.
list_package_groups(software_source_id, **kwargs) Lists package groups that are associated with the specified software source `OCID`__.
list_software_package_software_sources(…) Lists the software sources in the tenancy that contain the software package.
list_software_packages(software_source_id, …) Lists software packages in the specified software source.
list_software_source_vendors(compartment_id, …) Lists available software source vendors.
list_software_sources(**kwargs) Lists software sources that match the specified tenancy or software source `OCID`__.
search_software_source_module_streams(…) Returns a list of module streams from the specified software sources.
search_software_source_modules(…) Lists modules from a list of software sources.
search_software_source_package_groups(…) Searches the package groups from the specified list of software sources.
update_software_source(software_source_id, …) Updates the specified software source’s details, including but not limited to name, description, and tags.
__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.
add_packages_to_software_source(software_source_id, add_packages_to_software_source_details, **kwargs)

Adds packages to a software source. This operation can only be done for custom and versioned custom software sources that are not created using filters. For a versioned custom software source, you can only add packages when the source is created. Once content is added to a versioned custom software source, it is immutable.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • add_packages_to_software_source_details (oci.os_management_hub.models.AddPackagesToSoftwareSourceDetails) – (required) A list of packages to be added to the software source.
  • 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 add_packages_to_software_source API.

change_availability_of_software_sources(change_availability_of_software_sources_details, **kwargs)

Updates the availability for a list of specified software sources.

Parameters:
  • change_availability_of_software_sources_details (oci.os_management_hub.models.ChangeAvailabilityOfSoftwareSourcesDetails) – (required) Request body that contains a list of software sources whose availability needs to be updated.
  • 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.
  • 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_availability_of_software_sources API.

change_software_source_compartment(software_source_id, change_software_source_compartment_details, **kwargs)

Moves the specified software sources to a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • change_software_source_compartment_details (oci.os_management_hub.models.ChangeSoftwareSourceCompartmentDetails) –

    (required) The `OCID`__ for the compartment to move the software source 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_software_source_compartment API.

create_entitlement(create_entitlement_details, **kwargs)

Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.

Parameters:
  • create_entitlement_details (oci.os_management_hub.models.CreateEntitlementDetails) – (required) Details for creating entitlements.
  • 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.
  • 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 create_entitlement API.

create_software_source(create_software_source_details, **kwargs)

Creates a new versioned or custom software source.

Parameters:
  • create_software_source_details (oci.os_management_hub.models.CreateSoftwareSourceDetails) – (required) Details for the new software source.
  • 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.
  • 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 SoftwareSource

Return type:

Response

Example:

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

delete_software_source(software_source_id, **kwargs)

Deletes the specified software source.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • 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.
  • 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_software_source API.

get_erratum(compartment_id, name, **kwargs)

Returns information about the specified erratum based on its advisory name.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment. This parameter is required and returns only resources contained within the specified compartment.

  • name (str) – (required) The erratum name (such as ELSA-2023-34678).
  • 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 Erratum

Return type:

Response

Example:

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

get_module_stream(software_source_id, module_name, stream_name, **kwargs)

Returns information about the specified module stream in a software source.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • module_name (str) – (required) The name of the module.
  • stream_name (str) – (required) The name of the stream of the containing module.
  • 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 ModuleStream

Return type:

Response

Example:

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

get_module_stream_profile(software_source_id, profile_name, module_name, stream_name, **kwargs)

Returns information about the specified module stream profile in a software source.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • profile_name (str) – (required) The name of the module stream profile.
  • module_name (str) – (required) The name of a module.
  • stream_name (str) – (required) The name of the stream of the containing module.
  • 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 ModuleStreamProfile

Return type:

Response

Example:

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

get_package_group(software_source_id, package_group_id, **kwargs)

Returns information about the specified package group from a software source.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • package_group_id (str) – (required) The unique package group identifier.
  • 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 PackageGroup

Return type:

Response

Example:

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

get_software_package(software_source_id, software_package_name, **kwargs)

Returns information about the specified software package.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • software_package_name (str) – (required) The name of the software package.
  • 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 SoftwarePackage

Return type:

Response

Example:

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

get_software_package_by_name(software_package_name, **kwargs)

Returns information about the specified software package based on its fully qualified name.

Parameters:
  • software_package_name (str) – (required) The name of the software package.
  • 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 SoftwarePackage

Return type:

Response

Example:

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

get_software_source(software_source_id, **kwargs)

Returns information about the specified software source.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • 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 SoftwareSource

Return type:

Response

Example:

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

list_all_software_packages(**kwargs)

Lists software packages available through the OS Management Hub service. Filter the list against a variety of criteria including but not limited to its name.

Parameters:
  • 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.
  • version (str) – (optional) A filter to return software packages that match the given version.
  • architecture (str) –

    (optional) A filter to return software packages that match the given architecture.

    Allowed values are: “I386”, “I686”, “AARCH64”, “X86_64”, “SRC”, “NOARCH”, “OTHER”

  • is_latest (bool) – (optional) Indicates whether to list only the latest versions of packages, module streams, and stream profiles.
  • os_family (str) –

    (optional) A filter to return only resources that match the given operating system family.

    Allowed values are: “ORACLE_LINUX_9”, “ORACLE_LINUX_8”, “ORACLE_LINUX_7”, “ORACLE_LINUX_6”, “WINDOWS_SERVER_2016”, “WINDOWS_SERVER_2019”, “WINDOWS_SERVER_2022”, “ALL”

  • 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 packages by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Allowed values are: “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.
  • 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 SoftwarePackageCollection

Return type:

Response

Example:

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

list_entitlements(compartment_id, **kwargs)

Lists entitlements in the specified tenancy `OCID`__. Filter the list against a variety of criteria including but not limited to its Customer Support Identifier (CSI), and vendor name.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment. This parameter is required and returns only resources contained within the specified compartment.

  • csi (str) – (optional) A filter to return entitlements that match the given CSI.
  • vendor_name (str) –

    (optional) A filter to return only resources that match the given vendor name.

    Allowed values are: “ORACLE”, “MICROSOFT”

  • 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 entitlements by. Only one sort order may be provided.

    Allowed values are: “csi”, “vendorName”

  • 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 EntitlementCollection

Return type:

Response

Example:

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

list_errata(compartment_id, **kwargs)

Lists all of the currently available errata. Filter the list against a variety of criteria including but not limited to its name, classification type, advisory severity, and OS family.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment. This parameter is required and returns only resources contained within the specified compartment.

  • name (list[str]) –

    (optional) The assigned erratum name. It’s unique and not changeable.

    Example: ELSA-2020-5804

  • name_contains (str) – (optional) A filter to return resources that may partially match the erratum name given.
  • classification_type (list[str]) –

    (optional) A filter to return only packages that match the given update classification type.

    Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”

  • advisory_type (list[str]) –

    (optional) A filter to return only errata that match the given advisory types.

    Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”

  • os_family (str) –

    (optional) A filter to return only resources that match the given operating system family.

    Allowed values are: “ORACLE_LINUX_9”, “ORACLE_LINUX_8”, “ORACLE_LINUX_7”, “ORACLE_LINUX_6”, “WINDOWS_SERVER_2016”, “WINDOWS_SERVER_2019”, “WINDOWS_SERVER_2022”, “ALL”

  • advisory_severity (list[str]) –

    (optional) The advisory severity.

    Allowed values are: “LOW”, “MODERATE”, “IMPORTANT”, “CRITICAL”

  • time_issue_date_start (datetime) –

    (optional) The issue date after which to list all errata, in ISO 8601 format

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

  • time_issue_date_end (datetime) –

    (optional) The issue date before which to list all errata, 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 errata by. Only one sort order may be provided. Default order for timeIssued is descending. Default order for name is ascending. If no value is specified timeIssued is default.

    Allowed values are: “timeIssued”, “name”

  • 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 ErratumCollection

Return type:

Response

Example:

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

list_module_stream_profiles(software_source_id, **kwargs)

Lists module stream profiles from the specified software source `OCID`__. Filter the list against a variety of criteria including but not limited to its module name, stream name, and profile name.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • module_name (str) – (optional) The name of a module. This parameter is required if a streamName is specified.
  • stream_name (str) – (optional) The name of the module stream. This parameter is required if a profile name is specified.
  • name (str) – (optional) The name of the entity to be queried.
  • 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 moduleName is ascending.

    Allowed values are: “moduleName”

  • 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 ModuleStreamProfileCollection

Return type:

Response

Example:

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

list_module_streams(software_source_id, **kwargs)

Lists module streams from the specified software source `OCID`__. Filter the list against a variety of criteria including but not limited to its module name and (stream) name.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • module_name (str) – (optional) The name of a module. This parameter is required if a streamName is specified.
  • name (str) – (optional) The name of the entity to be queried.
  • is_latest (bool) – (optional) Indicates whether to list only the latest versions of packages, module streams, and stream profiles.
  • 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 moduleName is ascending.

    Allowed values are: “moduleName”

  • module_name_contains (str) – (optional) A filter to return resources that may partially match the module name given.
  • 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 ModuleStreamCollection

Return type:

Response

Example:

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

list_package_groups(software_source_id, **kwargs)

Lists package groups that are associated with the specified software source `OCID`__. Filter the list against a variety of criteria including but not limited to its name, and package group type.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • 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.
  • name (str) – (optional) The name of the entity to be queried.
  • name_contains (str) – (optional) A filter to return resources that may partially match the name given.
  • group_type (list[PackageGroupGroupType]) – (optional) A filter to return only package groups of the specified type.
  • 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.
  • 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 PackageGroupCollection

Return type:

Response

Example:

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

list_software_package_software_sources(software_package_name, compartment_id, **kwargs)

Lists the software sources in the tenancy that contain the software package. Filter the list against a variety of criteria including but not limited to its name, type, architecture, and OS family.

Parameters:
  • software_package_name (str) – (required) The name of the software package.
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment. This parameter is required and returns only resources contained within the specified compartment.

  • software_source_type (list[str]) –

    (optional) The type of the software source.

    Allowed values are: “VENDOR”, “CUSTOM”, “VERSIONED”

  • os_family (list[str]) –

    (optional) A filter to return only resources that match the given operating system family.

    Allowed values are: “ORACLE_LINUX_9”, “ORACLE_LINUX_8”, “ORACLE_LINUX_7”, “ORACLE_LINUX_6”, “WINDOWS_SERVER_2016”, “WINDOWS_SERVER_2019”, “WINDOWS_SERVER_2022”, “ALL”

  • arch_type (list[str]) –

    (optional) A filter to return only instances whose architecture type matches the given architecture.

    Allowed values are: “X86_64”, “AARCH64”, “I686”, “NOARCH”, “SRC”

  • availability (list[str]) –

    (optional) The availabilities of the software source in a non-OCI environment for a tenancy.

    Allowed values are: “AVAILABLE”, “SELECTED”, “RESTRICTED”, “UNAVAILABLE”

  • availability_at_oci (list[str]) –

    (optional) The availabilities of the software source in an OCI environment for a tenancy.

    Allowed values are: “AVAILABLE”, “SELECTED”, “RESTRICTED”, “UNAVAILABLE”

  • availability_anywhere (list[str]) –

    (optional) The availabilities of the software source. Use this query parameter to filter across availabilities in different environments.

    Allowed values are: “AVAILABLE”, “SELECTED”, “RESTRICTED”, “UNAVAILABLE”

  • 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.
  • 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”

  • lifecycle_state (list[SoftwareSourceLifecycleState]) – (optional) A filter to return only software sources whose state matches the given state.
  • 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 SoftwareSourceCollection

Return type:

Response

Example:

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

list_software_packages(software_source_id, **kwargs)

Lists software packages in the specified software source. Filter the list against a variety of criteria including but not limited to its name.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • 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.
  • is_latest (bool) – (optional) Indicates whether to list only the latest versions of packages, module streams, and stream profiles.
  • 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.
  • 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 SoftwarePackageCollection

Return type:

Response

Example:

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

list_software_source_vendors(compartment_id, **kwargs)

Lists available software source vendors. Filter the list against a variety of criteria including but not limited to its name.

Parameters:
  • compartment_id (str) –

    (required) The `OCID`__ of the compartment. This parameter is required and returns only resources contained within the specified compartment.

  • 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.
  • 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 software source vendors by. Only one sort order may be provided. Default order for name is ascending.

    Allowed values are: “name”

  • name (str) – (optional) The name of the entity to be queried.
  • 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 SoftwareSourceVendorCollection

Return type:

Response

Example:

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

list_software_sources(**kwargs)

Lists software sources that match the specified tenancy or software source `OCID`__. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

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.
  • software_source_id (str) –

    (optional) The `OCID`__ for the software source.

  • software_source_type (list[str]) –

    (optional) The type of the software source.

    Allowed values are: “VENDOR”, “CUSTOM”, “VERSIONED”

  • vendor_name (str) –

    (optional) A filter to return only resources that match the given vendor name.

    Allowed values are: “ORACLE”, “MICROSOFT”

  • os_family (list[str]) –

    (optional) A filter to return only resources that match the given operating system family.

    Allowed values are: “ORACLE_LINUX_9”, “ORACLE_LINUX_8”, “ORACLE_LINUX_7”, “ORACLE_LINUX_6”, “WINDOWS_SERVER_2016”, “WINDOWS_SERVER_2019”, “WINDOWS_SERVER_2022”, “ALL”

  • arch_type (list[str]) –

    (optional) A filter to return only instances whose architecture type matches the given architecture.

    Allowed values are: “X86_64”, “AARCH64”, “I686”, “NOARCH”, “SRC”

  • availability (list[str]) –

    (optional) The availabilities of the software source in a non-OCI environment for a tenancy.

    Allowed values are: “AVAILABLE”, “SELECTED”, “RESTRICTED”, “UNAVAILABLE”

  • availability_at_oci (list[str]) –

    (optional) The availabilities of the software source in an OCI environment for a tenancy.

    Allowed values are: “AVAILABLE”, “SELECTED”, “RESTRICTED”, “UNAVAILABLE”

  • availability_anywhere (list[str]) –

    (optional) The availabilities of the software source. Use this query parameter to filter across availabilities in different environments.

    Allowed values are: “AVAILABLE”, “SELECTED”, “RESTRICTED”, “UNAVAILABLE”

  • is_mandatory_for_autonomous_linux (bool) – (optional) Indicates whether the software source is mandatory for the Autonomous Linux service.
  • 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.
  • display_name_not_equal_to (list[str]) – (optional) A multi filter to return resources that do not contains the given display names.
  • 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”

  • lifecycle_state (list[SoftwareSourceLifecycleState]) – (optional) A filter to return only software sources whose state matches the given state.
  • 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 SoftwareSourceCollection

Return type:

Response

Example:

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

search_software_source_module_streams(search_software_source_module_streams_details, **kwargs)

Returns a list of module streams from the specified software sources. Filter the list against a variety of criteria including the module name.

Parameters:
  • search_software_source_module_streams_details (oci.os_management_hub.models.SearchSoftwareSourceModuleStreamsDetails) – (required) Request body that takes a list of software sources and any search filters.
  • 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.
  • 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

  • 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 ModuleStreamCollection

Return type:

Response

Example:

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

search_software_source_modules(search_software_source_modules_details, **kwargs)

Lists modules from a list of software sources. Filter the list against a variety of criteria including the module name.

Parameters:
  • search_software_source_modules_details (oci.os_management_hub.models.SearchSoftwareSourceModulesDetails) – (required) Request body that takes a list of software sources and any search filters.
  • 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.
  • 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

  • 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 ModuleCollection

Return type:

Response

Example:

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

search_software_source_package_groups(search_software_source_package_groups_details, **kwargs)

Searches the package groups from the specified list of software sources. Filter the list against a variety of criteria including but not limited to its name, and group type.

Parameters:
  • search_software_source_package_groups_details (oci.os_management_hub.models.SearchSoftwareSourcePackageGroupsDetails) – (required) Request body that takes in a list of software sources and other search parameters.
  • 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.
  • 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

  • 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 PackageGroupCollection

Return type:

Response

Example:

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

update_software_source(software_source_id, update_software_source_details, **kwargs)

Updates the specified software source’s details, including but not limited to name, description, and tags.

Parameters:
  • software_source_id (str) –

    (required) The `OCID`__ of the software source.

  • update_software_source_details (oci.os_management_hub.models.UpdateSoftwareSourceDetails) – (required) The information to be updated.
  • 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.
  • 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 SoftwareSource

Return type:

Response

Example:

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