JavaManagementServiceClient¶

class oci.jms.JavaManagementServiceClient(config, **kwargs)¶

The APIs for the [Fleet Management](https://docs.oracle.com/en-us/iaas/jms/doc/fleet-management.html) feature of Java Management Service to monitor and manage the usage of Java in your enterprise. Use these APIs to manage fleets, configure managed instances to report to fleets, and gain insights into the Java workloads running on these instances by carrying out basic and advanced features.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_fleet_installation_sites`(fleet_id, …)	Add Java installation sites in a Fleet.
`cancel_work_request`(work_request_id, **kwargs)	Deletes the work request specified by an identifier.
`change_fleet_compartment`(fleet_id, …)	Move a specified Fleet into the compartment identified in the POST form.
`create_blocklist`(fleet_id, …)	Add a new record to the fleet blocklist.
`create_drs_file`(fleet_id, …)	Request to perform validation of the DRS file and create the file to the Object Storage.
`create_fleet`(create_fleet_details, **kwargs)	Create a new Fleet using the information provided.
`create_jms_plugin`(create_jms_plugin_details, …)	Registers an agent’s JmsPlugin, optionally attaching to an existing fleet of the tenancy.
`delete_blocklist`(fleet_id, blocklist_key, …)	Deletes the blocklist record specified by an identifier.
`delete_crypto_analysis_result`(fleet_id, …)	Deletes the metadata for the result of a Crypto event analysis.
`delete_drs_file`(fleet_id, drs_file_key, **kwargs)	Request to delete the DRS file from the Object Storage.
`delete_fleet`(fleet_id, **kwargs)	Deletes the Fleet specified by an identifier.
`delete_java_migration_analysis_result`(…)	Delete the Java migration analysis result.
`delete_jms_plugin`(jms_plugin_id, **kwargs)	Deletes a JmsPlugin.
`delete_performance_tuning_analysis_result`(…)	Deletes only the metadata of the Performance Tuning Analysis result, but the file remains in the object storage.
`disable_drs`(fleet_id, disable_drs_details, …)	Request to disable the DRS in the selected target in the Fleet.
`enable_drs`(fleet_id, enable_drs_details, …)	Request to enable the DRS in the selected target in the Fleet.
`generate_agent_deploy_script`(fleet_id, …)	Generates Agent Deploy Script for Fleet using the information provided.
`generate_agent_installer_configuration`(…)	Generates the agent installer configuration using the information provided.
`generate_load_pipeline_script`(fleet_id, …)	Generates Load Pipeline Script
`get_crypto_analysis_result`(fleet_id, …)	Retrieve the metadata for the result of a Crypto event analysis.
`get_drs_file`(fleet_id, drs_file_key, **kwargs)	Get the detail about the created DRS file in the Fleet.
`get_export_setting`(fleet_id, **kwargs)	Returns export setting for the specified fleet.
`get_export_status`(fleet_id, **kwargs)	Returns last export status for the specified fleet.
`get_fleet`(fleet_id, **kwargs)	Retrieve a Fleet with the specified identifier.
`get_fleet_advanced_feature_configuration`(…)	Returns Fleet level advanced feature configuration.
`get_fleet_agent_configuration`(fleet_id, **kwargs)	Retrieve a Fleet Agent Configuration for the specified Fleet.
`get_java_family`(family_version, **kwargs)	Returns metadata associated with a specific Java release family.
`get_java_migration_analysis_result`(fleet_id, …)	Retrieve Java Migration Analysis result.
`get_java_release`(release_version, **kwargs)	Returns detail of a Java release.
`get_jms_plugin`(jms_plugin_id, **kwargs)	Returns the JmsPlugin.
`get_performance_tuning_analysis_result`(…)	Retrieve metadata of the Performance Tuning Analysis result.
`get_work_request`(work_request_id, **kwargs)	Retrieve the details of a work request with the specified ID.
`list_agent_installers`(**kwargs)	Returns a list of the agent installer information.
`list_announcements`(**kwargs)	Return a list of AnnouncementSummary items
`list_blocklists`(fleet_id, **kwargs)	Returns a list of blocklist entities contained by a fleet.
`list_crypto_analysis_results`(fleet_id, **kwargs)	Lists the results of a Crypto event analysis.
`list_drs_files`(fleet_id, **kwargs)	List the details about the created DRS files in the Fleet.
`list_fleet_diagnoses`(fleet_id, **kwargs)	List potential diagnoses that would put a fleet into FAILED or NEEDS_ATTENTION lifecycle state.
`list_fleets`(**kwargs)	Returns a list of all the Fleets contained by a compartment.
`list_installation_sites`(fleet_id, **kwargs)	List Java installation sites in a Fleet filtered by query parameters.
`list_java_families`(**kwargs)	Returns a list of the Java release family information.
`list_java_migration_analysis_results`(…)	Lists the results of a Java migration analysis.
`list_java_releases`(**kwargs)	Returns a list of Java releases.
`list_jms_plugins`(**kwargs)	Lists the JmsPlugins.
`list_jre_usage`(**kwargs)	List Java Runtime usage in a specified host filtered by query parameters.
`list_performance_tuning_analysis_results`(…)	List Performance Tuning Analysis results.
`list_work_items`(work_request_id, **kwargs)	Retrieve a paginated list of work items for a specified work request.
`list_work_request_errors`(work_request_id, …)	Retrieve a (paginated) list of errors for a specified work request.
`list_work_request_logs`(work_request_id, **kwargs)	Retrieve a paginated list of logs for a specified work request.
`list_work_requests`(**kwargs)	List the work requests in a compartment.
`remove_fleet_installation_sites`(fleet_id, …)	Remove Java installation sites in a Fleet.
`request_crypto_analyses`(fleet_id, …)	Request to perform crypto analysis on one or more selected targets in the Fleet.
`request_deployed_application_migration_analyses`(…)	Request to perform a deployed Java migration analyses.
`request_java_migration_analyses`(fleet_id, …)	Request to perform a Java migration analysis.
`request_jfr_recordings`(fleet_id, …)	Request to collect the JFR recordings on the selected target in the Fleet.
`request_performance_tuning_analyses`(…)	Request to perform performance tuning analyses.
`scan_java_server_usage`(fleet_id, …)	Scan Java Server usage in a fleet.
`scan_library_usage`(fleet_id, …)	Scan library usage in a fleet.
`summarize_application_installation_usage`(…)	Summarizes the application installation usage in a Fleet filtered by query parameters.
`summarize_application_usage`(fleet_id, **kwargs)	List application usage in a Fleet filtered by query parameters.
`summarize_deployed_application_installation_usage`(…)	Summarize installation usage of an application deployed on Java servers in a fleet filtered by query parameters.
`summarize_deployed_application_usage`(…)	List of deployed applications in a Fleet filtered by query parameters.
`summarize_installation_usage`(fleet_id, **kwargs)	List Java installation usage in a Fleet filtered by query parameters.
`summarize_java_server_instance_usage`(…)	List Java Server instances in a fleet filtered by query parameters.
`summarize_java_server_usage`(fleet_id, **kwargs)	List of Java servers in a Fleet filtered by query parameters.
`summarize_jre_usage`(fleet_id, **kwargs)	List Java Runtime usage in a specified Fleet filtered by query parameters.
`summarize_library_usage`(fleet_id, **kwargs)	List libraries in a fleet filtered by query parameters.
`summarize_managed_instance_usage`(fleet_id, …)	List managed instance usage in a Fleet filtered by query parameters.
`summarize_resource_inventory`(**kwargs)	Retrieve the inventory of JMS resources in the specified compartment: a list of the number of _active_ fleets, managed instances, Java Runtimes, Java installations, and applications.
`update_drs_file`(fleet_id, …)	Request to perform validation of the DRS file and update the existing file in the Object Storage.
`update_export_setting`(fleet_id, …)	Updates existing export setting for the specified fleet.
`update_fleet`(fleet_id, update_fleet_details, …)	Update the Fleet specified by an identifier.
`update_fleet_advanced_feature_configuration`(…)	Update advanced feature configurations for the Fleet.
`update_fleet_agent_configuration`(fleet_id, …)	Update the Fleet Agent Configuration for the specified Fleet.
`update_jms_plugin`(jms_plugin_id, …)	Updates the Fleet of a JmsPlugin.

__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.

add_fleet_installation_sites(fleet_id, add_fleet_installation_sites_details, **kwargs)¶

Add Java installation sites in a Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. add_fleet_installation_sites_details (oci.jms.models.AddFleetInstallationSitesDetails) – (required) List of installation sites to be added. 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_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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 add_fleet_installation_sites API.

cancel_work_request(work_request_id, **kwargs)¶

Deletes the work request specified by an identifier.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 cancel_work_request API.

change_fleet_compartment(fleet_id, change_fleet_compartment_details, **kwargs)¶

Move a specified Fleet into the compartment identified in the POST form. When provided, If-Match is checked against ETag values of the resource.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. change_fleet_compartment_details (oci.jms.models.ChangeFleetCompartmentDetails) – (required) Compartment identifier. 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_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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_fleet_compartment API.

create_blocklist(fleet_id, create_blocklist_details, **kwargs)¶

Add a new record to the fleet blocklist.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. create_blocklist_details (oci.jms.models.CreateBlocklistDetails) – (required) Details for the new blocklist record. 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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `Blocklist`
Return type:	`Response`
Example:

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

create_drs_file(fleet_id, create_drs_file_details, **kwargs)¶

Request to perform validation of the DRS file and create the file to the Object Storage.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. create_drs_file_details (oci.jms.models.CreateDrsFileDetails) – (required) Detail information to create DRS opc_request_id (str) – (optional) The client request ID for tracing. 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_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 might 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 create_drs_file API.

create_fleet(create_fleet_details, **kwargs)¶

Create a new Fleet using the information provided.

inventoryLog is now a required parameter for CreateFleet API. Update existing applications using this API before July 15, 2022 to ensure the applications continue to work. See the Service Change Notice for more details. Migrate existing fleets using the UpdateFleet API to set the inventoryLog parameter.

Parameters:	create_fleet_details (oci.jms.models.CreateFleetDetails) – (required) Details for the new Fleet. 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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 create_fleet API.

create_jms_plugin(create_jms_plugin_details, **kwargs)¶

Registers an agent’s JmsPlugin, optionally attaching to an existing fleet of the tenancy. JmsPlugins registered fleet-less are created with lifecycle state INACTIVE. For the operation to be authorized, the agent must exist, and the authorized user requires JMS_PLUGIN_CREATE permission for the agent’s compartment.

Parameters:	create_jms_plugin_details (oci.jms.models.CreateJmsPluginDetails) – (required) Details for the new JmsPlugin. 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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JmsPlugin`
Return type:	`Response`
Example:

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

delete_blocklist(fleet_id, blocklist_key, **kwargs)¶

Deletes the blocklist record specified by an identifier.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. blocklist_key (str) – (required) The unique identifier of the blocklist record. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_blocklist API.

delete_crypto_analysis_result(fleet_id, crypto_analysis_result_id, **kwargs)¶

Deletes the metadata for the result of a Crypto event analysis. The actual report shall remain in the object storage.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. crypto_analysis_result_id (str) – (required) The OCID of the analysis result. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_crypto_analysis_result API.

delete_drs_file(fleet_id, drs_file_key, **kwargs)¶

Request to delete the DRS file from the Object Storage.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. drs_file_key (str) – (required) The unique identifier of the DRS File in Object Storage. opc_request_id (str) – (optional) The client request ID for tracing. 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_drs_file API.

delete_fleet(fleet_id, **kwargs)¶

Deletes the Fleet specified by an identifier.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_fleet API.

delete_java_migration_analysis_result(fleet_id, java_migration_analysis_result_id, **kwargs)¶

Delete the Java migration analysis result. The actual report will remain in the Object Storage bucket.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. java_migration_analysis_result_id (str) – (required) The OCID of the analysis result. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_java_migration_analysis_result API.

delete_jms_plugin(jms_plugin_id, **kwargs)¶

Deletes a JmsPlugin. The JmsPlugin may be visible for some time with state DELETED. Deleted plugins will not be able to communicate with the JMS service.

Parameters:	jms_plugin_id (str) – (required) The OCID of the JmsPlugin. opc_request_id (str) – (optional) The client request ID for tracing. 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. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_jms_plugin API.

delete_performance_tuning_analysis_result(fleet_id, performance_tuning_analysis_result_id, **kwargs)¶

Deletes only the metadata of the Performance Tuning Analysis result, but the file remains in the object storage.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. performance_tuning_analysis_result_id (str) – (required) The OCID of the performance tuning analysis result. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_performance_tuning_analysis_result API.

disable_drs(fleet_id, disable_drs_details, **kwargs)¶

Request to disable the DRS in the selected target in the Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. disable_drs_details (oci.jms.models.DisableDrsDetails) – (required) Detail information to disable DRS opc_request_id (str) – (optional) The client request ID for tracing. 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_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 might 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 disable_drs API.

enable_drs(fleet_id, enable_drs_details, **kwargs)¶

Request to enable the DRS in the selected target in the Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. enable_drs_details (oci.jms.models.EnableDrsDetails) – (required) Detail information to enable DRS opc_request_id (str) – (optional) The client request ID for tracing. 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_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 might 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 enable_drs API.

generate_agent_deploy_script(fleet_id, generate_agent_deploy_script_details, **kwargs)¶

Generates Agent Deploy Script for Fleet using the information provided.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. generate_agent_deploy_script_details (oci.jms.models.GenerateAgentDeployScriptDetails) – (required) Attributes to generate the agent deploy script for a Fleet. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 stream
Return type:	`Response`
Example:

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

generate_agent_installer_configuration(generate_agent_installer_configuration_details, **kwargs)¶

Generates the agent installer configuration using the information provided.

Parameters:	generate_agent_installer_configuration_details (oci.jms.models.GenerateAgentInstallerConfigurationDetails) – (required) Details that are used to generate the installer configuration for a fleet. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 stream
Return type:	`Response`
Example:

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

generate_load_pipeline_script(fleet_id, generate_load_pipeline_script_details, **kwargs)¶

Generates Load Pipeline Script

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. generate_load_pipeline_script_details (oci.jms.models.GenerateLoadPipelineScriptDetails) – (required) Attributes to generate the load pipeline script. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 stream
Return type:	`Response`
Example:

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

get_crypto_analysis_result(fleet_id, crypto_analysis_result_id, **kwargs)¶

Retrieve the metadata for the result of a Crypto event analysis.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. crypto_analysis_result_id (str) – (required) The OCID of the analysis result. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `CryptoAnalysisResult`
Return type:	`Response`
Example:

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

get_drs_file(fleet_id, drs_file_key, **kwargs)¶

Get the detail about the created DRS file in the Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. drs_file_key (str) – (required) The unique identifier of the DRS File in Object Storage. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `DrsFile`
Return type:	`Response`
Example:

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

get_export_setting(fleet_id, **kwargs)¶

Returns export setting for the specified fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ExportSetting`
Return type:	`Response`
Example:

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

get_export_status(fleet_id, **kwargs)¶

Returns last export status for the specified fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ExportStatus`
Return type:	`Response`
Example:

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

get_fleet(fleet_id, **kwargs)¶

Retrieve a Fleet with the specified identifier.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `Fleet`
Return type:	`Response`
Example:

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

get_fleet_advanced_feature_configuration(fleet_id, **kwargs)¶

Returns Fleet level advanced feature configuration.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `FleetAdvancedFeatureConfiguration`
Return type:	`Response`
Example:

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

get_fleet_agent_configuration(fleet_id, **kwargs)¶

Retrieve a Fleet Agent Configuration for the specified Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `FleetAgentConfiguration`
Return type:	`Response`
Example:

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

get_java_family(family_version, **kwargs)¶

Returns metadata associated with a specific Java release family.

Parameters:	family_version (str) – (required) Unique Java family version identifier. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaFamily`
Return type:	`Response`
Example:

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

get_java_migration_analysis_result(fleet_id, java_migration_analysis_result_id, **kwargs)¶

Retrieve Java Migration Analysis result.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. java_migration_analysis_result_id (str) – (required) The OCID of the analysis result. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaMigrationAnalysisResult`
Return type:	`Response`
Example:

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

get_java_release(release_version, **kwargs)¶

Returns detail of a Java release.

Parameters:	release_version (str) – (required) Unique Java release version identifier opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaRelease`
Return type:	`Response`
Example:

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

get_jms_plugin(jms_plugin_id, **kwargs)¶

Returns the JmsPlugin.

Parameters:	jms_plugin_id (str) – (required) The OCID of the JmsPlugin. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JmsPlugin`
Return type:	`Response`
Example:

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

get_performance_tuning_analysis_result(fleet_id, performance_tuning_analysis_result_id, **kwargs)¶

Retrieve metadata of the Performance Tuning Analysis result.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. performance_tuning_analysis_result_id (str) – (required) The OCID of the performance tuning analysis result. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `PerformanceTuningAnalysisResult`
Return type:	`Response`
Example:

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

get_work_request(work_request_id, **kwargs)¶

Retrieve the details of a work request with the specified ID.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_agent_installers(**kwargs)¶

Returns a list of the agent installer information.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list resources. fleet_id (str) – (optional) The ID of the Fleet. platform_architecture (str) – (optional) The platform architecture for the agent installer. Allowed values are: “X86_64”, “X86”, “AARCH64” os_family (str) – (optional) The OS family for the agent installer. Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort the agent installer. Only one sort order can be provided. Default order for _agentInstallerId_, _osFamily_, _platformArchitecture_ is ascending. If no value is specified _agentInstallerId_ is default. Allowed values are: “agentInstallerId”, “osFamily”, “platformArchitecture” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `AgentInstallerCollection`
Return type:	`Response`
Example:

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

list_announcements(**kwargs)¶

Return a list of AnnouncementSummary items

Parameters:	summary_contains (str) – (optional) Filter the list with summary contains the given value. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort AnnouncementSummary by. Only one sort order may be provided. If no value is specified _timeReleased_ is default. Allowed values are: “timeReleased”, “summary” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `AnnouncementCollection`
Return type:	`Response`
Example:

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

list_blocklists(fleet_id, **kwargs)¶

Returns a list of blocklist entities contained by a fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. operation (str) – (optional) The operation type. Allowed values are: “CREATE_FLEET”, “DELETE_FLEET”, “MOVE_FLEET”, “UPDATE_FLEET”, “UPDATE_FLEET_AGENT_CONFIGURATION”, “DELETE_JAVA_INSTALLATION”, “CREATE_JAVA_INSTALLATION”, “COLLECT_JFR”, “REQUEST_CRYPTO_EVENT_ANALYSIS”, “REQUEST_PERFORMANCE_TUNING_ANALYSIS”, “REQUEST_JAVA_MIGRATION_ANALYSIS”, “DELETE_JMS_REPORT”, “SCAN_JAVA_SERVER_USAGE”, “SCAN_LIBRARY_USAGE”, “EXPORT_DATA_CSV”, “CREATE_DRS_FILE”, “UPDATE_DRS_FILE”, “DELETE_DRS_FILE”, “ENABLE_DRS”, “DISABLE_DRS” managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field used to sort blocklist records. Only one sort order may be provided. Default order for _operation_ is ascending. If no value is specified, _operation_ is default. Allowed values are: “operation” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `BlocklistCollection`
Return type:	`Response`
Example:

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

list_crypto_analysis_results(fleet_id, **kwargs)¶

Lists the results of a Crypto event analysis.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. aggregation_mode (str) – (optional) The aggregation mode of the crypto event analysis result. Allowed values are: “JFR”, “MANAGED_INSTANCE” managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. host_name (str) – (optional) The host OCID of the managed instance. non_compliant_finding_count (int) – (optional) Non Compliant Finding Count of CryptoAnalysis Report. non_compliant_finding_count_greater_than (int) – (optional) Non Compliant Finding Count of CryptoAnalysis Report. finding_count (int) – (optional) FindingCount of CryptoAnalysis Report. finding_count_greater_than (int) – (optional) FindingCount of CryptoAnalysis Report. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort crypto event analysis results. Only one sort order can be provided. Default order for _timeCreated_, and _jreVersion_ is descending. Default order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is ascending. If no value is specified _timeCreated_ is default. Allowed values are: “timeCreated”, “managedInstanceId”, “workRequestId” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `CryptoAnalysisResultCollection`
Return type:	`Response`
Example:

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

list_drs_files(fleet_id, **kwargs)¶

List the details about the created DRS files in the Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field that sorts the DRS details results. Only one sort order can be provided. The default order for _drsFileKey_ is descending. If no value is specified, then _drsFileKey_ is default. Allowed values are: “bucketName”, “namespace”, “drsFileKey”, “drsFileName”, “checksumType”, “isDefault” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `DrsFileCollection`
Return type:	`Response`
Example:

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

list_fleet_diagnoses(fleet_id, **kwargs)¶

List potential diagnoses that would put a fleet into FAILED or NEEDS_ATTENTION lifecycle state.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `FleetDiagnosisCollection`
Return type:	`Response`
Example:

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

list_fleets(**kwargs)¶

Returns a list of all the Fleets contained by a compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list resources. id (str) – (optional) The ID. lifecycle_state (str) – (optional) The state of the lifecycle. Allowed values are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “NEEDS_ATTENTION”, “UPDATING” display_name (str) – (optional) The display name. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort Fleets. Only one sort order may be provided. Default order for _timeCreated_, _approximateJreCount_, _approximateInstallationCount_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _displayName_ is ascending. If no value is specified _timeCreated_ is default. Allowed values are: “displayName”, “timeCreated” opc_request_id (str) – (optional) The client request ID for tracing. display_name_contains (str) – (optional) Filter the list with displayName contains the given value. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `FleetCollection`
Return type:	`Response`
Example:

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

list_installation_sites(fleet_id, **kwargs)¶

List Java installation sites in a Fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. jre_vendor (str) – (optional) The vendor of the related Java Runtime. jre_distribution (str) – (optional) The distribution of the related Java Runtime. jre_version (str) – (optional) The version of the related Java Runtime. installation_path (str) – (optional) The file system path of the installation. application_id (str) – (optional) The Fleet-unique identifier of the related application. managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort installation sites. Only one sort order may be provided. Default order for _timeLastSeen_, and _jreVersion_, _approximateApplicationCount_ is descending. Default order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is ascending. If no value is specified _managedInstanceId_ is default. Allowed values are: “managedInstanceId”, “jreDistribution”, “jreVendor”, “jreVersion”, “path”, “approximateApplicationCount”, “osName”, “securityStatus” opc_request_id (str) – (optional) The client request ID for tracing. os_family (list[str]) – (optional) The operating system type. Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN” jre_security_status (str) – (optional) The security status of the Java Runtime. Allowed values are: “EARLY_ACCESS”, “UNKNOWN”, “UP_TO_DATE”, “UPDATE_REQUIRED”, “UPGRADE_REQUIRED” path_contains (str) – (optional) Filter the list with path contains the given value. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `InstallationSiteCollection`
Return type:	`Response`
Example:

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

list_java_families(**kwargs)¶

Returns a list of the Java release family information. A Java release family is typically a major version in the Java version identifier.

Parameters:	family_version (str) – (optional) The version identifier for the Java family. display_name (str) – (optional) The display name for the Java family. is_supported_version (bool) – (optional) Filter the Java Release Family versions by support status. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) If no value is specified _familyVersion_ is default. Allowed values are: “familyVersion”, “endOfSupportLifeDate”, “supportType” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaFamilyCollection`
Return type:	`Response`
Example:

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

list_java_migration_analysis_results(fleet_id, **kwargs)¶

Lists the results of a Java migration analysis.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. host_name (str) – (optional) The host OCID of the managed instance. application_name (str) – (optional) The name of the application. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field that sorts the Java migration analysis results. Only one sort order can be provided. The default order for _timeCreated_, _managedInstanceId_ and _workRequestId_ is descending. If no value is specified, then _timeCreated_ is default. Allowed values are: “timeCreated”, “managedInstanceId”, “workRequestId” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaMigrationAnalysisResultCollection`
Return type:	`Response`
Example:

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

list_java_releases(**kwargs)¶

Returns a list of Java releases.

Parameters:	release_version (str) – (optional) Unique Java release version identifier family_version (str) – (optional) The version identifier for the Java family. release_type (str) – (optional) Java release type. Allowed values are: “CPU”, “FEATURE”, “BPR”, “PATCH_RELEASE” jre_security_status (str) – (optional) The security status of the Java Runtime. Allowed values are: “EARLY_ACCESS”, “UNKNOWN”, “UP_TO_DATE”, “UPDATE_REQUIRED”, “UPGRADE_REQUIRED” license_type (str) – (optional) Java license type. Allowed values are: “OTN”, “NFTC”, “RESTRICTED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) If no value is specified _releaseDate_ is default. Allowed values are: “releaseDate”, “releaseVersion”, “familyVersion”, “licenseType” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaReleaseCollection`
Return type:	`Response`
Example:

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

list_jms_plugins(**kwargs)¶

Lists the JmsPlugins.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list resources. compartment_id_in_subtree (bool) – (optional) Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments. id (str) – (optional) The OCID of the JmsPlugin. fleet_id (str) – (optional) The ID of the Fleet. agent_id (str) – (optional) The ManagementAgent (OMA) or Instance (OCA) OCID that identifies the Agent. lifecycle_state (str) – (optional) Filter JmsPlugin with its lifecycle state. Allowed values are: “ACTIVE”, “INACTIVE”, “NEEDS_ATTENTION”, “DELETED” availability_status (str) – (optional) Filter JmsPlugin with its availability status. Allowed values are: “ACTIVE”, “SILENT”, “NOT_AVAILABLE” time_registered_less_than_or_equal_to (datetime) – (optional) If present, only plugins with a registration time before this parameter are searched (formatted according to RFC3339). time_last_seen_less_than_or_equal_to (datetime) – (optional) If present, only plugins with a last seen time before this parameter are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort JmsPlugin. Only one sort order may be provided. Default order is descending. If no value is specified _timeLastSeen_ is default. Allowed values are: “id”, “timeLastSeen”, “timeRegistered”, “hostname”, “agentId”, “agentType”, “lifecycleState”, “availabilityStatus”, “fleetId”, “compartmentId”, “osFamily”, “osArchitecture”, “osDistribution”, “pluginVersion” hostname_contains (str) – (optional) Filter the list with hostname contains the given value. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JmsPluginCollection`
Return type:	`Response`
Example:

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

list_jre_usage(**kwargs)¶

List Java Runtime usage in a specified host filtered by query parameters.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list resources. host_id (str) – (optional) The host OCID of the managed instance. application_id (str) – (optional) The Fleet-unique identifier of the application. application_name (str) – (optional) The name of the application. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort JRE usages. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, and _version_ is descending. Default order for _timeFirstSeen_, _timeLastSeen_, _version_, _approximateInstallationCount_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _distribution_, _vendor_, and _osName_ is ascending. If no value is specified _timeLastSeen_ is default. Allowed values are: “distribution”, “timeFirstSeen”, “timeLastSeen”, “vendor”, “version”, “approximateInstallationCount”, “approximateApplicationCount”, “approximateManagedInstanceCount”, “osName”, “securityStatus” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JreUsageCollection`
Return type:	`Response`
Example:

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

list_performance_tuning_analysis_results(fleet_id, **kwargs)¶

List Performance Tuning Analysis results.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. application_id (str) – (optional) The Fleet-unique identifier of the related application. host_name (str) – (optional) The host OCID of the managed instance. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort performance tuning analysis results. Only one sort order may be provided. Default order for _timeCreated_, and _jreVersion_ is descending. Default order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is ascending. If no value is specified _timeCreated_ is default. Allowed values are: “timeCreated”, “managedInstanceId”, “workRequestId”, “warningCount” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `PerformanceTuningAnalysisResultCollection`
Return type:	`Response`
Example:

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

list_work_items(work_request_id, **kwargs)¶

Retrieve a paginated list of work items for a specified work request.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `WorkItemCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Retrieve a (paginated) list of errors for a specified work request.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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)¶

Retrieve a paginated list of logs for a specified work request.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_requests(**kwargs)¶

List the work requests in a compartment. The query parameter compartmentId is required unless the query parameter id or fleetId is specified.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list resources. id (str) – (optional) The ID of an asynchronous work request. fleet_id (str) – (optional) The OCID of the fleet. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. managed_instance_id (str) – (optional) The Fleet-unique identifier of the managed instance. operation_type (str) – (optional) The operation type of the work request. Allowed values are: “CREATE_FLEET”, “DELETE_FLEET”, “MOVE_FLEET”, “UPDATE_FLEET”, “UPDATE_FLEET_AGENT_CONFIGURATION”, “DELETE_JAVA_INSTALLATION”, “CREATE_JAVA_INSTALLATION”, “COLLECT_JFR”, “REQUEST_CRYPTO_EVENT_ANALYSIS”, “REQUEST_PERFORMANCE_TUNING_ANALYSIS”, “REQUEST_JAVA_MIGRATION_ANALYSIS”, “DELETE_JMS_REPORT”, “SCAN_JAVA_SERVER_USAGE”, “SCAN_LIBRARY_USAGE”, “EXPORT_DATA_CSV”, “CREATE_DRS_FILE”, “UPDATE_DRS_FILE”, “DELETE_DRS_FILE”, “ENABLE_DRS”, “DISABLE_DRS” status (list[str]) – (optional) The status of the work request. Allowed values are: “ACCEPTED”, “CANCELED”, “CANCELING”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `WorkRequestCollection`
Return type:	`Response`
Example:

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

remove_fleet_installation_sites(fleet_id, remove_fleet_installation_sites_details, **kwargs)¶

Remove Java installation sites in a Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. remove_fleet_installation_sites_details (oci.jms.models.RemoveFleetInstallationSitesDetails) – (required) List of installation sites to be deleted. 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_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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 remove_fleet_installation_sites API.

request_crypto_analyses(fleet_id, request_crypto_analyses_details, **kwargs)¶

Request to perform crypto analysis on one or more selected targets in the Fleet. The result of the crypto analysis will be uploaded to the object storage bucket created by JMS on enabling the Crypto Event Analysis feature in the Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. request_crypto_analyses_details (oci.jms.models.RequestCryptoAnalysesDetails) – (required) Detail information to start Crypto Analyses opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 request_crypto_analyses API.

request_deployed_application_migration_analyses(fleet_id, request_deployed_application_migration_analyses_details, **kwargs)¶

Request to perform a deployed Java migration analyses. The results of the deployed Java migration analyses will be uploaded to the Object Storage bucket that you designate when you enable the Java Migration Analyses feature.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. request_deployed_application_migration_analyses_details (oci.jms.models.RequestDeployedApplicationMigrationAnalysesDetails) – (required) Detail information that starts the deployed Java migration analyses opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 request_deployed_application_migration_analyses API.

request_java_migration_analyses(fleet_id, request_java_migration_analyses_details, **kwargs)¶

Request to perform a Java migration analysis. The results of the Java migration analysis will be uploaded to the Object Storage bucket that you designate when you enable the Java Migration Analysis feature.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. request_java_migration_analyses_details (oci.jms.models.RequestJavaMigrationAnalysesDetails) – (required) Detail information that starts the Java migration analysis opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 request_java_migration_analyses API.

request_jfr_recordings(fleet_id, request_jfr_recordings_details, **kwargs)¶

Request to collect the JFR recordings on the selected target in the Fleet. The JFR files are uploaded to the object storage bucket created by JMS on enabling Generic JFR feature in the Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. request_jfr_recordings_details (oci.jms.models.RequestJfrRecordingsDetails) – (required) Detail information to start JFR recordings. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 request_jfr_recordings API.

request_performance_tuning_analyses(fleet_id, request_performance_tuning_analyses_details, **kwargs)¶

Request to perform performance tuning analyses. The result of performance tuning analysis will be uploaded to the object storage bucket that you designated when you enabled the recording feature.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. request_performance_tuning_analyses_details (oci.jms.models.RequestPerformanceTuningAnalysesDetails) – (required) Detail information to start Performance Tuning Analyses opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 request_performance_tuning_analyses API.

scan_java_server_usage(fleet_id, scan_java_server_usage_details, **kwargs)¶

Scan Java Server usage in a fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. scan_java_server_usage_details (oci.jms.models.ScanJavaServerUsageDetails) – (required) List of managed instances to be scanned. 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_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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 scan_java_server_usage API.

scan_library_usage(fleet_id, scan_library_usage_details, **kwargs)¶

Scan library usage in a fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. scan_library_usage_details (oci.jms.models.ScanLibraryUsageDetails) – (required) List of managed instances to be scanned. 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_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 might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 scan_library_usage API.

summarize_application_installation_usage(fleet_id, **kwargs)¶

Summarizes the application installation usage in a Fleet filtered by query parameters. In contrast to SummarizeApplicationUsage, which provides only information aggregated by application name, this operation provides installation details. This allows for better focusing of actions.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. application_installation_key (str) – (optional) The Fleet-unique identifier of the application installation. application_id (str) – (optional) The Fleet-unique identifier of the application. display_name (str) – (optional) The display name. display_name_contains (str) – (optional) Filter the list with displayName contains the given value. application_type (str) – (optional) The type of the application. app_installation_path_contains (str) – (optional) Filter the list with the application installation path that contains the given value. jre_vendor (str) – (optional) The vendor of the related Java Runtime. jre_distribution (str) – (optional) The distribution of the related Java Runtime. jre_version (str) – (optional) The version of the related Java Runtime. installation_path (str) – (optional) The file system path of the Java Runtime installation. library_key (str) – (optional) The library key. managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. os_family (list[str]) – (optional) The operating system type. Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN” time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort application installation views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, _approximateJreCount_, _approximateInstallationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _displayName_, _installationPath_ and _osName_ is ascending. If no value is specified _timeLastSeen_ is default. Allowed values are: “timeFirstSeen”, “timeLastSeen”, “displayName”, “installationPath”, “osName”, “approximateJreCount”, “approximateInstallationCount”, “approximateManagedInstanceCount”, “approximateLibraryCount” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ApplicationInstallationUsageSummaryCollection`
Return type:	`Response`
Example:

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

summarize_application_usage(fleet_id, **kwargs)¶

List application usage in a Fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. application_id (str) – (optional) The Fleet-unique identifier of the application. display_name (str) – (optional) The display name. application_type (str) – (optional) The type of the application. jre_vendor (str) – (optional) The vendor of the related Java Runtime. jre_distribution (str) – (optional) The distribution of the related Java Runtime. jre_version (str) – (optional) The version of the related Java Runtime. installation_path (str) – (optional) The file system path of the Java Runtime installation. managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. fields (list[str]) – (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateJreCount’, ‘approximateInstallationCount’ and ‘approximateManagedInstanceCount’. For example ‘approximateJreCount,approximateInstallationCount’. Allowed values are: “approximateJreCount”, “approximateInstallationCount”, “approximateManagedInstanceCount” time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort application views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, _approximateJreCount_, _approximateInstallationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _displayName_ and _osName_ is ascending. If no value is specified _timeLastSeen_ is default. Allowed values are: “timeFirstSeen”, “timeLastSeen”, “displayName”, “approximateJreCount”, “approximateInstallationCount”, “approximateManagedInstanceCount”, “approximateLibraryCount”, “osName” opc_request_id (str) – (optional) The client request ID for tracing. os_family (list[str]) – (optional) The operating system type. Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN” display_name_contains (str) – (optional) Filter the list with displayName contains the given value. library_key (str) – (optional) The library key. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ApplicationUsageCollection`
Return type:	`Response`
Example:

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

summarize_deployed_application_installation_usage(fleet_id, **kwargs)¶

Summarize installation usage of an application deployed on Java servers in a fleet filtered by query parameters. In contrast to SummarizeDeployedApplicationUsage, which provides only information aggregated by the deployment information, this operation provides installation details and allows for better focusing of actions.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. server_key (str) – (optional) The server key. server_instance_key (str) – (optional) The Java Server instance key. managed_instance_id (str) – (optional) The Fleet-unique identifier of the managed instance. application_installation_key (str) – (optional) The deployed application installation key. application_key (str) – (optional) The deployed application key. application_name_contains (str) – (optional) Filter the list with deployed application name contains the given value. application_name (str) – (optional) The deployed application name. application_source_path_contains (str) – (optional) Filter the list with application source path contains the given value. library_key (str) – (optional) The library key. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort the deployed application installations. Only one sort order can be provided. If no value is specified _timeLastSeen_ is default. Allowed values are: “applicationName”, “applicationType”, “applicationSourcePath”, “isClustered”, “javaServerInstanceCount”, “approximateJavaServerInstanceCount”, “approximateLibraryCount”, “timeFirstSeen”, “timeLastSeen” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `DeployedApplicationInstallationUsageSummaryCollection`
Return type:	`Response`
Example:

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

summarize_deployed_application_usage(fleet_id, **kwargs)¶

List of deployed applications in a Fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. server_key (str) – (optional) The server key. server_instance_key (str) – (optional) The Java Server instance key. managed_instance_id (str) – (optional) The Fleet-unique identifier of the managed instance. library_key (str) – (optional) The library key. application_key (str) – (optional) The deployed application key. application_name_contains (str) – (optional) Filter the list with deployed application name contains the given value. application_name (str) – (optional) The deployed application name. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort the deployed applications. Only one sort order can be provided. If no value is specified _timeLastSeen_ is default. Allowed values are: “applicationName”, “applicationType”, “isClustered”, “javaServerInstanceCount”, “approximateJavaServerInstanceCount”, “approximateLibraryCount”, “timeFirstSeen”, “timeLastSeen” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `DeployedApplicationUsageCollection`
Return type:	`Response`
Example:

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

summarize_installation_usage(fleet_id, **kwargs)¶

List Java installation usage in a Fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. jre_vendor (str) – (optional) The vendor of the related Java Runtime. jre_distribution (str) – (optional) The distribution of the related Java Runtime. jre_version (str) – (optional) The version of the related Java Runtime. installation_path (str) – (optional) The file system path of the installation. application_id (str) – (optional) The Fleet-unique identifier of the related application. managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. fields (list[str]) – (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateApplicationCount’ and ‘approximateManagedInstanceCount’. For example ‘approximateApplicationCount,approximateManagedInstanceCount’. Allowed values are: “approximateApplicationCount”, “approximateManagedInstanceCount” time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort installation views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, and _jreVersion_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _jreDistribution_ and _jreVendor_ is ascending. If no value is specified _timeLastSeen_ is default. Allowed values are: “jreDistribution”, “jreVendor”, “jreVersion”, “path”, “timeFirstSeen”, “timeLastSeen”, “approximateApplicationCount”, “approximateManagedInstanceCount”, “osName” opc_request_id (str) – (optional) The client request ID for tracing. os_family (list[str]) – (optional) The operating system type. Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN” path_contains (str) – (optional) Filter the list with path contains the given value. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `InstallationUsageCollection`
Return type:	`Response`
Example:

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

summarize_java_server_instance_usage(fleet_id, **kwargs)¶

List Java Server instances in a fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. server_key (str) – (optional) The server key. server_instance_key (str) – (optional) The Java Server instance key. managed_instance_id (str) – (optional) The Fleet-unique identifier of the managed instance. application_key (str) – (optional) The deployed application key. library_key (str) – (optional) The library key. server_instance_name_contains (str) – (optional) Filter the list with the Java Server instance name contains the given value. server_instance_name (str) – (optional) The Java Server instance name. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort the Java Server instances. Only one sort order can be provided. If no value is specified _timeLastSeen_ is default. Allowed values are: “serverInstanceName”, “managedInstanceName”, “approximateDeployedApplicationCount”, “timeFirstSeen”, “timeLastSeen” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaServerInstanceUsageCollection`
Return type:	`Response`
Example:

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

summarize_java_server_usage(fleet_id, **kwargs)¶

List of Java servers in a Fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. server_key (str) – (optional) The server key. server_name_contains (str) – (optional) Filter the list with server name contains the given value. server_name (str) – (optional) The server name. server_version (str) – (optional) The server version. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort a Java Server. Only one sort order can be provided. If no value is specified _timeLastSeen_ is default. Allowed values are: “serverName”, “serverVersion”, “serverInstanceCount”, “approximateDeployedApplicationCount”, “timeFirstSeen”, “timeLastSeen” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JavaServerUsageCollection`
Return type:	`Response`
Example:

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

summarize_jre_usage(fleet_id, **kwargs)¶

List Java Runtime usage in a specified Fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. jre_id (str) – (optional) The Fleet-unique identifier of the related Java Runtime. jre_vendor (str) – (optional) The vendor of the Java Runtime. jre_distribution (str) – (optional) The distribution of the Java Runtime. jre_version (str) – (optional) The version of the Java Runtime. application_id (str) – (optional) The Fleet-unique identifier of the related application. managed_instance_id (str) – (optional) The Fleet-unique identifier of the related managed instance. fields (list[str]) – (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateApplicationCount’, ‘approximateInstallationCount’ and ‘approximateManagedInstanceCount’. For example ‘approximateApplicationCount,approximateManagedInstanceCount’. Allowed values are: “approximateInstallationCount”, “approximateApplicationCount”, “approximateManagedInstanceCount” time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort JRE usages. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, and _version_ is descending. Default order for _timeFirstSeen_, _timeLastSeen_, _version_, _approximateInstallationCount_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _distribution_, _vendor_, and _osName_ is ascending. If no value is specified _timeLastSeen_ is default. Allowed values are: “distribution”, “timeFirstSeen”, “timeLastSeen”, “vendor”, “version”, “approximateInstallationCount”, “approximateApplicationCount”, “approximateManagedInstanceCount”, “osName”, “securityStatus” opc_request_id (str) – (optional) The client request ID for tracing. os_family (list[str]) – (optional) The operating system type. Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN” jre_security_status (str) – (optional) The security status of the Java Runtime. Allowed values are: “EARLY_ACCESS”, “UNKNOWN”, “UP_TO_DATE”, “UPDATE_REQUIRED”, “UPGRADE_REQUIRED” 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JreUsageCollection`
Return type:	`Response`
Example:

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

summarize_library_usage(fleet_id, **kwargs)¶

List libraries in a fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. server_instance_key (str) – (optional) The Java Server instance key. managed_instance_id (str) – (optional) The Fleet-unique identifier of the managed instance. application_key (str) – (optional) The deployed application key. library_key (str) – (optional) The library key. library_name_contains (str) – (optional) Filter the list with library name contains the given value. library_name (str) – (optional) The library name. cvss_score_greater_than (int) – (optional) Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis. cvss_score_less_than (int) – (optional) Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort libraries. Only one sort order may be provided. If no value is specified _timeLastSeen_ is default. Allowed values are: “applicationCount”, “javaServerInstanceCount”, “cvssScore”, “deployedApplicationCount”, “libraryName”, “libraryVersion”, “managedInstanceCount”, “timeFirstSeen”, “timeLastSeen” opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `LibraryUsageCollection`
Return type:	`Response`
Example:

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

summarize_managed_instance_usage(fleet_id, **kwargs)¶

List managed instance usage in a Fleet filtered by query parameters.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. managed_instance_id (str) – (optional) The Fleet-unique identifier of the managed instance. managed_instance_type (str) – (optional) The type of the managed instance. Allowed values are: “ORACLE_MANAGEMENT_AGENT”, “ORACLE_CLOUD_AGENT” jre_vendor (str) – (optional) The vendor of the related Java Runtime. jre_distribution (str) – (optional) The distribution of the related Java Runtime. jre_version (str) – (optional) The version of the related Java Runtime. installation_path (str) – (optional) The file system path of the Java Runtime installation. application_id (str) – (optional) The Fleet-unique identifier of the related application. fields (list[str]) – (optional) Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateJreCount’, ‘approximateInstallationCount’ and ‘approximateApplicationCount’. For example ‘approximateJreCount,approximateInstallationCount’. Allowed values are: “approximateJreCount”, “approximateInstallationCount”, “approximateApplicationCount” time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort managed instance views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, approximateJreCount_, _approximateInstallationCount_ and _approximateApplicationCount_ is descending. Default order for _osName_ is ascending. If no value is specified _timeLastSeen_ is default. Allowed values are: “timeFirstSeen”, “timeLastSeen”, “approximateJreCount”, “approximateInstallationCount”, “approximateApplicationCount”, “osName” opc_request_id (str) – (optional) The client request ID for tracing. os_family (list[str]) – (optional) The operating system type. Allowed values are: “LINUX”, “WINDOWS”, “MACOS”, “UNKNOWN” hostname_contains (str) – (optional) Filter the list with hostname contains the given value. library_key (str) – (optional) The library key. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ManagedInstanceUsageCollection`
Return type:	`Response`
Example:

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

summarize_resource_inventory(**kwargs)¶

Retrieve the inventory of JMS resources in the specified compartment: a list of the number of _active_ fleets, managed instances, Java Runtimes, Java installations, and applications.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment in which to list resources. time_start (datetime) – (optional) The start of the time period during which resources are searched (formatted according to RFC3339). time_end (datetime) – (optional) The end of the time period during which resources are searched (formatted according to RFC3339). opc_request_id (str) – (optional) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ResourceInventory`
Return type:	`Response`
Example:

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

update_drs_file(fleet_id, update_drs_file_details, drs_file_key, **kwargs)¶

Request to perform validation of the DRS file and update the existing file in the Object Storage.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. update_drs_file_details (oci.jms.models.UpdateDrsFileDetails) – (required) Detail information to update DRS drs_file_key (str) – (required) The unique identifier of the DRS File in Object Storage. opc_request_id (str) – (optional) The client request ID for tracing. 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_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 might 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 update_drs_file API.

update_export_setting(fleet_id, update_export_setting_details, **kwargs)¶

Updates existing export setting for the specified fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. update_export_setting_details (oci.jms.models.UpdateExportSettingDetails) – (required) The new details for the export setting. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ExportSetting`
Return type:	`Response`
Example:

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

update_fleet(fleet_id, update_fleet_details, **kwargs)¶

Update the Fleet specified by an identifier.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. update_fleet_details (oci.jms.models.UpdateFleetDetails) – (required) The new details for the Fleet. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 update_fleet API.

update_fleet_advanced_feature_configuration(fleet_id, update_fleet_advanced_feature_configuration_details, **kwargs)¶

Update advanced feature configurations for the Fleet. Ensure that the namespace and bucket storage are created prior to turning on the JfrRecording or CryptoEventAnalysis feature.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. update_fleet_advanced_feature_configuration_details (oci.jms.models.UpdateFleetAdvancedFeatureConfigurationDetails) – (required) Update advanced feature configurations with new fields. 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 might be rejected. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `FleetAdvancedFeatureConfiguration`
Return type:	`Response`
Example:

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

update_fleet_agent_configuration(fleet_id, update_fleet_agent_configuration_details, **kwargs)¶

Update the Fleet Agent Configuration for the specified Fleet.

Parameters:	fleet_id (str) – (required) The OCID of the Fleet. update_fleet_agent_configuration_details (oci.jms.models.UpdateFleetAgentConfigurationDetails) – (required) The new details for the Fleet Agent Configuration. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 update_fleet_agent_configuration API.

update_jms_plugin(jms_plugin_id, update_jms_plugin_details, **kwargs)¶

Updates the Fleet of a JmsPlugin.

Parameters:	jms_plugin_id (str) – (required) The OCID of the JmsPlugin. update_jms_plugin_details (oci.jms.models.UpdateJmsPluginDetails) – (required) The new details for the JmsPlugin. 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) The client request ID for tracing. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `JmsPlugin`
Return type:	`Response`
Example:

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