oracle.oci.oci_cloud_bridge_asset_source – Manage an AssetSource 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_cloud_bridge_asset_source.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates an asset source.

  • This resource has the following action operations in the oracle.oci.oci_cloud_bridge_asset_source_actions module: change_compartment, refresh.

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).
are_historical_metrics_collected
boolean
    Choices:
  • no
  • yes
Flag indicating whether historical metrics are collected for assets, originating from this asset source.
This parameter is updatable.
are_realtime_metrics_collected
boolean
    Choices:
  • no
  • yes
Flag indicating whether real-time metrics are collected for assets, originating from this asset source.
This parameter is updatable.
asset_source_id
string
The OCID of the asset source.
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
assets_compartment_id
string
The OCID of the compartment that is going to be used to create assets.
Required for create using state=present.
This parameter is updatable.
Applicable when type is 'VMWARE'
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 for the resource.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
discovery_credentials
dictionary
Required for create using state=present.
This parameter is updatable.
Applicable when type is 'VMWARE'
secret_id
string / required
The OCID of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ "username": "<VMwareUser>", "password": "<VMwarePassword>" }`.
type
string / required
    Choices:
  • BASIC
Authentication type
discovery_schedule_id
string
The OCID of the discovery schedule that is going to be attached to the created asset.
This parameter is updatable.
display_name
string
A user-friendly name for the asset source. Does not have to be unique, and it's mutable. Avoid entering confidential information. The name is generated by the service if it is not explicitly provided.
Required for create, 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
environment_id
string
The OCID of the environment.
Required for create using state=present.
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
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
This parameter is updatable.
inventory_id
string
The OCID of the inventory that will contain created assets.
Required for create using state=present.
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.
replication_credentials
dictionary
This parameter is updatable.
secret_id
string / required
The OCID of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ "username": "<VMwareUser>", "password": "<VMwarePassword>" }`.
type
string / required
    Choices:
  • BASIC
Authentication type
state
string
    Choices:
  • present ←
  • absent
The state of the AssetSource.
Use state=present to create or update an AssetSource.
Use state=absent to delete an AssetSource.
system_tags
dictionary
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{orcl-cloud: {free-tier-retain: true}}`
This parameter is updatable.
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
type
string
    Choices:
  • VMWARE
Asset source type.
Required for create using state=present, update using state=present with asset_source_id present.
vcenter_endpoint
string
Endpoint for VMware asset discovery and replication in the form of ```https://<host>:<port>/sdk```
Required for create using state=present.
This parameter is updatable.
Applicable when type is 'VMWARE'
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 asset_source with type = VMWARE
  oci_cloud_bridge_asset_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    environment_id: "ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx"
    inventory_id: "ocid1.inventory.oc1..xxxxxxEXAMPLExxxxxx"
    type: VMWARE

    # optional
    display_name: display_name_example
    assets_compartment_id: "ocid1.assetscompartment.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    system_tags: null
    vcenter_endpoint: vcenter_endpoint_example
    discovery_credentials:
      # required
      type: BASIC
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    replication_credentials:
      # required
      type: BASIC
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    are_historical_metrics_collected: true
    are_realtime_metrics_collected: true
    discovery_schedule_id: "ocid1.discoveryschedule.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update asset_source with type = VMWARE
  oci_cloud_bridge_asset_source:
    # required
    type: VMWARE

    # optional
    display_name: display_name_example
    assets_compartment_id: "ocid1.assetscompartment.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    system_tags: null
    vcenter_endpoint: vcenter_endpoint_example
    discovery_credentials:
      # required
      type: BASIC
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    replication_credentials:
      # required
      type: BASIC
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    are_historical_metrics_collected: true
    are_realtime_metrics_collected: true
    discovery_schedule_id: "ocid1.discoveryschedule.oc1..xxxxxxEXAMPLExxxxxx"

- name: Update asset_source using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with type = VMWARE
  oci_cloud_bridge_asset_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: VMWARE

    # optional
    display_name: display_name_example
    assets_compartment_id: "ocid1.assetscompartment.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    system_tags: null
    vcenter_endpoint: vcenter_endpoint_example
    discovery_credentials:
      # required
      type: BASIC
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    replication_credentials:
      # required
      type: BASIC
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    are_historical_metrics_collected: true
    are_realtime_metrics_collected: true
    discovery_schedule_id: "ocid1.discoveryschedule.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete asset_source
  oci_cloud_bridge_asset_source:
    # required
    asset_source_id: "ocid1.assetsource.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete asset_source using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_cloud_bridge_asset_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    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
asset_source
complex
on success
Details of the AssetSource resource acted upon by the current operation

Sample:
{'are_historical_metrics_collected': True, 'are_realtime_metrics_collected': True, 'assets_compartment_id': 'ocid1.assetscompartment.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'discovery_credentials': {'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'BASIC'}, 'discovery_schedule_id': 'ocid1.discoveryschedule.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'environment_id': 'ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'inventory_id': 'ocid1.inventory.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'replication_credentials': {'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'BASIC'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'VMWARE', 'vcenter_endpoint': 'vcenter_endpoint_example'}
 
are_historical_metrics_collected
boolean
on success
Flag indicating whether historical metrics are collected for assets, originating from this asset source.

Sample:
True
 
are_realtime_metrics_collected
boolean
on success
Flag indicating whether real-time metrics are collected for assets, originating from this asset source.

Sample:
True
 
assets_compartment_id
string
on success
The OCID of the compartment that is going to be used to create assets.

Sample:
ocid1.assetscompartment.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment for the resource.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
discovery_credentials
complex
on success

   
secret_id
string
on success
The OCID of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ "username": "<VMwareUser>", "password": "<VMwarePassword>" }`.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
   
type
string
on success
Authentication type

Sample:
BASIC
 
discovery_schedule_id
string
on success
The OCID of an attached discovery schedule.

Sample:
ocid1.discoveryschedule.oc1..xxxxxxEXAMPLExxxxxx
 
display_name
string
on success
A user-friendly name for the asset source. Does not have to be unique, and it's mutable. Avoid entering confidential information.

Sample:
display_name_example
 
environment_id
string
on success
The OCID of the environment.

Sample:
ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx
 
freeform_tags
dictionary
on success
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

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

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
inventory_id
string
on success
The OCID of the inventory that will contain created assets.

Sample:
ocid1.inventory.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
The detailed state of the asset source.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the asset source.

Sample:
CREATING
 
replication_credentials
complex
on success

   
secret_id
string
on success
The OCID of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ "username": "<VMwareUser>", "password": "<VMwarePassword>" }`.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
   
type
string
on success
Authentication type

Sample:
BASIC
 
system_tags
dictionary
on success
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{orcl-cloud: {free-tier-retain: true}}`
 
time_created
string
on success
The time when the asset source was created in the RFC3339 format.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The point in time that the asset source was last updated in the RFC3339 format.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The type of asset source. Indicates external origin of the assets that are read by assigning this asset source.

Sample:
VMWARE
 
vcenter_endpoint
string
on success
Endpoint for VMware asset discovery and replication in the form of ```https://<host>:<port>/sdk```

Sample:
vcenter_endpoint_example


Authors

  • Oracle (@oracle)