VN Monitoring Functions

CHANGE_PATH_ANALYZER_TEST_COMPARTMENT Function

Moves a `PathAnalyzerTest` resource from one compartment to another based on the identifier.

Syntax

FUNCTION change_path_analyzer_test_compartment (
  path_analyzer_test_id varchar2,
  change_path_analyzer_test_compartment_details dbms_cloud_oci_vn_monitoring_change_path_analyzer_test_compartment_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_vnm_vn_monitoring_change_path_analyzer_test_compartment_response_t;

Parameters

Parameter	Description
`path_analyzer_test_id`	(required) The OCID of the `PathAnalyzerTest` resource.
`change_path_analyzer_test_compartment_details`	(required) The information to update.
`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 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://vnca-api.{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_PATH_ANALYZER_TEST Function

Creates a new `PathAnalyzerTest` resource.

Syntax

FUNCTION create_path_analyzer_test (
  create_path_analyzer_test_details dbms_cloud_oci_vn_monitoring_create_path_analyzer_test_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_vnm_vn_monitoring_create_path_analyzer_test_response_t;

Parameters

Parameter	Description
`create_path_analyzer_test_details`	(required) Details for creating a new PathAnalyzerTest.
`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 may be rejected).
`opc_request_id`	(optional) Unique 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://vnca-api.{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_PATH_ANALYZER_TEST Function

Deletes a `PathAnalyzerTest` resource using its identifier.

Syntax

FUNCTION delete_path_analyzer_test (
  path_analyzer_test_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_vnm_vn_monitoring_delete_path_analyzer_test_response_t;

Parameters

Parameter	Description
`path_analyzer_test_id`	(required) The OCID of the `PathAnalyzerTest` resource.
`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 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://vnca-api.{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_PATH_ANALYSIS Function

Use this method to initiate a Network Path Analyzer analysis. This method returns an opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds. If the work request status is successful, use LIST_WORK_REQUEST_RESULTS Function with the work request ID to ask for the successful analysis results. If the work request status is failed, use LIST_WORK_REQUEST_ERRORS Function with the work request ID to ask for the analysis failure information. The information returned from either of these methods can be used to build a final report.

Syntax

FUNCTION get_path_analysis (
  get_path_analysis_details dbms_cloud_oci_vn_monitoring_get_path_analysis_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  cache_control varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vnm_vn_monitoring_get_path_analysis_response_t;

Parameters

Parameter	Description
`get_path_analysis_details`	(required) Details for the path analysis query.
`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 may be rejected).
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`cache_control`	(optional) The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
`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://vnca-api.{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_PATH_ANALYZER_TEST Function

Gets a `PathAnalyzerTest` using its identifier.

Syntax

FUNCTION get_path_analyzer_test (
  path_analyzer_test_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_vnm_vn_monitoring_get_path_analyzer_test_response_t;

Parameters

Parameter	Description
`path_analyzer_test_id`	(required) The OCID of the `PathAnalyzerTest` resource.
`opc_request_id`	(optional) Unique 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://vnca-api.{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_WORK_REQUEST Function

Gets the details of a work request.

Syntax

FUNCTION get_work_request (
  work_request_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_vnm_vn_monitoring_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique 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://vnca-api.{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_PATH_ANALYZER_TESTS Function

Returns a list of all `PathAnalyzerTests` in a compartment.

Syntax

FUNCTION list_path_analyzer_tests (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_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_vnm_vn_monitoring_list_path_analyzer_tests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`lifecycle_state`	(optional) A filter that returns only resources whose `lifecycleState` matches the given `lifecycleState`.
`display_name`	(optional) A filter that returns only resources that match the entire display name given.
`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.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME'
`opc_request_id`	(optional) Unique 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://vnca-api.{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_WORK_REQUEST_ERRORS Function

Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vnm_vn_monitoring_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique 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.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for `timeCreated` is descending. Allowed values are: 'timeCreated'
`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://vnca-api.{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_WORK_REQUEST_LOGS Function

Returns a (paginated) list of logs for the work request with the given ID.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vnm_vn_monitoring_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique 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.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for `timeCreated` is descending. Allowed values are: 'timeCreated'
`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://vnca-api.{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_WORK_REQUEST_RESULTS Function

Returns a (paginated) list of results for a successful work request. This information is used to build the final report output.

Syntax

FUNCTION list_work_request_results (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  result_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vnm_vn_monitoring_list_work_request_results_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`opc_request_id`	(optional) Unique 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.
`result_type`	(optional) The type of results to return.
`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://vnca-api.{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_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  work_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_vnm_vn_monitoring_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`work_request_id`	(optional) The ID of the asynchronous work request.
`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.
`opc_request_id`	(optional) Unique 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 ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for `timeAccepted` is descending. Allowed values are: 'timeAccepted'
`status`	(optional) A filter to return only resources whose `lifecycleState` matches the given `OperationStatus`. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`resource_id`	(optional) The ID of the resource affected by the work request.
`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://vnca-api.{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_PATH_ANALYZER_TEST Function

Updates a `PathAnalyzerTest` using its identifier.

Syntax

FUNCTION update_path_analyzer_test (
  path_analyzer_test_id varchar2,
  update_path_analyzer_test_details dbms_cloud_oci_vn_monitoring_update_path_analyzer_test_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_vnm_vn_monitoring_update_path_analyzer_test_response_t;

Parameters

Parameter	Description
`path_analyzer_test_id`	(required) The OCID of the `PathAnalyzerTest` resource.
`update_path_analyzer_test_details`	(required) The information to update.
`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 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 may 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://vnca-api.{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

CHANGE_PATH_ANALYZER_TEST_COMPARTMENT Function 🔗

CREATE_PATH_ANALYZER_TEST Function 🔗

DELETE_PATH_ANALYZER_TEST Function 🔗

GET_PATH_ANALYSIS Function 🔗

GET_PATH_ANALYZER_TEST Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_PATH_ANALYZER_TESTS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUEST_RESULTS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_PATH_ANALYZER_TEST Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_PATH_ANALYZER_TEST_COMPARTMENT Function

CREATE_PATH_ANALYZER_TEST Function

DELETE_PATH_ANALYZER_TEST Function

GET_PATH_ANALYSIS Function

GET_PATH_ANALYZER_TEST Function

GET_WORK_REQUEST Function

LIST_PATH_ANALYZER_TESTS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUEST_RESULTS Function

LIST_WORK_REQUESTS Function

UPDATE_PATH_ANALYZER_TEST Function