oracle.oci.oci_management_dashboard_actions – Perform actions on a ManagementDashboard resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.5.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_actions.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a ManagementDashboard resource in Oracle Cloud Infrastructure
For action=export_dashboard, exports an array of dashboards and their saved searches. Export is designed to work with importDashboard. Here’s an example of how you can use CLI to export a dashboard: $oci management-dashboard dashboard export –query data –export-dashboard-id “{"dashboardIds":["ocid1.managementdashboard.oc1..dashboardId1"]}” > dashboards.json
For action=import_dashboard, imports an array of dashboards and their saved searches. Here’s an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: oci management-dashboard dashboard export –query data –export-dashboard-id “{"dashboardIds":["ocid1.managementdashboard.oc1..dashboardId1"]}” > Import.json. Note that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. Here’s an example of how you can use CLI to import: oci management-dashboard dashboard import –from-json file://Import.json
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 | ||
|---|---|---|---|---|
|
action
string
/ required
|
|
The action to perform on the ManagementDashboard.
|
||
|
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.
|
|||
|
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. |
|||
|
dashboards
list
/ elements=dictionary
|
Array of dashboards.
Required for action=import_dashboard.
|
|||
|
compartment_id
string
/ required
|
OCID of the compartment in which the dashboard resides.
|
|||
|
dashboard_id
string
/ required
|
ID of the dashboard.
|
|||
|
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.
|
|||
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
|
|||
|
description
string
/ required
|
Description of the dashboard.
|
|||
|
display_name
string
/ required
|
Display name of the dashboard.
aliases: name |
|||
|
drilldown_config
list
/ elements=dictionary
|
Drill-down configuration to define the destination of a drill-down action.
|
|||
|
features_config
dictionary
|
Contains configuration for enabling features.
|
|||
|
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"}`
|
|||
|
is_favorite
boolean
/ required
|
|
Determines whether the dashboard is set as favorite.
|
||
|
is_oob_dashboard
boolean
/ required
|
|
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.
|
||
|
is_show_description
boolean
/ required
|
|
Determines whether the description of the dashboard is displayed.
|
||
|
is_show_in_home
boolean
/ required
|
|
Determines whether the dashboard will be displayed in Dashboard Home.
|
||
|
metadata_version
string
/ required
|
The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
|
|||
|
nls
dictionary
/ required
|
JSON that contains internationalization options.
|
|||
|
parameters_config
list
/ elements=dictionary
|
Defines parameters for the dashboard.
|
|||
|
provider_id
string
/ required
|
ID of the service (for example log-analytics) that owns the dashboard. Each service has a unique ID.
|
|||
|
provider_name
string
/ required
|
The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
|
|||
|
provider_version
string
/ required
|
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.
|
|||
|
saved_searches
list
/ elements=dictionary / required
|
Array of saved searches in the dashboard.
|
|||
|
compartment_id
string
/ required
|
OCID of the compartment in which the saved search resides.
|
|||
|
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.
|
|||
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
|
|||
|
description
string
/ required
|
Description of the saved search.
|
|||
|
display_name
string
/ required
|
Display name of the saved search.
aliases: name |
|||
|
drilldown_config
list
/ elements=dictionary
|
Drill-down configuration to define the destination of a drill-down action.
|
|||
|
features_config
dictionary
|
Contains configuration for enabling features.
|
|||
|
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"}`
|
|||
|
id
string
/ required
|
ID of the saved search.
|
|||
|
is_oob_saved_search
boolean
/ required
|
|
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.
|
||
|
metadata_version
string
/ required
|
The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
|
|||
|
nls
dictionary
/ required
|
JSON that contains internationalization options.
|
|||
|
parameters_config
list
/ elements=dictionary
|
Defines parameters for the saved search.
|
|||
|
provider_id
string
/ required
|
ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
|
|||
|
provider_name
string
/ required
|
The user friendly name of the service (for example, Logging Analytics) that owns the saved search.
|
|||
|
provider_version
string
/ required
|
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.
|
|||
|
screen_image
string
/ required
|
Screen image of the saved search.
|
|||
|
type
string
/ required
|
|
Determines how the saved search is displayed in a dashboard.
|
||
|
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.
|
|||
|
widget_template
string
/ required
|
The UI template that the saved search uses to render itself.
|
|||
|
widget_vm
string
/ required
|
The View Model that the saved search uses to render itself.
|
|||
|
screen_image
string
/ required
|
Screen image of the dashboard.
|
|||
|
tiles
list
/ elements=dictionary / required
|
Array of dashboard tiles.
|
|||
|
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
/ required
|
Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
|
|||
|
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.
|
|||
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Applicable only for action=import_dashboard.
|
|||
|
export_dashboard_id
string
|
List of dashboardIds in plain text. The syntax is '{"dashboardIds":["dashboardId1", "dashboardId2", ...]}'. Escaping is needed when using in OCI CLI. For example, "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" .
Required for action=export_dashboard.
|
|||
|
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"}`
Applicable only for action=import_dashboard.
|
|||
|
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. |
|||
|
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 |
|||
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action export_dashboard on management_dashboard
oci_management_dashboard_actions:
# required
export_dashboard_id: "ocid1.exportdashboard.oc1..xxxxxxEXAMPLExxxxxx"
action: export_dashboard
- name: Perform action import_dashboard on management_dashboard
oci_management_dashboard_actions:
# required
dashboards:
- # required
dashboard_id: "ocid1.dashboard.oc1..xxxxxxEXAMPLExxxxxx"
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
saved_searches:
- # required
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
provider_id: "ocid1.provider.oc1..xxxxxxEXAMPLExxxxxx"
provider_version: provider_version_example
provider_name: provider_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
is_oob_saved_search: true
description: description_example
nls: null
type: SEARCH_SHOW_IN_DASHBOARD
ui_config: null
data_config: [ "data_config_example" ]
screen_image: screen_image_example
metadata_version: metadata_version_example
widget_template: widget_template_example
widget_vm: widget_vm_example
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
parameters_config: [ "parameters_config_example" ]
features_config: null
drilldown_config: [ "drilldown_config_example" ]
# optional
parameters_config: [ "parameters_config_example" ]
features_config: null
drilldown_config: [ "drilldown_config_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
action: import_dashboard
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)