oracle.oci.oci_compute_instance_agent_instance_agent_command_execution_facts – Fetches details about one or multiple InstanceAgentCommandExecution resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_compute_instance_agent_instance_agent_command_execution_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple InstanceAgentCommandExecution resources in Oracle Cloud Infrastructure
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
If instance_agent_command_id is specified, the details of a single InstanceAgentCommandExecution will be returned.
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
|
The OCID of the compartment.
Required to list multiple instance_agent_command_executions.
|
|
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
|
Use display_name along with the other options to return only resources that match the given display name exactly.
|
|
instance_agent_command_id
string
|
The OCID of the command.
Required to get a specific instance_agent_command_execution.
aliases: id |
|
instance_id
string
/ required
|
The OCID of the instance.
|
|
lifecycle_state
string
|
|
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
|
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. |
|
sort_by
string
|
|
The field to sort by. You can provide one sort order (`sortOrder`). Default order for `TIMECREATED` is descending.
**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order is case sensitive.
|
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: Get a specific instance_agent_command_execution
oci_compute_instance_agent_instance_agent_command_execution_facts:
# required
instance_agent_command_id: "ocid1.instanceagentcommand.oc1..xxxxxxEXAMPLExxxxxx"
instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
- name: List instance_agent_command_executions
oci_compute_instance_agent_instance_agent_command_execution_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
# optional
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: ACCEPTED
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
instance_agent_command_executions
complex
|
on success |
List of InstanceAgentCommandExecution resources
Sample:
[{'content': {'bucket_name': 'bucket_name_example', 'exit_code': 56, 'message': 'message_example', 'namespace_name': 'namespace_name_example', 'object_name': 'object_name_example', 'output_type': 'TEXT', 'output_uri': 'output_uri_example', 'text': 'text_example', 'text_sha256': 'text_sha256_example'}, 'delivery_state': 'VISIBLE', 'display_name': 'display_name_example', 'instance_agent_command_id': 'ocid1.instanceagentcommand.oc1..xxxxxxEXAMPLExxxxxx', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACCEPTED', 'sequence_number': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
||
content
complex
|
on success |
|
||
bucket_name
string
|
on success |
The Object Storage bucket for the command output.
Sample:
bucket_name_example
|
||
exit_code
integer
|
on success |
The exit code for the command. Exit code `0` indicates success.
Sample:
56
|
||
message
string
|
on success |
An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.
Sample:
message_example
|
||
namespace_name
string
|
on success |
The Object Storage namespace for the command output.
Sample:
namespace_name_example
|
||
object_name
string
|
on success |
The Object Storage object name for the command output.
Sample:
object_name_example
|
||
output_type
string
|
on success |
The output destination type for the command. The following values are supported:
- TEXT - the command output is returned as plain text. - OBJECT_STORAGE_URI - the command output is saved to an Object Storage URL. - OBJECT_STORAGE_TUPLE - the command output is saved to an Object Storage bucket.
For background information about Object Storage buckets and URLs, see Overview of Object Storage.
Sample:
TEXT
|
||
output_uri
string
|
on success |
The Object Storage URL or pre-authenticated request (PAR) for the command output.
Sample:
output_uri_example
|
||
text
string
|
on success |
The command output.
Sample:
text_example
|
||
text_sha256
string
|
on success |
SHA-256 checksum value of the text content.
Sample:
text_sha256_example
|
||
delivery_state
string
|
on success |
Specifies the command delivery state. * `VISIBLE` - The command is visible to instance. * `PENDING` - The command is pending ack from the instance. * `ACKED` - The command has been received and acked by the instance. * `ACKED_CANCELED` - The canceled command has been received and acked by the instance. * `EXPIRED` - The instance has not requested for commands and its delivery has expired.
Sample:
VISIBLE
|
||
display_name
string
|
on success |
The user friendly display name of the command.
Sample:
display_name_example
|
||
instance_agent_command_id
string
|
on success |
The OCID of the command
Sample:
ocid1.instanceagentcommand.oc1..xxxxxxEXAMPLExxxxxx
|
||
instance_id
string
|
on success |
The OCID of the instance
Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
command execution life cycle state. * `ACCEPTED` - The command execution has been accepted to run. * `IN_PROGRESS` - The command execution is in progress. * `SUCCEEDED` - The command execution is successful. * `FAILED` - The command execution has failed. * `TIMED_OUT` - The command execution has timedout. * `CANCELED` - The command execution has canceled.
Sample:
ACCEPTED
|
||
sequence_number
integer
|
on success |
The large non-consecutive number that Run Command Service assigns to each created command.
Sample:
56
|
||
time_created
string
|
on success |
The command creation date
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The command last updated at date.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)