Oracle Cloud Infrastructure Documentation
Try Free Tier

OS Management Hub Onboarding Functions

Package: DBMS_CLOUD_OCI_OMH_ONBOARDING

CREATE_PROFILE Function

Creates a registration profile. A profile is a supplementary file for the OS Management Hub agentry that dictates the content for a managed instance at registration time.

Syntax

FUNCTION create_profile (
  create_profile_details dbms_cloud_oci_os_management_hub_create_profile_details_t,
  opc_retry_token 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_onboarding_create_profile_response_t;

Parameters

Parameter Description

create_profile_details

(required) Details for the new registration profile.

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.

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.

DELETE_PROFILE Function

Deletes a specified registration profile.

Syntax

FUNCTION delete_profile (
  profile_id varchar2,
  if_match 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_onboarding_delete_profile_response_t;

Parameters

Parameter Description

profile_id

(required) The OCID of the registration profile.

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.

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_PROFILE Function

Gets information about the specified registration profile.

Syntax

FUNCTION get_profile (
  profile_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_onboarding_get_profile_response_t;

Parameters

Parameter Description

profile_id

(required) The OCID of the registration profile.

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_PROFILES Function

Lists registration profiles that match the specified compartment or profile OCID. Filter the list against a variety of criteria including but not limited to its name, status, vendor name, and architecture type.

Syntax

FUNCTION list_profiles (
  compartment_id varchar2 DEFAULT NULL,
  display_name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  profile_type dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  profile_id varchar2 DEFAULT NULL,
  os_family varchar2 DEFAULT NULL,
  arch_type varchar2 DEFAULT NULL,
  vendor_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state 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_onboarding_list_profiles_response_t;

Parameters

Parameter Description

compartment_id

(optional) The OCID of the compartment that contains the resources to list.

display_name

(optional) A filter to return resources that match the given display names.

display_name_contains

(optional) A filter to return resources that may partially match the given display name.

profile_type

(optional) A filter to return registration profiles that match the given profileType.

Allowed values are: 'SOFTWARESOURCE', 'GROUP', 'LIFECYCLE', 'STATION'

profile_id

(optional) The OCID of the registration profile.

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'

arch_type

(optional) A filter to return only profiles that match the given archType.

Allowed values are: 'X86_64', 'AARCH64', 'I686', 'NOARCH', 'SRC'

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`

lifecycle_state

(optional) A filter to return only registration profile whose lifecycleState matches the given lifecycleState.

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.

UPDATE_PROFILE Function

Updates the specified profile's name, description, and tags.

Syntax

FUNCTION update_profile (
  profile_id varchar2,
  update_profile_details dbms_cloud_oci_os_management_hub_update_profile_details_t,
  if_match 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_onboarding_update_profile_response_t;

Parameters

Parameter Description

profile_id

(required) The OCID of the registration profile.

update_profile_details

(required) The information to be updated.

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.

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.

Was this article helpful?