OS Management Hub Software Source Functions

Package: DBMS_CLOUD_OCI_OMH_SOFTWARE_SOURCE

CHANGE_AVAILABILITY_OF_SOFTWARE_SOURCES Function

Updates the availability for a list of specified software sources.

Syntax

FUNCTION change_availability_of_software_sources (
  change_availability_of_software_sources_details dbms_cloud_oci_os_management_hub_change_availability_of_software_sources_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_change_availability_of_software_sources_response_t;

Parameters

Parameter	Description
`change_availability_of_software_sources_details`	(required) Request body that contains a list of software sources whose availability needs to be updated.
`opc_request_id`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ENTITLEMENT Function

Registers the necessary entitlement credentials for OS vendor software sources.

Syntax

FUNCTION create_entitlement (
  create_entitlement_details dbms_cloud_oci_os_management_hub_create_entitlement_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_create_entitlement_response_t;

Parameters

Parameter	Description
`create_entitlement_details`	(required) Details for creating entitlements.
`opc_request_id`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SOFTWARE_SOURCE Function

Creates a new versioned or custom software source.

Syntax

FUNCTION create_software_source (
  create_software_source_details dbms_cloud_oci_os_management_hub_create_software_source_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_create_software_source_response_t;

Parameters

Parameter	Description
`create_software_source_details`	(required) Details for the new software source.
`opc_request_id`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SOFTWARE_SOURCE Function

Deletes the specified software source.

Syntax

FUNCTION delete_software_source (
  software_source_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_delete_software_source_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`opc_request_id`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ERRATUM Function

Gets information about the specified erratum by its advisory name.

Syntax

FUNCTION get_erratum (
  compartment_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_get_erratum_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment that contains the resources to list. This parameter is required.
`name`	(required) The erratum name (e.g. ELSA-2023-34678).
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODULE_STREAM Function

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

Syntax

FUNCTION get_module_stream (
  software_source_id varchar2,
  module_name varchar2,
  stream_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_get_module_stream_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`module_name`	(required) The name of the module.
`stream_name`	(required) The name of the stream of the containing module.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODULE_STREAM_PROFILE Function

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

Syntax

FUNCTION get_module_stream_profile (
  software_source_id varchar2,
  profile_name varchar2,
  module_name varchar2,
  stream_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_get_module_stream_profile_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`profile_name`	(required) The name of the profile of the containing module stream.
`module_name`	(required) The name of a module.
`stream_name`	(required) The name of the stream of the containing module.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PACKAGE_GROUP Function

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

Syntax

FUNCTION get_package_group (
  software_source_id varchar2,
  package_group_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_get_package_group_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`package_group_id`	(required) The unique package group identifier.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SOFTWARE_PACKAGE Function

Gets information about the specified software package.

Syntax

FUNCTION get_software_package (
  software_source_id varchar2,
  software_package_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_get_software_package_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`software_package_name`	(required) The name of the software package.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SOFTWARE_SOURCE Function

Gets information about the specified software source.

Syntax

FUNCTION get_software_source (
  software_source_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_get_software_source_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ENTITLEMENTS Function

Lists entitlements in the specified tenancy OCID. Filter the list against a variety of criteria including but not limited to its CSI, and vendor name.

Syntax

FUNCTION list_entitlements (
  compartment_id varchar2,
  csi varchar2 DEFAULT NULL,
  vendor_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_entitlements_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment that contains the resources to list. This parameter is required.
`csi`	(optional) A filter to return entitlements that match the given CSI.
`vendor_name`	(optional) A filter to return only profiles that match the given vendorName. Allowed values are: 'ORACLE'
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort entitlements by. Only one sort order may be provided. Allowed values are: 'csi', 'vendorName'
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ERRATA Function

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.

Syntax

FUNCTION list_errata (
  compartment_id varchar2,
  name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  classification_type dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  os_family varchar2 DEFAULT NULL,
  advisory_severity dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  time_issue_date_start timestamp with time zone DEFAULT NULL,
  time_issue_date_end timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_errata_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment that contains the resources to list. This parameter is required.
`name`	(optional) The assigned erratum name. It's unique and not changeable. Example: `ELSA-2020-5804`
`name_contains`	(optional) A filter to return resources that may partially match the erratum name given.
`classification_type`	(optional) A filter to return only packages that match the given update classification type. Allowed values are: 'SECURITY', 'BUGFIX', 'ENHANCEMENT', 'OTHER'
`os_family`	(optional) A filter to return only profiles that match the given osFamily. Allowed values are: 'ORACLE_LINUX_9', 'ORACLE_LINUX_8', 'ORACLE_LINUX_7'
`advisory_severity`	(optional) The advisory severity. Allowed values are: 'LOW', 'MODERATE', 'IMPORTANT', 'CRITICAL'
`time_issue_date_start`	(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`	(optional) The issue date before which to list all errata, in ISO 8601 format Example: 2017-07-14T02:40:00.000Z
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODULE_STREAM_PROFILES Function

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.

Syntax

FUNCTION list_module_stream_profiles (
  software_source_id varchar2,
  module_name varchar2 DEFAULT NULL,
  stream_name varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_module_stream_profiles_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`module_name`	(optional) The name of a module. This parameter is required if a streamName is specified.
`stream_name`	(optional) The name of the stream of the containing module. This parameter is required if a profileName is specified.
`name`	(optional) The name of the entity to be queried.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODULE_STREAMS Function

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.

Syntax

FUNCTION list_module_streams (
  software_source_id varchar2,
  module_name varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  is_latest number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  module_name_contains varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_module_streams_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`module_name`	(optional) The name of a module. This parameter is required if a streamName is specified.
`name`	(optional) The name of the entity to be queried.
`is_latest`	(optional) A boolean variable that is used to list only the latest versions of packages, module streams, and stream profiles when set to true. All packages, module streams, and stream profiles are returned when set to false.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) A filter to return resources that may partially match the module name given.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PACKAGE_GROUPS Function

Lists package groups that associate 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.

Syntax

FUNCTION list_package_groups (
  software_source_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  name_contains varchar2 DEFAULT NULL,
  group_type dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_package_groups_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`compartment_id`	(optional) The OCID of the compartment that contains the resources to list.
`name`	(optional) The name of the entity to be queried.
`name_contains`	(optional) A filter to return resources that may partially match the name given.
`group_type`	(optional) A filter to return only package groups of the specified type.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SOFTWARE_PACKAGES Function

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

Syntax

FUNCTION list_software_packages (
  software_source_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  is_latest number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_software_packages_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`display_name`	(optional) A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`
`display_name_contains`	(optional) A filter to return resources that may partially match the given display name.
`is_latest`	(optional) A boolean variable that is used to list only the latest versions of packages, module streams, and stream profiles when set to true. All packages, module streams, and stream profiles are returned when set to false.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SOFTWARE_SOURCE_VENDORS Function

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

Syntax

FUNCTION list_software_source_vendors (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_software_source_vendors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment that contains the resources to list. This parameter is required.
`opc_request_id`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) The name of the entity to be queried.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SOFTWARE_SOURCES Function

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.

Syntax

FUNCTION list_software_sources (
  compartment_id varchar2 DEFAULT NULL,
  software_source_id varchar2 DEFAULT NULL,
  software_source_type dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  vendor_name varchar2 DEFAULT NULL,
  os_family dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  arch_type dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  availability dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  display_name_not_equal_to dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_list_software_sources_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment that contains the resources to list.
`software_source_id`	(optional) The OCID for the software source.
`software_source_type`	(optional) The type of the software source. Allowed values are: 'VENDOR', 'CUSTOM', 'VERSIONED'
`vendor_name`	(optional) A filter to return only profiles that match the given vendorName. Allowed values are: 'ORACLE'
`os_family`	(optional) A filter to return only instances whose OS family type matches the given OS family. Allowed values are: 'ORACLE_LINUX_9', 'ORACLE_LINUX_8', 'ORACLE_LINUX_7'
`arch_type`	(optional) A filter to return only instances whose architecture type matches the given architecture. Allowed values are: 'X86_64', 'AARCH64', 'I686', 'NOARCH', 'SRC'
`availability`	(optional) The availabilities of the software source for a tenant. Allowed values are: 'AVAILABLE', 'SELECTED', 'RESTRICTED'
`display_name`	(optional) A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`
`display_name_contains`	(optional) A filter to return resources that may partially match the given display name.
`display_name_not_equal_to`	(optional) A multi filter to return resources that do not contains the given display names.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) A filter to return only resources whose lifecycleState matches the given lifecycleStates.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SEARCH_SOFTWARE_SOURCE_MODULE_STREAMS Function

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

Syntax

FUNCTION search_software_source_module_streams (
  search_software_source_module_streams_details dbms_cloud_oci_os_management_hub_search_software_source_module_streams_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_search_software_source_module_streams_response_t;

Parameters

Parameter	Description
`search_software_source_module_streams_details`	(required) Request body that takes a list of software sources and any search filters.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(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`	(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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SEARCH_SOFTWARE_SOURCE_MODULES Function

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

Syntax

FUNCTION search_software_source_modules (
  search_software_source_modules_details dbms_cloud_oci_os_management_hub_search_software_source_modules_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_search_software_source_modules_response_t;

Parameters

Parameter	Description
`search_software_source_modules_details`	(required) Request body that takes a list of software sources and any search filters.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(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`	(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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SEARCH_SOFTWARE_SOURCE_PACKAGE_GROUPS Function

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.

Syntax

FUNCTION search_software_source_package_groups (
  search_software_source_package_groups_details dbms_cloud_oci_os_management_hub_search_software_source_package_groups_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_search_software_source_package_groups_response_t;

Parameters

Parameter	Description
`search_software_source_package_groups_details`	(required) Request body that takes in a list of software sources and other search parameters.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(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`	(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`
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SOFTWARE_SOURCE Function

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

Syntax

FUNCTION update_software_source (
  software_source_id varchar2,
  update_software_source_details dbms_cloud_oci_os_management_hub_update_software_source_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_software_source_update_software_source_response_t;

Parameters

Parameter	Description
`software_source_id`	(required) The software source OCID.
`update_software_source_details`	(required) The information to be updated.
`opc_request_id`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://osmh.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

CHANGE_AVAILABILITY_OF_SOFTWARE_SOURCES Function

CREATE_ENTITLEMENT Function

CREATE_SOFTWARE_SOURCE Function

DELETE_SOFTWARE_SOURCE Function

GET_ERRATUM Function

GET_MODULE_STREAM Function

GET_MODULE_STREAM_PROFILE Function

GET_PACKAGE_GROUP Function

GET_SOFTWARE_PACKAGE Function

GET_SOFTWARE_SOURCE Function

LIST_ENTITLEMENTS Function

LIST_ERRATA Function

LIST_MODULE_STREAM_PROFILES Function

LIST_MODULE_STREAMS Function

LIST_PACKAGE_GROUPS Function

LIST_SOFTWARE_PACKAGES Function

LIST_SOFTWARE_SOURCE_VENDORS Function

LIST_SOFTWARE_SOURCES Function

SEARCH_SOFTWARE_SOURCE_MODULE_STREAMS Function

SEARCH_SOFTWARE_SOURCE_MODULES Function

SEARCH_SOFTWARE_SOURCE_PACKAGE_GROUPS Function

UPDATE_SOFTWARE_SOURCE Function