oracle.oci.oci_management_dashboard_facts – Fetches details about one or multiple ManagementDashboard resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Gets the list of dashboards in a compartment with pagination. Returned properties are the summary.

  • If management_dashboard_id is specified, the details of a single ManagementDashboard 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
  • 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 ID of the compartment in which to list resources.
Required to list multiple management_dashboards.
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 filter to return only resources that match the entire display name given.

aliases: name
management_dashboard_id
string
A unique dashboard identifier.
Required to get a specific management_dashboard.

aliases: id
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.
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 the 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

Examples

- name: Get a specific management_dashboard
  oci_management_dashboard_facts:
    # required
    management_dashboard_id: "ocid1.managementdashboard.oc1..xxxxxxEXAMPLExxxxxx"

- name: List management_dashboards
  oci_management_dashboard_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    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
management_dashboards
complex
on success
List of ManagementDashboard resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'dashboard_id': 'ocid1.dashboard.oc1..xxxxxxEXAMPLExxxxxx', 'data_config': [], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'drilldown_config': [], 'features_config': {}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_favorite': True, 'is_oob_dashboard': True, 'is_show_description': True, 'is_show_in_home': True, 'lifecycle_state': 'ACTIVE', 'metadata_version': 'metadata_version_example', 'nls': {}, 'parameters_config': [], 'provider_id': 'ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx', 'provider_name': 'provider_name_example', 'provider_version': 'provider_version_example', 'saved_searches': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'data_config': [], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'drilldown_config': [], 'features_config': {}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_oob_saved_search': True, 'lifecycle_state': 'ACTIVE', 'metadata_version': 'metadata_version_example', 'nls': {}, 'parameters_config': [], 'provider_id': 'ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx', 'provider_name': 'provider_name_example', 'provider_version': 'provider_version_example', 'screen_image': 'screen_image_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'SEARCH_SHOW_IN_DASHBOARD', 'ui_config': {}, 'updated_by': 'updated_by_example', 'widget_template': 'widget_template_example', 'widget_vm': 'widget_vm_example'}], 'screen_image': 'screen_image_example', 'tiles': [{'column': 56, 'data_config': [], 'display_name': 'display_name_example', 'drilldown_config': [], 'height': 56, 'nls': {}, 'parameters_map': {}, 'row': 56, 'saved_search_id': 'ocid1.savedsearch.oc1..xxxxxxEXAMPLExxxxxx', 'state': 'DELETED', 'ui_config': {}, 'width': 56}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'type_example', 'ui_config': {}, 'updated_by': 'updated_by_example'}]
 
compartment_id
string
on success
OCID of the compartment in which the dashboard resides.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by
string
on success
User who created the dashboard.

Sample:
created_by_example
 
dashboard_id
string
on success
ID of the dashboard. Same as id.

Sample:
ocid1.dashboard.oc1..xxxxxxEXAMPLExxxxxx
 
data_config
list / elements=string
on success
Array of JSON that contain data source options.
Returned for get operation
 
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'}}
 
description
string
on success
Description of the dashboard.

Sample:
description_example
 
display_name
string
on success
Display name of the dashboard.

Sample:
display_name_example
 
drilldown_config
list / elements=string
on success
Drill-down configuration to define the destination of a drill-down action.
Returned for get operation
 
features_config
dictionary
on success
Contains configuration for enabling features.
 
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
ID of the dashboard. Same as dashboardId.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_favorite
boolean
on success
Determines whether the dashboard is set as favorite.
Returned for get operation

Sample:
True
 
is_oob_dashboard
boolean
on success
Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

Sample:
True
 
is_show_description
boolean
on success
Determines whether the description of the dashboard is displayed.
Returned for get operation

Sample:
True
 
is_show_in_home
boolean
on success
Determines whether the dashboard will be displayed in Dashboard Home.
Returned for get operation

Sample:
True
 
lifecycle_state
string
on success
State of dashboard.

Sample:
ACTIVE
 
metadata_version
string
on success
The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

Sample:
metadata_version_example
 
