Listing Runbook Tasks

List runbook tasks in Fleet Application Management.

• Console
• CLI
• API

• 1. Open the navigation menu  and select Observability & Management. Under Fleet Application Management, select Runbooks and Tasks.
  2. Under Runbooks and Tasks (at the left side of the page), select Tasks.
     The Tasks list page opens. By default, the custom shared runbook tasks in the selected compartment are displayed in a table.
  3. To view the runbook tasks in a different compartment, use the Compartment filter to switch compartments.
     You must have permission to work in a compartment to see the resources in it. If you're not sure which compartment to use, contact an administrator. For more information, see Understanding Compartments.
  4. To view the Oracle-defined tasks, use the Type filter to select Oracle defined.

  Filtering List Results

  Use filters to limit the tasks in the list. Perform one of the following actions depending on the options that you see:

  • From the Search and Filter box above the list table, select one or more filters and specify the values that you want to use to narrow the list. In general, the filters correspond to the columns shown in the list table, although some filters represent attributes that aren't shown in the table. The Compartment filter is always displayed next to Applied filters.
  • On the left side of the list page, select a value from one of the available filters, such as compartment, state, or tags.

  Change the order of the items in the list table by using the sort icons next to the column names.

  Actions

  In the list table, select the name of a task to open its details page, where you can view its status and perform other tasks.

  To perform an action on a task directly from the list table, select an available option from the Actions menu () in the row for that task:

  • View details: Open the details page for the runbook task.
  • Copy OCID: Copy the OCID of the runbook task to the clipboard.
  • Edit: Edit the custom runbook task.
  • Copy task: Copy a custom runbook task.
  • Delete: Delete the custom runbook task.

  To create a runbook task, select Create task.

  To downloaded the discovery template that serves as a guide for coding the discovery script, select Download discovery output template.

  Note
  
  The success of executing discovery or patching scripts depends on the commands used by the scriptwriter and whether these commands are supported on your instance. If some commands fail, ensure you set up the host with the necessary installations before using the commands. For example, using commands such as mlocate or locate to find files.

  About Discovery Output Template

  The following are the details of the discovery output template attributes in Fleet Application Management.

  • targets: It contains targets for a specific product. A discovery runbook can return several targets for a product or product stack.
  • product: It's an optional attribute for a product's discovery runbook and mandatory for a product stack's discovery runbook because a stack can return several targets for different products. Therefore, Fleet Application Management needs to know the target belongs to which product of the stack. If you don't specify the product attribute for its discovery runbook, Fleet Application Management uses the product associated with the runbook to map the target to the product.
  • target_name: The target's home directory.
  • version: The version of the product.
  • properties: The properties of the product. Use these in the condition builder of the patching runbook to conditionally execute the task.
  • components: The components associated with the product. Use these in the condition builder of the patching runbook to conditionally execute a task.
  • component (properties): The properties of the component. Use these in the condition builder of the patching runbook to conditionally execute a task.
  • resource_name: The name of the Compute instance (optional).
  • installed_patches: It contains patches already installed on the target.
  • available_patches: It contains patches available for installation on the target (optional).

• Use the oci fleet-apps-management fleet-apps-management-runbooks task-record-collection list-task-records command to list runbook tasks:

  oci fleet-apps-management fleet-apps-management-runbooks task-record-collection list-task-records [OPTIONS]

  For a complete list of flags and variable options for Fleet Application Management CLI commands, see the CLI for Fleet Application Management.

• Run the ListTaskRecords operation to list runbook tasks.