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 5.0.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.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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.
|
|||||
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
|||||
should_propagate_tags_to_discovered_resources
boolean
|
|
If this parameter set to true, the specified tags will be applied to all resources discovered in the current request. Default is true.
|
||||
state
string
|
|
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
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
should_propagate_tags_to_discovered_resources: true
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:
Authors¶
Oracle (@oracle)