nls
dictionary
on success
JSON that contains internationalization options.
 
parameters_config
list / elements=string
on success
Defines parameters for the dashboard.
Returned for get operation
 
provider_id
string
on success
ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.

Sample:
ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx
 
provider_name
string
on success
Name of the service (for example, Logging Analytics) that owns the dashboard.

Sample:
provider_name_example
 
provider_version
string
on success
Version of the service that owns the dashboard.

Sample:
provider_version_example
 
saved_searches
complex
on success
Array of saved searches in the dashboard.
Returned for get operation
   
compartment_id
string
on success
OCID of the compartment in which the saved search resides.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
   
created_by
string
on success
The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value.

Sample:
created_by_example
   
data_config
list / elements=string
on success
It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
   
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'}}
   
description
string
on success
Description of the saved search.

Sample:
description_example
   
display_name
string
on success
Display name of the saved search.

Sample:
display_name_example
   
drilldown_config
list / elements=string
on success
Drill-down configuration to define the destination of a drill-down action.
   
features_config
dictionary
on success
Contains configuration for enabling features.
   
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
ID of the saved search.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
    is_oob_saved_search
boolean
on success
Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.

Sample:
True
   
lifecycle_state
string
on success
OCI lifecycle status. This is automatically managed by the system.

Sample:
ACTIVE
   
metadata_version
string
on success
The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

Sample:
metadata_version_example
   
nls
dictionary
on success
JSON that contains internationalization options.
   
parameters_config
list / elements=string
on success
Defines parameters for the saved search.
   
provider_id
string
on success
ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.

Sample:
ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx
   
provider_name
string
on success
Name of the service (for example, Logging Analytics) that owns the saved search.

Sample:
provider_name_example
   
provider_version
string
on success
Version of the service that owns this saved search.

Sample:
provider_version_example
   
screen_image
string
on success
Screen image of the saved search.

Sample:
screen_image_example
   
time_created
string
on success
Date and time the saved search was created.

Sample:
2013-10-20T19:20:30+01:00
   
time_updated
string
on success
Date and time the saved search was updated.

Sample:
2013-10-20T19:20:30+01:00
   
type
string
on success
Determines how the saved search is displayed in a dashboard.

Sample:
SEARCH_SHOW_IN_DASHBOARD
   
ui_config
dictionary
on success
It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
   
updated_by
string
on success
The principle id of the user that updated this saved search.

Sample:
updated_by_example
   
widget_template
string
on success
The UI template that the saved search uses to render itself.

Sample:
widget_template_example
   
widget_vm
string
on success
The View Model that the saved search uses to render itself.

Sample:
widget_vm_example
 
screen_image
string
on success
Screen image of the dashboard.

Sample:
screen_image_example
 
tiles
complex
on success
Array of dashboard tiles.
Returned for get operation
   
column
integer
on success
Tile's column number.

Sample:
56
   
data_config
list / elements=string
on success
It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
   
display_name
string
on success
Display name of the saved search.

Sample:
display_name_example
   
drilldown_config
list / elements=string
on success
Drill-down configuration to define the destination of a drill-down action.
   
height
integer
on success
The number of rows the tile occupies.

Sample:
56
   
nls
dictionary
on success
JSON that contains internationalization options.
   
parameters_map
dictionary
on success
Specifies the saved search parameters values
   
row
integer
on success
Tile's row number.

Sample:
56
   
saved_search_id
string
on success
ID of the saved search.

Sample:
ocid1.savedsearch.oc1..xxxxxxEXAMPLExxxxxx
   
state
string
on success
Current state of the saved search.

Sample:
DELETED
   
ui_config
dictionary
on success
It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
   
width
integer
on success
The number of columns the tile occupies.

Sample:
56
 
time_created
string
on success
Date and time the dashboard was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Date and time the dashboard was updated.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

Sample:
type_example
 
ui_config
dictionary
on success
JSON that contains user interface options.
Returned for get operation
 
updated_by
string
on success
User who updated the dashboard.

Sample:
updated_by_example


Authors

  • Oracle (@oracle)