oracle.oci.oci_jms_fleet_actions – Perform actions on a Fleet resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_jms_fleet_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a Fleet resource in Oracle Cloud Infrastructure

  • For action=change_compartment, move a specified Fleet into the compartment identified in the POST form. When provided, If-Match is checked against ETag values of the resource.

  • For action=generate_agent_deploy_script, generates Agent Deploy Script for Fleet using the information provided.

  • For action=request_crypto_analyses, request to perform crypto analyses. The result of crypto analysis will be uploaded to the object storage bucket desiginated when enable Crypto Event Analysis feature.

  • For action=request_jfr_recordings, request to collect the JFR recordings on the selected target. The JFR files are uploaded to the object storage bucket that you designated when you enabled the recording feature.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
  • generate_agent_deploy_script
  • request_crypto_analyses
  • request_jfr_recordings
The action to perform on the Fleet.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment into which the Fleet should be moved.
Required for action=change_compartment.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
dest
string
The destination file path to write the output. The file will be created if it does not exist. If the file already exists, the content will be overwritten.
Required for action=generate_agent_deploy_script.
fleet_id
string / required
The OCID of the Fleet.

aliases: id
install_key_id
string
The OCID of the install key for which to generate the script.
Required for action=generate_agent_deploy_script.
is_user_name_enabled
boolean
    Choices:
  • no
  • yes
Enable/disable user name collection on agent.
Required for action=generate_agent_deploy_script.
jfc_profile_name
string
The profile used for JFR events selection. If the name isn't recognized, the settings from jfcV1 or jfcV2 will be used depending on the JVM version. Both jfcV2 and jfcV1 should be provided to ensure JFR collection on different JVM versions.
Required for action=request_jfr_recordings.
jfc_v1
string
The BASE64 encoded string of JFR settings XML with schema used by JDK 8.
Applicable only for action=request_jfr_recordings.
jfc_v2
string
The BASE64 encoded string of JFR settings XML with schema used by JDK 9 and after.
Applicable only for action=request_jfr_recordings.
os_family
string
    Choices:
  • LINUX
  • WINDOWS
  • MACOS
  • UNKNOWN
The operating system type for the script. Currently only 'LINUX' and 'WINDOWS' are supported.
Required for action=generate_agent_deploy_script.
recording_duration_in_minutes
integer
Duration of the JFR recording in minutes.
Applicable only for action=request_crypto_analysesaction=request_jfr_recordings.
recording_size_in_mb
integer
The maximum size limit for the JFR file collected.
Applicable only for action=request_jfr_recordings.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
targets
list / elements=dictionary
The attachment targets to start JFR.
Applicable only for action=request_crypto_analysesaction=request_jfr_recordings.
application_key
string
Unique key that identify the application for JFR data collection.
jre_key
string
Unique key that identify the JVM for JFR data collection.
managed_instance_id
string / required
OCID of the Managed Instance to collect JFR data.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Perform action change_compartment on fleet
  oci_jms_fleet_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    fleet_id: "ocid1.fleet.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action generate_agent_deploy_script on fleet
  oci_jms_fleet_actions:
    # required
    dest: /tmp/myfile
    install_key_id: "ocid1.installkey.oc1..xxxxxxEXAMPLExxxxxx"
    os_family: LINUX
    is_user_name_enabled: true
    fleet_id: "ocid1.fleet.oc1..xxxxxxEXAMPLExxxxxx"
    action: generate_agent_deploy_script

- name: Perform action request_crypto_analyses on fleet
  oci_jms_fleet_actions:
    # required
    fleet_id: "ocid1.fleet.oc1..xxxxxxEXAMPLExxxxxx"
    action: request_crypto_analyses

    # optional
    targets:
    - # required
      managed_instance_id: "ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      application_key: application_key_example
      jre_key: jre_key_example
    recording_duration_in_minutes: 56

- name: Perform action request_jfr_recordings on fleet
  oci_jms_fleet_actions:
    # required
    fleet_id: "ocid1.fleet.oc1..xxxxxxEXAMPLExxxxxx"
    jfc_profile_name: jfc_profile_name_example
    action: request_jfr_recordings

    # optional
    targets:
    - # required
      managed_instance_id: "ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      application_key: application_key_example
      jre_key: jre_key_example
    jfc_v1: jfc_v1_example
    jfc_v2: jfc_v2_example
    recording_duration_in_minutes: 56
    recording_size_in_mb: 56

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
fleet
complex
on success
Details of the Fleet resource acted upon by the current operation

Sample:
{'approximate_application_count': 56, 'approximate_installation_count': 56, 'approximate_java_server_count': 56, 'approximate_jre_count': 56, 'approximate_managed_instance_count': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'inventory_log': {'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_id': 'ocid1.log.oc1..xxxxxxEXAMPLExxxxxx'}, 'is_advanced_features_enabled': True, 'lifecycle_state': 'ACTIVE', 'operation_log': {'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_id': 'ocid1.log.oc1..xxxxxxEXAMPLExxxxxx'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00'}
 
approximate_application_count
integer
on success
The approximate count of all unique applications in the Fleet in the past seven days. This metric is provided on a best-effort manner, and is not taken into account when computing the resource ETag.

Sample:
56
 
approximate_installation_count
integer
on success
The approximate count of all unique Java installations in the Fleet in the past seven days. This metric is provided on a best-effort manner, and is not taken into account when computing the resource ETag.

Sample:
56
 
approximate_java_server_count
integer
on success
The approximate count of all unique Java servers in the Fleet in the past seven days. This metric is provided on a best-effort manner, and is not taken into account when computing the resource ETag.

Sample:
56
 
approximate_jre_count
integer
on success
The approximate count of all unique Java Runtimes in the Fleet in the past seven days. This metric is provided on a best-effort manner, and is not taken into account when computing the resource ETag.

Sample:
56
 
approximate_managed_instance_count
integer
on success
The approximate count of all unique managed instances in the Fleet in the past seven days. This metric is provided on a best-effort manner, and is not taken into account when computing the resource ETag.

Sample:
56
 
compartment_id
string
on success
The OCID of the compartment of the Fleet.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. (See Understanding Free-form Tags).

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
The Fleet's description.

Sample:
description_example
 
display_name
string
on success
The name of the Fleet.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. (See Managing Tags and Tag Namespaces.)

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the Fleet.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
inventory_log
complex
on success

   
log_group_id
string
on success
The OCID of the log group.

Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
   
log_id
string
on success
The OCID of the log.

Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
 
is_advanced_features_enabled
boolean
on success
Whether or not advanced features are enabled in this fleet. Deprecated, use `/fleets/{fleetId}/advanceFeatureConfiguration` api instead.

Sample:
True
 
lifecycle_state
string
on success
The lifecycle state of the Fleet.

Sample:
ACTIVE
 
operation_log
complex
on success

   
log_group_id
string
on success
The OCID of the log group.

Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
   
log_id
string
on success
The OCID of the log.

Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The creation date and time of the Fleet (formatted according to RFC3339).

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)