VnMonitoringClient

class oci.vn_monitoring.VnMonitoringClient(config, **kwargs)

Use the Network Monitoring API to troubleshoot routing and security issues for resources such as virtual cloud networks (VCNs) and compute instances. For more information, see the console documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/path_analyzer.htm) tool.

Methods

__init__(config, **kwargs)	Creates a new service client
change_path_analyzer_test_compartment(…)	Moves a PathAnalyzerTest resource from one compartment to another based on the identifier.
create_path_analyzer_test(…)	Creates a new PathAnalyzerTest resource.
delete_path_analyzer_test(…)	Deletes a PathAnalyzerTest resource using its identifier.
get_path_analysis(get_path_analysis_details, …)	Use this method to initiate a `Network Path Analyzer`__ analysis.
get_path_analyzer_test(…)	Gets a PathAnalyzerTest using its identifier.
get_work_request(work_request_id, **kwargs)	Gets the details of a work request.
list_path_analyzer_tests(compartment_id, …)	Returns a list of all PathAnalyzerTests in a compartment.
list_work_request_errors(work_request_id, …)	Returns a (paginated) list of errors for the work request with the given ID.
list_work_request_logs(work_request_id, **kwargs)	Returns a (paginated) list of logs for the work request with the given ID.
list_work_request_results(work_request_id, …)	Returns a (paginated) list of results for a successful work request.
list_work_requests(compartment_id, **kwargs)	Lists the work requests in a compartment.
update_path_analyzer_test(…)	Updates a PathAnalyzerTest using its identifier.

__init__(config, **kwargs)

Creates a new service client

Parameters:

• config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
• service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
• timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
• signer (AbstractBaseSigner) –

  (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

  One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

• retry_strategy (obj) –

  (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

  This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

• circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
• circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
• client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
• allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_path_analyzer_test_compartment(path_analyzer_test_id, change_path_analyzer_test_compartment_details, **kwargs)

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

Parameters:

• path_analyzer_test_id (str) –

  (required) The `OCID`__ of the PathAnalyzerTest resource.

• change_path_analyzer_test_compartment_details (oci.vn_monitoring.models.ChangePathAnalyzerTestCompartmentDetails) – (required) The information to update.
• if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_path_analyzer_test_compartment API.

create_path_analyzer_test(create_path_analyzer_test_details, **kwargs)

Creates a new PathAnalyzerTest resource.

Parameters:

• create_path_analyzer_test_details (oci.vn_monitoring.models.CreatePathAnalyzerTestDetails) – (required) Details for creating a new PathAnalyzerTest.
• opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type PathAnalyzerTest

Return type:

Response

Example:

Click here to see an example of how to use create_path_analyzer_test API.

delete_path_analyzer_test(path_analyzer_test_id, **kwargs)

Deletes a PathAnalyzerTest resource using its identifier.

Parameters:

• path_analyzer_test_id (str) –

  (required) The `OCID`__ of the PathAnalyzerTest resource.

• if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_path_analyzer_test API.

get_path_analysis(get_path_analysis_details, **kwargs)

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() with the work request ID to ask for the successful analysis results. If the work request status is failed, use list_work_request_errors() 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.

Parameters:

• get_path_analysis_details (oci.vn_monitoring.models.GetPathAnalysisDetails) – (required) Details for the path analysis query.
• opc_retry_token (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• cache_control (str) – (optional) The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use get_path_analysis API.

get_path_analyzer_test(path_analyzer_test_id, **kwargs)

Gets a PathAnalyzerTest using its identifier.

Parameters:

• path_analyzer_test_id (str) –

  (required) The `OCID`__ of the PathAnalyzerTest resource.

• opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type PathAnalyzerTest

Return type:

Response

Example:

Click here to see an example of how to use get_path_analyzer_test API.

get_work_request(work_request_id, **kwargs)

Gets the details of a work request.

Parameters:

• work_request_id (str) –

  (required) The `OCID`__ of the work request.

• opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

list_path_analyzer_tests(compartment_id, **kwargs)

Returns a list of all PathAnalyzerTests in a compartment.

Parameters:

• compartment_id (str) –

  (required) The `OCID`__ of the compartment.

• lifecycle_state (str) –

  (optional) A filter that returns only resources whose lifecycleState matches the given lifecycleState.

  Allowed values are: “ACTIVE”, “DELETED”

• display_name (str) – (optional) A filter that returns only resources that match the entire display name given.
• limit (int) –

  (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 (str) –

  (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 (str) –

  (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 (str) –

  (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type PathAnalyzerTestCollection

Return type:

Response

Example:

Click here to see an example of how to use list_path_analyzer_tests API.

list_work_request_errors(work_request_id, **kwargs)

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

Parameters:

• work_request_id (str) –

  (required) The `OCID`__ of the work request.

• opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• limit (int) –

  (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 (str) –

  (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 (str) –

  (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 (str) –

  (optional) The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending.

  Allowed values are: “timeCreated”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

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

Parameters:

• work_request_id (str) –

  (required) The `OCID`__ of the work request.

• opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• limit (int) –

  (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 (str) –

  (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 (str) –

  (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 (str) –

  (optional) The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending.

  Allowed values are: “timeCreated”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestLogEntryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_request_results(work_request_id, **kwargs)

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

Parameters:

• work_request_id (str) –

  (required) The `OCID`__ of the work request.

• opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• limit (int) –

  (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 (str) –

  (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 (str) –

  (optional) The type of results to return.

  Allowed values are: “PATH_ANALYSIS”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestResultCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_results API.

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:

• compartment_id (str) –

  (required) The `OCID`__ of the compartment.

• work_request_id (str) – (optional) The ID of the asynchronous work request.
• limit (int) –

  (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 (str) –

  (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• sort_order (str) –

  (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 (str) –

  (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 (str) –

  (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 (str) – (optional) The ID of the resource affected by the work request.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestSummaryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

update_path_analyzer_test(path_analyzer_test_id, update_path_analyzer_test_details, **kwargs)

Updates a PathAnalyzerTest using its identifier.

Parameters:

• path_analyzer_test_id (str) –

  (required) The `OCID`__ of the PathAnalyzerTest resource.

• update_path_analyzer_test_details (oci.vn_monitoring.models.UpdatePathAnalyzerTestDetails) – (required) The information to update.
• if_match (str) – (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 (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• opc_retry_token (str) – (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).
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type PathAnalyzerTest

Return type:

Response

Example:

Click here to see an example of how to use update_path_analyzer_test API.