oracle.oci.oci_visual_builder_vb_instance_facts – Fetches details about one or multiple VbInstance resources 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_visual_builder_vb_instance_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple VbInstance resources in Oracle Cloud Infrastructure

  • Returns a list of Vb Instances.

  • If vb_instance_id is specified, the details of a single VbInstance will be returned.

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 ID of the compartment in which to list resources.
Required to list multiple vb_instances.
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.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable.
Example: `My new resource`

aliases: name
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • INACTIVE
  • DELETING
  • DELETED
  • FAILED
Life cycle state to query on.
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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
vb_instance_id
string
Unique Vb Instance identifier.
Required to get a specific vb_instance.

aliases: id

Examples

- name: Get a specific vb_instance
  oci_visual_builder_vb_instance_facts:
    # required
    vb_instance_id: "ocid1.vbinstance.oc1..xxxxxxEXAMPLExxxxxx"

- name: List vb_instances
  oci_visual_builder_vb_instance_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
vb_instances
complex
on success
List of VbInstance resources

Sample:
[{'alternate_custom_endpoints': [{'certificate_secret_id': 'ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx', 'certificate_secret_version': 56, 'hostname': 'hostname_example'}], 'attachments': [{'is_implicit': True, 'target_id': 'ocid1.target.oc1..xxxxxxEXAMPLExxxxxx', 'target_instance_url': 'target_instance_url_example', 'target_role': 'PARENT', 'target_service_type': 'target_service_type_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'consumption_model': 'UCM', 'custom_endpoint': {'certificate_secret_id': 'ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx', 'certificate_secret_version': 56, 'hostname': 'hostname_example'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'idcs_info': {'idcs_app_display_name': 'idcs_app_display_name_example', 'idcs_app_id': 'ocid1.idcsapp.oc1..xxxxxxEXAMPLExxxxxx', 'idcs_app_location_url': 'idcs_app_location_url_example', 'idcs_app_name': 'idcs_app_name_example', 'instance_primary_audience_url': 'instance_primary_audience_url_example'}, 'instance_url': 'instance_url_example', 'is_visual_builder_enabled': True, 'lifecycle_state': 'CREATING', 'node_count': 56, 'state_message': 'state_message_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
alternate_custom_endpoints
complex
on success
A list of alternate custom endpoints used for the vb instance URL.

   
certificate_secret_id
string
on success
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

Sample:
ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx
   
certificate_secret_version
integer
on success
The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

Sample:
56
   
hostname
string
on success
A custom hostname to be used for the vb instance URL, in FQDN format.

Sample:
hostname_example
 
attachments
complex
on success
A list of associated attachments to other services
Returned for get operation

   
is_implicit
boolean
on success
* If role == `PARENT`, the attached instance was created by this service instance * If role == `CHILD`, this instance was created from attached instance on behalf of a user

Sample:
True
   
target_id
string
on success
The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this instance is attached.

Sample:
ocid1.target.oc1..xxxxxxEXAMPLExxxxxx
   
target_instance_url
string
on success
The dataplane instance URL of the attached instance

Sample:
target_instance_url_example
   
target_role
string
on success
The role of the target attachment. * `PARENT` - The target instance is the parent of this attachment. * `CHILD` - The target instance is the child of this attachment.

Sample:
PARENT
   
target_service_type
string
on success
The type of the target instance, such as "FUSION".

Sample:
target_service_type_example
 
compartment_id
string
on success
Compartment Identifier.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
consumption_model
string
on success
The entitlement used for billing purposes.

Sample:
UCM
 
custom_endpoint
complex
on success

   
certificate_secret_id
string
on success
Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

Sample:
ocid1.certificatesecret.oc1..xxxxxxEXAMPLExxxxxx
   
certificate_secret_version
integer
on success
The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

Sample:
56
   
hostname
string
on success
A custom hostname to be used for the vb instance URL, in FQDN format.

Sample:
hostname_example
 
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'}}
 
display_name
string
on success
Vb Instance Identifier, can be renamed.

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

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique identifier that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
idcs_info
complex
on success
Returned for get operation

   
idcs_app_display_name
string
on success
The IDCS application display name associated with the instance

Sample:
idcs_app_display_name_example
   
idcs_app_id
string
on success
The IDCS application ID associated with the instance

Sample:
ocid1.idcsapp.oc1..xxxxxxEXAMPLExxxxxx
   
idcs_app_location_url
string
on success
URL for the location of the IDCS Application (used by IDCS APIs)

Sample:
idcs_app_location_url_example
   
idcs_app_name
string
on success
The IDCS application name associated with the instance

Sample:
idcs_app_name_example
   
instance_primary_audience_url
string
on success
The URL used as the primary audience for visual builder flows in this instance type: string

Sample:
instance_primary_audience_url_example
 
instance_url
string
on success
The Vb Instance URL.

Sample:
instance_url_example
 
is_visual_builder_enabled
boolean
on success
Visual Builder is enabled or not.

Sample:
True
 
lifecycle_state
string
on success
The current state of the vb instance.

Sample:
CREATING
 
node_count
integer
on success
The number of Nodes

Sample:
56
 
state_message
string
on success
An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

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

 
time_created
string
on success
The time the the VbInstance was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the VbInstance was updated. An RFC3339 formatted datetime string.

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


Authors

  • Oracle (@oracle)