Oracle Cloud Infrastructure Documentation

Executing a Runbook

Select the runbooks to be executed on fleet resources for an active fleet and perform relevant lifecycle operations in Fleet Application Management.

Important

If the Fleet Application Management plugin needed for lifecycle operations is disabled outside of Fleet Application Management, it leads to a failure in execution. For example, if either the Fleet Application Management plugin or the OS Management Hub plugin isn't enabled on a resource managed by Fleet Application Management, this results in an error.

  • On the Fleets list page, select the fleet that you want to work with. If you need help finding the list page or the fleet, see Listing Fleets.

    On the fleet details page, select Actions and then select Execute Runbook.

    Executing a fleet runbook consists of the following pages:

    Run each of the following workflows in order. You can return to a previous page by selecting Previous.

    1. Adding runbooks

    The Add runbooks page is where you add the required runbooks for the fleet.

    1. For the Name, edit the name if required. By default, a hyphenated alphanumeric information comprising lifecycle operation with date and time of execution is set.
    2. Select Add runbook.
    3. In the Add runbook panel, select the runbooks that you want to include in the fleet.
      Note

      Only active runbooks are displayed for selection.
    4. Select a runbook version.
      All runbooks specific to patching, discovery, and custom lifecycle operations are available.
    5. Select Add runbook.
    6. To add runbooks from another compartment, select that compartment and repeat the preceding steps.
    After you add runbooks to the fleet, they appear in the Add runbook table. The runbooks are executed based on the execution order displayed on the table. You can perform the following actions:
    • Select the runbook name to get more details.
    • From the Actions menu (Actions Menu) in the row for that runbook, select an appropriate order to alter the execution order.
    Select Next to proceed to the next step.

    2. Runbook parameters

    The Runbook parameters page is where you enter one or more arguments for the runbook task if arguments were defined.

    • Argument name: Select the argument name associated with the runbook task if there were parameters associated with the runbook.
    • Argument value: To change the default argument value, enter an argument value.
    • Apply same value wherever applicable in a runbook: To apply the same argument value across runbook tasks, turn on this toggle. If you don't turn on the toggle, enter an argument name and value under Patch OS.

    Select Next to proceed to the next step.

    3. Review

    Review the contents of the Review page. Select Edit basic information to change settings.

    Select Edit runbooks to modify the runbook settings. For field descriptions, see Creating a Runbook.

    Select Edit parameters to modify the input and output variables of a task. For field descriptions, see Creating a Task.

    When the settings are fully verified, select Create.

    The runbook execution is initiated and you can find its progress from the Executions tab. See Listing Executions.

  • This task can't be performed using the CLI.

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

  • This task can't be performed using the API.