oracle.oci.oci_management_dashboard – Manage a ManagementDashboard resource 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.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a ManagementDashboard resource in Oracle Cloud Infrastructure
For state=present, creates a new dashboard. Limit for number of saved searches in a dashboard is 20. Here’s an example of how you can use CLI to create a dashboard. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: oci management-dashboard dashboard get –management-dashboard-id “ocid1.managementdashboard.oc1..dashboardId1” –query data > Create.json. You can then modify the Create.json file by removing the id attribute and making other required changes, and use the oci management-dashboard dashboard create command.
This resource has the following action operations in the oracle.oci.oci_management_dashboard_actions module: export_dashboard, import_dashboard.
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
|
OCID of the compartment in which the dashboard resides.
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.This parameter is updatable.
|
||
|
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. |
||
|
dashboard_id
string
|
ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.
|
||
|
data_config
list
/ elements=dictionary
|
Array of JSON that contain data source options.
Required for create using state=present.
This parameter is updatable.
|
||
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||
|
description
string
|
Description of the dashboard.
Required for create using state=present.
This parameter is updatable.
|
||
|
display_name
string
|
Display name of the dashboard.
Required for create using state=present.
Required for 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 |
||
|
drilldown_config
list
/ elements=dictionary
|
Drill-down configuration to define the destination of a drill-down action.
This parameter is updatable.
|
||
|
features_config
dictionary
|
Contains configuration for enabling features.
This parameter is updatable.
|
||
|
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"}`
This parameter is updatable.
|
||
|
is_favorite
boolean
|
|
Determines whether the dashboard is set as favorite.
Required for create using state=present.
This parameter is updatable.
|
|
|
is_oob_dashboard
boolean
|
|
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.
Required for create using state=present.
This parameter is updatable.
|
|
|
is_show_description
boolean
|
|
Determines whether the description of the dashboard is displayed.
Required for create using state=present.
This parameter is updatable.
|
|
|
is_show_in_home
boolean
|
|
Determines whether the dashboard will be displayed in Dashboard Home.
Required for create using state=present.
This parameter is updatable.
|
|
|
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.
|
||
|
management_dashboard_id
string
|
A unique dashboard identifier.
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 |
||
|
metadata_version
string
|
The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
Required for create using state=present.
This parameter is updatable.
|
||
|
nls
dictionary
|
JSON that contains internationalization options.
Required for create using state=present.
This parameter is updatable.
|
||
|
parameters_config
list
/ elements=dictionary
|
Defines parameters for the dashboard.
This parameter is updatable.
|
||
|
provider_id
string
|
ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
Required for create using state=present.
This parameter is updatable.
|
||
|
provider_name
string
|
The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
Required for create using state=present.
This parameter is updatable.
|
||
|
provider_version
string
|
The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
Required for create using state=present.
This parameter is updatable.
|
||
|
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. |
||
|
screen_image
string
|
Screen image of the dashboard.
Required for create using state=present.
This parameter is updatable.
|
||
|
state
string
|
|
The state of the ManagementDashboard.
Use state=present to create or update a ManagementDashboard.
Use state=absent to delete a ManagementDashboard.
|
|
|
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 |
||
|
tiles
list
/ elements=dictionary
|
Array of dashboard tiles.
Required for create using state=present.
This parameter is updatable.
|
||
|
column
integer
/ required
|
Tile's column number.
|
||
|
data_config
list
/ elements=dictionary / required
|
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
/ required
|
Display name of the saved search.
aliases: name |
||
|
drilldown_config
list
/ elements=string / required
|
Drill-down configuration to define the destination of a drill-down action.
|
||
|
height
integer
/ required
|
The number of rows the tile occupies.
|
||
|
nls
dictionary
/ required
|
JSON that contains internationalization options.
|
||
|
parameters_map
dictionary
|
Specifies the saved search parameters values
|
||
|
row
integer
/ required
|
Tile's row number.
|
||
|
saved_search_id
string
/ required
|
ID of the saved search.
|
||
|
state
string
/ required
|
|
Current state of the saved search.
|
|
|
ui_config
dictionary
/ required
|
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
/ required
|
The number of columns the tile occupies.
|
||
|
type
string
|
Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
Required for create using state=present.
This parameter is updatable.
|
||
|
ui_config
dictionary
|
JSON that contains user interface options.
Required for create using state=present.
This parameter is updatable.
|
||
|
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 management_dashboard
oci_management_dashboard:
# required
provider_id: "ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx"
provider_name: provider_name_example
provider_version: provider_version_example
tiles:
- # required
display_name: display_name_example
saved_search_id: "ocid1.savedsearch.oc1..xxxxxxEXAMPLExxxxxx"
row: 56
column: 56
height: 56
width: 56
nls: null
ui_config: null
data_config: [ "data_config_example" ]
state: DELETED
drilldown_config: []
# optional
parameters_map: null
display_name: display_name_example
description: description_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
is_oob_dashboard: true
is_show_in_home: true
metadata_version: metadata_version_example
is_show_description: true
screen_image: screen_image_example
nls: null
ui_config: null
data_config: [ "data_config_example" ]
type: type_example
is_favorite: true
# optional
dashboard_id: "ocid1.dashboard.oc1..xxxxxxEXAMPLExxxxxx"
parameters_config: [ "parameters_config_example" ]
features_config: null
drilldown_config: [ "drilldown_config_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update management_dashboard
oci_management_dashboard:
# required
management_dashboard_id: "ocid1.managementdashboard.oc1..xxxxxxEXAMPLExxxxxx"
# optional
provider_id: "ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx"
provider_name: provider_name_example
provider_version: provider_version_example
tiles:
- # required
display_name: display_name_example
saved_search_id: "ocid1.savedsearch.oc1..xxxxxxEXAMPLExxxxxx"
row: 56
column: 56
height: 56
width: 56
nls: null
ui_config: null
data_config: [ "data_config_example" ]
state: DELETED
drilldown_config: []
# optional
parameters_map: null
display_name: display_name_example
description: description_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
is_oob_dashboard: true
is_show_in_home: true
metadata_version: metadata_version_example
is_show_description: true
screen_image: screen_image_example
nls: null
ui_config: null
data_config: [ "data_config_example" ]
type: type_example
is_favorite: true
parameters_config: [ "parameters_config_example" ]
features_config: null
drilldown_config: [ "drilldown_config_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update management_dashboard using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_management_dashboard:
# required
display_name: display_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
provider_id: "ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx"
provider_name: provider_name_example
provider_version: provider_version_example
tiles:
- # required
display_name: display_name_example
saved_search_id: "ocid1.savedsearch.oc1..xxxxxxEXAMPLExxxxxx"
row: 56
column: 56
height: 56
width: 56
nls: null
ui_config: null
data_config: [ "data_config_example" ]
state: DELETED
drilldown_config: []
# optional
parameters_map: null
description: description_example
is_oob_dashboard: true
is_show_in_home: true
metadata_version: metadata_version_example
is_show_description: true
screen_image: screen_image_example
nls: null
ui_config: null
data_config: [ "data_config_example" ]
type: type_example
is_favorite: true
parameters_config: [ "parameters_config_example" ]
features_config: null
drilldown_config: [ "drilldown_config_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete management_dashboard
oci_management_dashboard:
# required
management_dashboard_id: "ocid1.managementdashboard.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete management_dashboard using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_management_dashboard:
# required
display_name: display_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)