OS Management Hub Lifecycle Environment Functions

Package: DBMS_CLOUD_OCI_OMH_LIFECYCLE_ENVIRONMENT

ATTACH_MANAGED_INSTANCES_TO_LIFECYCLE_STAGE Function

Attach(add) managed instances to a lifecycle stage. Once added operations can be applied to all managed instances in the lifecycle stage.

Syntax

FUNCTION attach_managed_instances_to_lifecycle_stage (
  lifecycle_stage_id varchar2,
  attach_managed_instances_to_lifecycle_stage_details dbms_cloud_oci_os_management_hub_attach_managed_instances_to_lifecycle_stage_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token 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_lifecycle_environment_attach_managed_instances_to_lifecycle_stage_response_t;

Parameters

Parameter	Description
`lifecycle_stage_id`	(required) The OCID of the lifecycle stage.
`attach_managed_instances_to_lifecycle_stage_details`	(required) Details for managed instances to attach to the lifecycle stage.
`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.
`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.

CREATE_LIFECYCLE_ENVIRONMENT Function

Creates a new lifecycle environment.

Syntax

FUNCTION create_lifecycle_environment (
  create_lifecycle_environment_details dbms_cloud_oci_os_management_hub_create_lifecycle_environment_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_lifecycle_environment_create_lifecycle_environment_response_t;

Parameters

Parameter	Description
`create_lifecycle_environment_details`	(required) Details for the new lifecycle environment.
`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_LIFECYCLE_ENVIRONMENT Function

Deletes a lifecycle environment.

Syntax

FUNCTION delete_lifecycle_environment (
  lifecycle_environment_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_lifecycle_environment_delete_lifecycle_environment_response_t;

Parameters

Parameter	Description
`lifecycle_environment_id`	(required) The OCID of the lifecycle environment.
`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.

DETACH_MANAGED_INSTANCES_FROM_LIFECYCLE_STAGE Function

Detach(remove) managed instance from a lifecycle stage.

Syntax

FUNCTION detach_managed_instances_from_lifecycle_stage (
  lifecycle_stage_id varchar2,
  detach_managed_instances_from_lifecycle_stage_details dbms_cloud_oci_os_management_hub_detach_managed_instances_from_lifecycle_stage_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token 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_lifecycle_environment_detach_managed_instances_from_lifecycle_stage_response_t;

Parameters

Parameter	Description
`lifecycle_stage_id`	(required) The OCID of the lifecycle stage.
`detach_managed_instances_from_lifecycle_stage_details`	(required) Details for managed instances to detach from the lifecycle stage.
`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.
`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_LIFECYCLE_ENVIRONMENT Function

Gets information about the specified lifecycle environment.

Syntax

FUNCTION get_lifecycle_environment (
  lifecycle_environment_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_lifecycle_environment_get_lifecycle_environment_response_t;

Parameters

Parameter	Description
`lifecycle_environment_id`	(required) The OCID of the lifecycle environment.
`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_LIFECYCLE_STAGE Function

Gets information about the specified lifecycle stage.

Syntax

FUNCTION get_lifecycle_stage (
  lifecycle_stage_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_lifecycle_environment_get_lifecycle_stage_response_t;

Parameters

Parameter	Description
`lifecycle_stage_id`	(required) The OCID of the lifecycle stage.
`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_LIFECYCLE_ENVIRONMENTS Function

Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

Syntax

FUNCTION list_lifecycle_environments (
  compartment_id varchar2 DEFAULT NULL,
  display_name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_environment_id varchar2 DEFAULT NULL,
  arch_type varchar2 DEFAULT NULL,
  os_family 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_lifecycle_environment_list_lifecycle_environments_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.
`lifecycle_environment_id`	(optional) The OCID of the lifecycle environment.
`arch_type`	(optional) A filter to return only profiles that match the given archType. Allowed values are: 'X86_64', 'AARCH64', 'I686', 'NOARCH', 'SRC'
`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'
`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 the lifecycle environments that match the display name given.
`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_LIFECYCLE_STAGE_INSTALLED_PACKAGES Function

Lists installed packages on managed instances in a specified lifecycle stage. Filter the list against a variety of criteria including but not limited to the package name.

Syntax

FUNCTION list_lifecycle_stage_installed_packages (
  lifecycle_stage_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  display_name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name_contains 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_lifecycle_environment_list_lifecycle_stage_installed_packages_response_t;

Parameters

Parameter	Description
`lifecycle_stage_id`	(required) The OCID of the lifecycle stage.
`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.
`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 lifecycle stage whose lifecycle state matches the given lifecycle state.
`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_LIFECYCLE_STAGES Function

Lists lifecycle stages that match the specified compartment or lifecycle stage OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

Syntax

FUNCTION list_lifecycle_stages (
  compartment_id varchar2 DEFAULT NULL,
  display_name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_stage_id varchar2 DEFAULT NULL,
  software_source_id varchar2 DEFAULT NULL,
  arch_type varchar2 DEFAULT NULL,
  os_family 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_lifecycle_environment_list_lifecycle_stages_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.
`lifecycle_stage_id`	(optional) The OCID of the lifecycle stage.
`software_source_id`	(optional) The OCID for the software source.
`arch_type`	(optional) A filter to return only profiles that match the given archType. Allowed values are: 'X86_64', 'AARCH64', 'I686', 'NOARCH', 'SRC'
`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'
`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 lifecycle stage whose lifecycle state matches the given lifecycle state.
`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.

PROMOTE_SOFTWARE_SOURCE_TO_LIFECYCLE_STAGE Function

Updates the versioned custom software source content for specified lifecycle stage.

Syntax

FUNCTION promote_software_source_to_lifecycle_stage (
  lifecycle_stage_id varchar2,
  promote_software_source_to_lifecycle_stage_details dbms_cloud_oci_os_management_hub_promote_software_source_to_lifecycle_stage_details_t,
  software_source_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token 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_lifecycle_environment_promote_software_source_to_lifecycle_stage_response_t;

Parameters

Parameter	Description
`lifecycle_stage_id`	(required) The OCID of the lifecycle stage.
`promote_software_source_to_lifecycle_stage_details`	(required) Details for the software source promotion job.
`software_source_id`	(optional) The OCID for the 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.
`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.

UPDATE_LIFECYCLE_ENVIRONMENT Function

Updates the specified lifecycle environment's name, description, stages, or tags.

Syntax

FUNCTION update_lifecycle_environment (
  lifecycle_environment_id varchar2,
  update_lifecycle_environment_details dbms_cloud_oci_os_management_hub_update_lifecycle_environment_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_lifecycle_environment_update_lifecycle_environment_response_t;

Parameters

Parameter	Description
`lifecycle_environment_id`	(required) The OCID of the lifecycle environment.
`update_lifecycle_environment_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.

Oracle Cloud Infrastructure Documentation Try Free Tier

ATTACH_MANAGED_INSTANCES_TO_LIFECYCLE_STAGE Function 🔗

CREATE_LIFECYCLE_ENVIRONMENT Function 🔗

DELETE_LIFECYCLE_ENVIRONMENT Function 🔗

DETACH_MANAGED_INSTANCES_FROM_LIFECYCLE_STAGE Function 🔗

GET_LIFECYCLE_ENVIRONMENT Function 🔗

GET_LIFECYCLE_STAGE Function 🔗

LIST_LIFECYCLE_ENVIRONMENTS Function 🔗

LIST_LIFECYCLE_STAGE_INSTALLED_PACKAGES Function 🔗

LIST_LIFECYCLE_STAGES Function 🔗

PROMOTE_SOFTWARE_SOURCE_TO_LIFECYCLE_STAGE Function 🔗

UPDATE_LIFECYCLE_ENVIRONMENT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ATTACH_MANAGED_INSTANCES_TO_LIFECYCLE_STAGE Function

CREATE_LIFECYCLE_ENVIRONMENT Function

DELETE_LIFECYCLE_ENVIRONMENT Function

DETACH_MANAGED_INSTANCES_FROM_LIFECYCLE_STAGE Function

GET_LIFECYCLE_ENVIRONMENT Function

GET_LIFECYCLE_STAGE Function

LIST_LIFECYCLE_ENVIRONMENTS Function

LIST_LIFECYCLE_STAGE_INSTALLED_PACKAGES Function

LIST_LIFECYCLE_STAGES Function

PROMOTE_SOFTWARE_SOURCE_TO_LIFECYCLE_STAGE Function

UPDATE_LIFECYCLE_ENVIRONMENT Function