recurring.playbook

Available methods

Description

Provides methods to handle recurring ansible playbook execution for minions, system groups and organizations.

Namespace:

recurring.playbook

Method: create

HTTP POST

Description:

Create a new recurring Ansible playbook action.

Parameters:

  • string sessionKey

  • struct actionProps

    • int "entity_id" - the ID of the target entity

    • string "name" - the name of the recurring action

    • string "cron_expr" - the execution frequency of the action as a cron expression

    • string "extra_vars" - extra variables to override existing vars or create new ones (optional)

    • boolean "flush_cache" - whether the Ansible cache should be flushed (optional)

    • string "inventory_path" - the path to the configured Ansible inventory

    • string "playbook_path" - the path to the playbook to be executed

    • boolean "test" - whether the action should be executed in test mode (optional)

Returns:

  • int id - the ID of the newly created recurring action

Method: update

HTTP POST

Description:

Update a recurring Ansbile playbook action.

Parameters:

  • string sessionKey

  • struct actionProps

    • int "id" - the ID of the action to update

    • string "name" - the name of the action (optional)

    • string "cron_expr" - the execution frequency of the action (optional)

    • string "extra_vars" - extra variables to override existing vars or create new ones (optional)

    • boolean "flush_cache" - whether the Ansible cache should be flushed (optional)

    • string "inventory_path" - the path to the configured Ansible inventory (optional

    • string "playbook_path" - the path to the playbook to be executed (optional)

    • boolean "test" - whether the action should be executed in test mode (optional)

    • boolean "active" - whether the action should be active (optional)

Returns:

  • int id - the ID of the updated recurring action