- source
cloud/oracle/oci_console_history_facts.py
- orphan
2.5
- This module retrieves information of a specified console history or all console histories in the specified compartment.
The below requirements are needed on the host that executes this module.
- python >= 2.7
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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_OCID 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_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. |
compartment_id
-
|
The OCID of the compartment the resource belongs to. Use instance_console_history_id to retrieve a specific console history.
|
|
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 . |
|
instance_console_history_id
-
|
OCID of the target console history.
aliases: id |
|
instance_id
-
|
The OCID of the instance.
|
|
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 |
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
- name: Get a list of console_histories in the specified compartment
oci_console_history_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...abcd
- name: Get a list of console_histories in the specified compartment for a specific instance
oci_console_history_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...abcd
instance_id: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq
- name: Gets details of a specific console history using its OCID
oci_console_history_facts:
instance_console_history_id: ocid1.consolehistory.oc1.iad.xxxxxEXAMPLExxxxx...tc7a
Common return values are documented here <common_return_values>
, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
console_histories
complex
|
always |
List of console history details
Sample:
[{'time-created': '2018-11-05T13:58:01.944000+00:00', 'lifecycle-state': 'REQUESTED', 'defined-tags': {}, 'compartment-id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...2bla', 'availability-domain': 'IwGV:US-ASHBURN-AD-3', 'display-name': 'consolehistory20181105135801', 'freeform-tags': {}, 'id': 'ocid1.consolehistory.oc1.iad.xxxxxEXAMPLExxxxx...tc7a', 'instance-id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...he5q'}]
|
|
availability_domain
string
|
always |
The availability domain of an instance.
Sample:
Uocm:PHX-AD-1
|
|
compartment_id
string
|
always |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...2bla"
|
|
defined_tags
string
|
always |
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Sample:
{"Operations": {"CostCenter": "42"}}
|
|
display_name
string
|
always |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
My console history metadata
|
|
freeform_tags
string
|
always |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
Sample:
{"Department": "Finance"}
|
|
id
string
|
always |
The OCID of the console history metadata object.
Sample:
ocid1.consolehistory.oc1.iad.xxxxxEXAMPLExxxxx...tc7a
|
|
instance_id
string
|
always |
The OCID of the instance this console history was fetched from.
Sample:
ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq
|
|
lifecycle_state
string
|
always |
The current state of the console history.
Sample:
ACTIVE
|
|
time_created
string
|
always |
The date and time the history was created, in the format defined by RFC3339.
Sample:
2016-08-25T21:10:29.600Z
|
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is
maintained by the Ansible Community <modules_support>
. [community]
- Sivakumar Thyagarajan (@sivakumart)
Hint
If you notice any issues in this documentation you can edit this document to improve it.