cloudera.cluster.cm_resource_info module – Retrieve resources from the Cloudera Manager API endpoint

Note

This module is part of the cloudera.cluster collection (version 4.4.0).

To install it, use: ansible-galaxy collection install cloudera.cluster. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cluster.cm_resource_info.

Synopsis

  • Retrieve resources from ad-hoc Cloudera Manager API endpoint paths, i.e. unimplemented API calls.

  • This module only supports the GET HTTP method.

  • To interact with ad-hoc/unimplemented API endpoints, use the cloudera.cluster.cm_resource module.

  • The module supports check_mode.

Requirements

The below requirements are needed on the host that executes this module.

  • cm_client

Parameters

Parameter

Comments

agent_header

aliases: user_agent

string

Set the HTTP user agent header when interacting with the CM API endpoint.

Default: "ClouderaFoundry"

debug

aliases: debug_endpoints

boolean

Capture the HTTP interaction logs with the CM API endpoint.

Choices:

  • false ← (default)

  • true

field

aliases: return_field

string

Field within the response for result extraction.

Use field when the returned object has an enclosing field.

Default: "items"

force_tls

boolean

Flag to force TLS during CM API endpoint discovery.

If False, discovery will first try HTTP and follow any redirects.

Choices:

  • false ← (default)

  • true

host

aliases: hostname

string

Hostname of the CM API endpoint.

If set, the host parameter will trigger CM API endpoint discovery, which will follow redirects.

Mutually exclusive with url.

password

string / required

Password for access to the CM API endpoint.

This parameter is set to no_log.

path

string / required

Path of the CM API endpoint call.

port

integer

Port of the CM API endpoint.

If set, CM API endpoint discovery will connect to the designated port first and will follow redirects.

Default: 7180

proxy_server

aliases: proxy, http_proxy

string

Set the HTTP/S proxy server when interacting with the CM API endpoint.

query

aliases: query_parameters, parameters

dictionary

HTTP query parameters for the CM API endpoint call.

ssl_ca_cert

aliases: tls_cert, ssl_cert

path

Path to SSL CA certificate to use for validation.

url

aliases: endpoint, cm_endpoint_url

string

The CM API endpoint URL and should include scheme, host, port, and API root path.

Mutually exclusive with host.

username

aliases: user

string / required

Username for access to the CM API endpoint.

verify_tls

boolean

Verify the TLS certificates for the CM API endpoint.

Choices:

  • false

  • true ← (default)

version

aliases: api_version

string

API version of the CM API endpoint.

Default: "True"

Examples

- name: Gather details about all Cloudera Manager users
  cloudera.cluster.cm_resource_info:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    path: "/users"
  register: cm_users

- name: Retrieve details for all running commands on a cluster using a custom SSL certificate
  cloudera.cluster.cm_resource_info:
    host: example.cloudera.com
    username: "jane_smith"
    password: "S&peR4Ec*re"
    ssl_ca_cert: "/path/to/ssl_ca.crt"
    path: "/cluster/example_cluster/commands"
  register: running_commands

Return Values

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

Key

Description

resources

list / elements=complex

The results from the Cloudera Manager API endpoint call.

If the field is found on the response object, its contents will be returned.

Returned: always

Authors

  • Webster Mudge (@wmudge)

Collection links