OS Management Hub Management Station Functions

Package: DBMS_CLOUD_OCI_OMH_MANAGEMENT_STATION

CREATE_MANAGEMENT_STATION Function

Creates a management station.

Syntax

FUNCTION create_management_station (
  create_management_station_details dbms_cloud_oci_os_management_hub_create_management_station_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_management_station_create_management_station_response_t;

Parameters

Parameter	Description
`create_management_station_details`	(required) Details for the new ManagementStation.
`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_MANAGEMENT_STATION Function

Deletes a management station.

Syntax

FUNCTION delete_management_station (
  management_station_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_management_station_delete_management_station_response_t;

Parameters

Parameter	Description
`management_station_id`	(required) The OCID of the management station.
`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_MANAGEMENT_STATION Function

Gets information about the specified management station.

Syntax

FUNCTION get_management_station (
  management_station_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_management_station_get_management_station_response_t;

Parameters

Parameter	Description
`management_station_id`	(required) The OCID of the management station.
`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_MANAGEMENT_STATIONS Function

Lists management stations in a compartment.

Syntax

FUNCTION list_management_stations (
  compartment_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  managed_instance_id 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,
  id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_omh_management_station_list_management_stations_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment that contains the resources to list.
`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.
`lifecycle_state`	(optional) The current lifecycle state for the object.
`managed_instance_id`	(optional) The OCID of the managed instance for which to list resources.
`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. If no value is specified timeCreated is default. 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.
`id`	(optional) The OCID of the management station.
`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_MIRRORS Function

Lists all software source mirrors associated with a specified management station.

Syntax

FUNCTION list_mirrors (
  management_station_id varchar2,
  display_name varchar2 DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  mirror_states 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_management_station_list_mirrors_response_t;

Parameters

Parameter	Description
`management_station_id`	(required) The OCID of the management station.
`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.
`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. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`mirror_states`	(optional) List of Mirror state to filter by Allowed values are: 'UNSYNCED', 'QUEUED', 'SYNCING', 'SYNCED', 'FAILED'
`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.

SYNCHRONIZE_MIRRORS Function

Synchronizes the specified mirrors associated with the management station.

Syntax

FUNCTION synchronize_mirrors (
  management_station_id varchar2,
  synchronize_mirrors_details dbms_cloud_oci_os_management_hub_synchronize_mirrors_details_t,
  if_match varchar2 DEFAULT NULL,
  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_management_station_synchronize_mirrors_response_t;

Parameters

Parameter	Description
`management_station_id`	(required) The OCID of the management station.
`synchronize_mirrors_details`	(required) Details for syncing mirrors
`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.
`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.

SYNCHRONIZE_SINGLE_MIRRORS Function

Synchronize the specified mirror associated with a management station.

Syntax

FUNCTION synchronize_single_mirrors (
  management_station_id varchar2,
  mirror_id varchar2,
  if_match varchar2 DEFAULT NULL,
  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_management_station_synchronize_single_mirrors_response_t;

Parameters

Parameter	Description
`management_station_id`	(required) The OCID of the management station.
`mirror_id`	(required) Unique Software Source identifier
`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.
`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.

UPDATE_MANAGEMENT_STATION Function

Updates the configuration of the specified management station.

Syntax

FUNCTION update_management_station (
  management_station_id varchar2,
  update_management_station_details dbms_cloud_oci_os_management_hub_update_management_station_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_management_station_update_management_station_response_t;

Parameters

Parameter	Description
`management_station_id`	(required) The OCID of the management station.
`update_management_station_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

CREATE_MANAGEMENT_STATION Function 🔗

DELETE_MANAGEMENT_STATION Function 🔗

GET_MANAGEMENT_STATION Function 🔗

LIST_MANAGEMENT_STATIONS Function 🔗

LIST_MIRRORS Function 🔗

SYNCHRONIZE_MIRRORS Function 🔗

SYNCHRONIZE_SINGLE_MIRRORS Function 🔗

UPDATE_MANAGEMENT_STATION Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CREATE_MANAGEMENT_STATION Function

DELETE_MANAGEMENT_STATION Function

GET_MANAGEMENT_STATION Function

LIST_MANAGEMENT_STATIONS Function

LIST_MIRRORS Function

SYNCHRONIZE_MIRRORS Function

SYNCHRONIZE_SINGLE_MIRRORS Function

UPDATE_MANAGEMENT_STATION Function