cloudera.cluster.external_account_info module – Retrieve external account details details.

Note

This module is part of the cloudera.cluster collection (version 5.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 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.external_account_info.

New in cloudera.cluster 5.0.0

Synopsis

  • Provides details for a specific account or retrieves all external accounts configured in Cloudera Manager.

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

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.

message

aliases: msg

string

Message to log for any changes to the entity.

Default: "Managed by Ansible"

name

string

The initial name of the account.

password

string / required

Password for access to the CM API endpoint.

This parameter is set to no_log.

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.

ssl_ca_cert

aliases: tls_cert, ssl_cert

path

Path to SSL CA certificate to use for validation.

type

string

The type of the external account.

Choices:

  • "AWS_ACCESS_KEY_AUTH"

  • "AWS_IAM_ROLES_AUTH"

  • "ALTUS_ACCESS_KEY_AUTH"

  • "ADLS_AD_SVC_PRINC_AUTH"

  • "BASIC_AUTH"

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"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platforms: all

Target OS/families that can be operated against

Examples

- name: Get all external accounts in Cloudera Manager
  cloudera.cluster.external_account_info:
    host: example.cloudera.com
    port: "7180"
    username: "jane_smith"
    password: "S&peR4Ec*re"

- name: Get all external accounts with type "AWS_ACCESS_KEY_AUTH"
  cloudera.cluster.external_account_info:
    host: example.cloudera.com
    port: "7180"
    username: "jane_smith"
    password: "S&peR4Ec*re"
    type: "AWS_ACCESS_KEY_AUTH"

- name: Get specific external account
  cloudera.cluster.external_account_info:
    host: example.cloudera.com
    port: "7180"
    username: "jane_smith"
    password: "S&peR4Ec*re"
    name: "aws_test_key"

Return Values

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

Key

Description

external_accounts

list / elements=dictionary

List of one or more external accounts within the cluster.

Returned: always

account_configs

list / elements=dictionary

The configuration options for this account.

Returned: always

created_time

string

The time of creation for this account.

Returned: always

display_name

string

A modifiable label to identify this account for user-visible purposes.

Returned: always

last_modified_time

string

The last modification time for this account.

Returned: always

name

string

Represents the initial name of the account.

Returned: always

type_name

string

The Type ID of a supported external account type.

Returned: always

Authors

  • Ronald Suplina (@rsuplina)