Skip to content
This repository has been archived by the owner on May 1, 2021. It is now read-only.

Latest commit

 

History

History
537 lines (487 loc) · 36.9 KB

oci_console_history_module.rst

File metadata and controls

537 lines (487 loc) · 36.9 KB
Raw
source:cloud/oracle/oci_console_history.py
orphan:

oci_console_history -- Manage console histories for compute instances in OCI

.. versionadded:: 2.5

Synopsis

  • This module allows the user to capture and delete most recent serial console data (console history) for a specific compute instance in OCI. By default, during capture of a console history, this module waits until the console history is captured (ie lifecycle_state reaches SUCCEEDED (or FAILED)). If you would like to return immediately without waiting for the console history's capture to be completed, use wait=False.

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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
force_create
boolean
    Choices:
  • no ←
  • yes
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
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
instance_console_history_id
-
The OCID of the console history. Required to delete a console history.

aliases: id
instance_id
-
The OCID of the instance to get the console history from. Required to capture a console history.
key_by
list
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
name
-
A user-friendly name. Does not have to be unique, and it's changeable.

aliases: display_name
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.
state
-
    Choices:
  • present ←
  • absent
Create a console history with state=present. Use state=absent to delete an console history.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
2000
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Notes

Examples

- name: Create a console history
  oci_console_history:
    instance_id: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq
    name: my_instance_1_console_history

- name: Update the display name of a specific console history
  oci_console_history:
    id: ocid1.consolehistory.oc1.iad.xxxxxEXAMPLExxxxx...tc7a
    name: my_old_instance_1_console_history

- name: Delete a console history
  oci_console_history:
    id: ocid1.consolehistory.oc1.iad.xxxxxEXAMPLExxxxx...tc7a
    state: absent

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key Returned Description
console_history
complex
 On successful capture, delete operations on console histories
Information about the console history of an OCI compute instance

Sample:
{'instance-id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...he5q', 'availability-domain': 'IwGV:US-ASHBURN-AD-3', 'time-created': '2018-11-05T13:58:01.944000+00:00', 'lifecycle-state': 'REQUESTED', 'compartment-id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...2bla', 'display-name': 'consolehistory20181105135801', 'freeform-tags': {}, 'defined-tags': {}, 'id': 'ocid1.consolehistory.oc1.iad.xxxxxEXAMPLExxxxx...tc7a'}
  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


Status

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.