cloudera.services.ml_project_job_run_info module – Retrieve information about Cloudera Machine Learning (CML) project job runs

Note

This module is part of the cloudera.services collection (version 1.0.0).

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 git+https://github.com/cloudera-labs/cloudera.services.git.

To use it in a playbook, specify: cloudera.services.ml_project_job_run_info.

New in cloudera.services 1.0.0

Synopsis

  • Retrieve information about one or more runs of a Cloudera Machine Learning (CML) project job.

  • The module can list all runs of a job or filter by a number of criteria.

  • The module supports check_mode.

Parameters

Parameter

Comments

api_key

aliases: token

string / required

The CML API key (bearer token) used to authenticate to the Workspace API.

If not set, the value of the CML_API_KEY environment variable is used.

client_cert

path

The path to a client certificate for authenticating to the API endpoint.

client_key

path

The path to a client key for authenticating to the API endpoint.

creator

dictionary

Filter the job runs by creator details.

email

string

The email address of the creator.

name

string

The display name of the creator.

username

string

The username of the creator.

debug

aliases: debug_endpoints

boolean

A flag to enable debug logging of the module’s execution.

Choices:

  • false ← (default)

  • true

force

boolean

A flag to force a refresh of the API request, ignoring any cached results.

Choices:

  • false ← (default)

  • true

force_basic_auth

boolean

A flag to force basic authentication for API requests.

Choices:

  • false ← (default)

  • true

http_agent

aliases: user_agent

string

The User-Agent string to send with API requests.

Default: "cloudera-services-module"

id

aliases: run_id

string

The unique identifier of a single job run to retrieve.

job_id

string

The unique identifier of the enclosing job.

Mutually exclusive with job_name.

job_name

string

The name of the enclosing job.

Mutually exclusive with job_id.

page_size

aliases: default_page_size

integer

The number of items to return per page in a paginated API response.

Default: 100

project_id

string

The unique identifier of the enclosing project for the job.

Mutually exclusive with project_name.

project_name

string

The name of the enclosing project for the job.

Mutually exclusive with project_id.

status

string

Filter the job runs by status.

Choices:

  • "scheduling"

  • "starting"

  • "running"

  • "stopping"

  • "stopped"

  • "succeeded"

  • "failed"

  • "timedout"

  • "unknown"

timeout

aliases: timeout_seconds

integer

The timeout in seconds for any API requests.

Default: 60

url

aliases: endpoint, endpoint_url, workspace_url

string / required

The base URL of the CML Workspace API endpoint, including the port if necessary.

If not set, the value of the CML_ENDPOINT environment variable is used.

url_password

string

The password for authenticating to the API endpoint.

url_username

string

The username for authenticating to the API endpoint.

use_gssapi

boolean

A flag to enable or disable GSSAPI authentication for API requests.

Choices:

  • false ← (default)

  • true

use_proxy

boolean

A flag to enable or disable the use of a proxy for API requests.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

A flag to enable or disable SSL certificate validation for API requests.

Choices:

  • false

  • true ← (default)

Examples

- name: List all runs of a job
  cloudera.services.ml_project_job_run_info:
    url: "https://ml-workspace.example.com"
    api_key: "{{ cml_api_key }}"
    project_name: my-project
    job_name: nightly-etl
  register: all_runs

- name: Get a single job run by id
  cloudera.services.ml_project_job_run_info:
    project_id: "{{ project_id }}"
    job_id: "{{ job_id }}"
    id: "{{ run_id }}"

- name: List failed runs of a job
  cloudera.services.ml_project_job_run_info:
    project_name: my-project
    job_name: nightly-etl
    status: failed

- name: List runs created by a user
  cloudera.services.ml_project_job_run_info:
    project_name: my-project
    job_name: nightly-etl
    creator:
      username: jdoe

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

job_runs

list / elements=dictionary

List of CML job runs.

Returned: always

arguments

string

The command-line arguments passed to the job run.

Returned: when available

created_at

string

The timestamp when the job run was created.

Returned: when available

creator

dictionary

Details of the user that started the job run.

Returned: when available

environment

dictionary

The environment variables of the job run.

Returned: when available

finished_at

string

The timestamp when the job run finished.

Returned: when available

id

string

The unique identifier of the job run.

Returned: always

job_id

string

The identifier of the enclosing job.

Returned: when available

project_id

string

The identifier of the enclosing project.

Returned: when available

scheduling_at

string

The timestamp when the job run was scheduled.

Returned: when available

starting_at

string

The timestamp when the job run started.

Returned: when available

status

string

The status of the job run.

Returned: when available

sdk_out

string

Returns the captured REST API log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured REST API log.

Returned: when supported

Authors

  • Webster Mudge (@wmudge)