oracle.oci.oci_jms_fleet – Manage a Fleet resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Fleet resource in Oracle Cloud Infrastructure

  • For state=present, 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.

  • This resource has the following action operations in the oracle.oci.oci_jms_fleet_actions module: change_compartment, disable_drs, enable_drs, generate_agent_deploy_script, request_crypto_analyses, request_java_migration_analyses, request_jfr_recordings, request_performance_tuning_analyses.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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
  • security_token
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 of the Fleet.
Required for create using state=present.
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.
defined_tags
dictionary
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).
This parameter is updatable.
description
string
The Fleet's description. If nothing is provided, the Fleet description will be null.
This parameter is updatable.
display_name
string
The name of the Fleet. The displayName must be unique for Fleets in the same compartment.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
fleet_id
string
The OCID of the Fleet.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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.)
This parameter is updatable.
inventory_log
dictionary
Required for create using state=present.
This parameter is updatable.
log_group_id
string / required
The OCID of the log group.
log_id
string / required
The OCID of the log.
is_advanced_features_enabled
boolean
    Choices:
  • no
  • yes
Whether or not advanced features are enabled in this Fleet. Deprecated, use `/fleets/{fleetId}/advanceFeatureConfiguration` API instead.
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
operation_log
dictionary
This parameter is updatable.
log_group_id
string / required
The OCID of the log group.
log_id
string / required
The OCID of the log.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the Fleet.
Use state=present to create or update a Fleet.
Use state=absent to delete a Fleet.
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: Create fleet
  oci_jms_fleet:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    inventory_log:
      # required
      log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
      log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    description: description_example
    operation_log:
      # required
      log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
      log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
    is_advanced_features_enabled: true
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Update fleet
  oci_jms_fleet:
    # required
    fleet_id: "ocid1.fleet.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    inventory_log:
      # required
      log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
      log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
    operation_log:
      # required
      log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
      log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
    is_advanced_features_enabled: true
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Update fleet using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_jms_fleet:
    # required
    display_name: display_name_example

    # optional
    description: description_example
    inventory_log:
      # required
      log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
      log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
    operation_log:
      # required
      log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
      log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
    is_advanced_features_enabled: true
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Delete fleet
  oci_jms_fleet:
    # required
    fleet_id: "ocid1.fleet.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete fleet using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_jms_fleet:
    # required
    display_name: display_name_example
    state: absent

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, 'is_export_setting_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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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
 
is_export_setting_enabled
boolean
on success
Whether or not export setting is enabled in this Fleet.

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)