oracle.oci.oci_stack_monitoring_discovery_job – Manage a DiscoveryJob resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, aPI to create discovery Job and submit discovery Details to agent.

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
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 Compartment
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"}}`
discovery_client
string
Client who submits discovery job.
discovery_details
dictionary
Required for create using state=present.
agent_id
string / required
The OCID of Management Agent
credentials
dictionary
items
list / elements=dictionary / required
List of DiscoveryJob credentials.
credential_name
string / required
Name of Credential
credential_type
string / required
Name of Credential Type
properties
dictionary / required
properties_map
dictionary
Key/Value pair of Property
properties
dictionary / required
properties_map
dictionary
Key/Value pair of Property
resource_name
string / required
The Name of resource type
resource_type
string / required
    Choices:
  • WEBLOGIC_DOMAIN
  • EBS_INSTANCE
  • SQL_SERVER
  • APACHE_TOMCAT
  • ORACLE_DATABASE
  • OCI_ORACLE_DB
  • OCI_ORACLE_CDB
  • OCI_ORACLE_PDB
  • HOST
  • ORACLE_PSFT
Resource Type.
tags
dictionary
properties_map
dictionary
Key/Value pair of Property
discovery_job_id
string
The Discovery Job ID
Required for delete using state=absent.

aliases: id
discovery_type
string
    Choices:
  • ADD
  • ADD_WITH_RETRY
  • REFRESH
Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.
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"}`
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.
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 DiscoveryJob.
Use state=present to create a DiscoveryJob.
Use state=absent to delete a DiscoveryJob.
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 discovery_job
  oci_stack_monitoring_discovery_job:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    discovery_details:
      # required
      agent_id: "ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx"
      resource_type: WEBLOGIC_DOMAIN
      resource_name: resource_name_example
      properties:
        # optional
        properties_map: null
        # optional
      credentials:
        # required
        items:
        - # required
          credential_name: credential_name_example
          credential_type: credential_type_example
          properties:
            # optional
            properties_map: null
      tags:
        # optional
        properties_map: null

    # optional
    discovery_type: ADD
    discovery_client: discovery_client_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete discovery_job
  oci_stack_monitoring_discovery_job:
    # required
    discovery_job_id: "ocid1.discoveryjob.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
discovery_job
complex
on success
Details of the DiscoveryJob resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'discovery_client': 'discovery_client_example', 'discovery_details': {'agent_id': 'ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx', 'credentials': {'items': [{'credential_name': 'credential_name_example', 'credential_type': 'credential_type_example', 'properties': {'properties_map': {}}}]}, 'properties': {'properties_map': {}}, 'resource_name': 'resource_name_example', 'resource_type': 'WEBLOGIC_DOMAIN', 'tags': {'properties_map': {}}}, 'discovery_type': 'ADD', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'status': 'SUCCESS', 'status_message': 'status_message_example', 'system_tags': {}, 'tenant_id': 'ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx', 'time_updated': '2013-10-20T19:20:30+01:00', 'user_id': 'ocid1.user.oc1..xxxxxxEXAMPLExxxxxx'}
 
compartment_id
string
on success
The OCID of the Compartment

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"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
discovery_client
string
on success
Client who submits discovery job.

Sample:
discovery_client_example
 
discovery_details
complex
on success

   
agent_id
string
on success
The OCID of Management Agent

Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
   
credentials
complex
on success

     
items
complex
on success
List of DiscoveryJob credentials.
       
credential_name
string
on success
Name of Credential

Sample:
credential_name_example
       
credential_type
string
on success
Name of Credential Type

Sample:
credential_type_example
       
properties
complex
on success

         
properties_map
dictionary
on success
Key/Value pair of Property
   
properties
complex
on success

     
properties_map
dictionary
on success
Key/Value pair of Property
   
resource_name
string
on success
The Name of resource type

Sample:
resource_name_example
   
resource_type
string
on success
Resource Type.

Sample:
WEBLOGIC_DOMAIN
   
tags
complex
on success

     
properties_map
dictionary
on success
Key/Value pair of Property
 
discovery_type
string
on success
Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources.

Sample:
ADD
 
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"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of Discovery job

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the DiscoveryJob Resource.

Sample:
CREATING
 
status
string
on success
Specifies the status of the discovery job

Sample:
SUCCESS
 
status_message
string
on success
The short summary of the status of the discovery job

Sample:
status_message_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
tenant_id
string
on success
The OCID of Tenant

Sample:
ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx
 
time_updated
string
on success
The time the discovery Job was updated.

Sample:
2013-10-20T19:20:30+01:00
 
user_id
string
on success
The OCID of user in which the job is submitted

Sample:
ocid1.user.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)