oracle / oracle.oci / 4.43.0 / module / oci_compute_instance_agent_instance_agent_command_execution_facts Fetches details about one or multiple InstanceAgentCommandExecution resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_compute_instance_agent_instance_agent_command_execution_facts (4.43.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.43.0
collections: - name: oracle.oci version: 4.43.0
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 I(instance_agent_command_id) is specified, the details of a single InstanceAgentCommandExecution will be returned.
- 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
region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str sort_by: choices: - TIMECREATED - DISPLAYNAME description: - 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.' type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order is case sensitive. type: str cert_bundle: description: - 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. type: str instance_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the instance. required: true type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str display_name: description: Use I(display_name) along with the other options to return only resources that match the given display name exactly. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. - Required to list multiple instance_agent_command_executions. type: str lifecycle_state: choices: - ACCEPTED - IN_PROGRESS - SUCCEEDED - FAILED - TIMED_OUT - CANCELED description: - A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str instance_agent_command_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command. - Required to get a specific instance_agent_command_execution. type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
instance_agent_command_executions: contains: content: contains: bucket_name: description: - The Object Storage bucket for the command output. returned: on success sample: bucket_name_example type: str exit_code: description: - The exit code for the command. Exit code `0` indicates success. returned: on success sample: 56 type: int message: description: - An optional status message that Oracle Cloud Agent can populate for additional troubleshooting. returned: on success sample: message_example type: str namespace_name: description: - The Object Storage namespace for the command output. returned: on success sample: namespace_name_example type: str object_name: description: - The Object Storage object name for the command output. returned: on success sample: object_name_example type: str output_type: description: - '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 L(Overview of Object Storage,https://docs.cloud.oracle.com/Content/Object/Concepts/objectstorageoverview.htm). returned: on success sample: TEXT type: str output_uri: description: - The Object Storage URL or pre-authenticated request (PAR) for the command output. returned: on success sample: output_uri_example type: str text: description: - The command output. returned: on success sample: text_example type: str text_sha256: description: - SHA-256 checksum value of the text content. returned: on success sample: text_sha256_example type: str description: - '' returned: on success type: complex delivery_state: description: - 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. returned: on success sample: VISIBLE type: str display_name: description: - The user friendly display name of the command. returned: on success sample: display_name_example type: str instance_agent_command_id: description: - The OCID of the command returned: on success sample: ocid1.instanceagentcommand.oc1..xxxxxxEXAMPLExxxxxx type: str instance_id: description: - The OCID of the instance returned: on success sample: ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_state: description: - 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. returned: on success sample: ACCEPTED type: str sequence_number: description: - The large non-consecutive number that Run Command Service assigns to each created command. returned: on success sample: 56 type: int time_created: description: - The command creation date returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_updated: description: - The command last updated at date. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - List of InstanceAgentCommandExecution resources returned: on success 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' type: complex