cloudera.cloud.env_info module – Gather information about CDP Environments

Note

This module is part of the cloudera.cloud collection (version 2.5.1).

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.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cloudera.cloud.env_info.

Synopsis

  • Gather information about CDP Environments

Requirements

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

  • cdpy

Parameters

Parameter

Comments

cdp_region

aliases: cdp_endpoint_region, endpoint_region

string

Specify the Cloudera Data Platform endpoint region.

Default: "default"

debug

aliases: debug_endpoints

boolean

Capture the CDP SDK debug log.

Choices:

  • false ← (default)

  • true

descendants

boolean

Gather information about descendant deployments such as Datahubs and Experiences

Choices:

  • false ← (default)

  • true

name

string

If a name is provided, that environment will be described

If no name is provided, all environments will be listed

profile

string

If provided, the CDP SDK will use this value as its profile.

verify_endpoint_tls

aliases: endpoint_tls

boolean

Verify the TLS certificates for the CDP endpoint.

Choices:

  • false

  • true ← (default)

Examples

# Note: These examples do not set authentication details.

# List basic information about all Environments
- cloudera.cloud.env_info:

# Gather detailed information about a named Environment
- cloudera.cloud.env_info:
    name: example-environment
    descendants: True

Return Values

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

Key

Description

environments

list / elements=complex

The information about the named Environment or Environments

Returned: on success

authentication

dictionary

Additional SSH key authentication configuration for accessing cluster node instances of the Environment.

Returned: always

loginUserName

string

SSH user name created on the node instances for SSH access.

Returned: always

Sample: "cloudbreak"

publicKey

string

SSH Public key string

Returned: when supported

Sample: "ssh-rsa AAAAB3NzaC...BH example-public-key"

publicKeyId

string

Public SSH key ID registered in the cloud provider.

Returned: when supported

Sample: "a_labeled_public_key"

awsDetails

dictionary

AWS-specific environment configuration information.

Returned: when supported

s3GuardTableName

string

The name for the DynamoDB table backing S3Guard.

Returned: always

Sample: "table_name"

cloudPlatform

string

Cloud provider of the Environment.

Returned: always

Sample: "['AWS', 'AZURE']"

credentialName

string

Name of the CDP Credential of the Environment.

Returned: always

Sample: "a-cdp-credential"

crn

string

CDP CRN value for the Environment.

Returned: always

Sample: "crn:cdp:environments:us-west-1:558bc1d2-8867-4357-8524-311d51259233:credential:61eb5b97-226a-4be7-b56d-795d18a043b5"

descendants

dictionary

Additional descriptions of all descendant Datahub or Experience Services

Contains a list of zero or more description objects for descendants found

Note that resolving this may be very slow, especially for a large list of environments

Returned: when requested

datahub

list / elements=string

List of descriptions of zero or more Datahubs in this Environment

Returned: success

dw

list / elements=string

List of descriptions of zero or more Datawarehouse Experiences in this Environment

Returned: success

ml

list / elements=string

List of descriptions of zero or more Machine learning Workspaces in this Environment

Returned: success

opdb

list / elements=string

List of descriptions of zero or more Operational Database Experiences in this Environment

Returned: success

description

string

Description of the Environment.

Returned: always

Sample: "An example Environment"

environmentName

string

Name of the Environment.

Returned: always

Sample: "a-cdp-environment-name"

freeipa

complex

Details of a FreeIPA instance in the Environment.

Returned: always

crn

string

CRN of the FreeIPA instance.

Returned: always

Sample: "crn:cdp:freeipa:us-west-1:558bc1d2-8867-4357-8524-311d51259233:freeipa:cbab8ee3-00f2-4958-90c1-6f7cc06b4937"

domain

string

Domain name of the FreeIPA instance.

Returned: always

Sample: "example.012345-abcd.cloudera.site"

hostname

string

Hostname of the FreeIPA instance.

Returned: always

Sample: "ipaserver"

serverIP

list / elements=string

IP addresses of the FreeIPA instance.

Returned: always

Sample: ["['10.10.2.40']"]

logStorage

complex

Storage configuration for cluster and audit logs for the Environment.

Returned: always

awsDetails

dictionary

AWS-specific log storage configuration details.

Returned: when supported

instanceProfile

string

AWS instance profile that contains the necessary permissions to access the S3 storage location.

Returned: always

Sample: "arn:aws:iam::381358652250:instance-profile/EXAMPLE-LOG_ROLE"

storageLocationBase

string

Base location to store logs in S3.

Returned: always

Sample: "s3a://example-bucket/datalake/logs"

azureDetails

dictionary

Azure-specific log storage configuration details.

Returned: when supported

managedIdentity

string

Azure managing identity associated with the logger.

This identify should have the Storage Blob Data Contributor role on the given storage account.

Returned: always

Sample: "/subscriptions/01234-56789-abcd/resourceGroups/example-environment-name/providers/ Microsoft.ManagedIdentity/userAssignedIdentities/loggerIdentity"

storageLocationBase

string

Base location to store logs in Azure Blob Storage.

Returned: always

Sample: "abfs://logs@example_location.dfs.core.windows.net"

enabled

boolean

Flag for external log storage.

Returned: always

network

complex

Network details for the Environment

Returned: always

aws

dictionary

AWS networking specifics for the Environment.

Returned: when supported

vpcId

string

VPC identifier.

Returned: always

Sample: "vpc-08785c81e888251df"

azure

dictionary

Azure networking specifics for the Environment.

Returned: when supported

networkId

string

VNet identifier.

Returned: always

Sample: "example-vnet"

resourceGroupName

string

Resource Group name.

Returned: always

Sample: "example-rg"

usePublicIp

boolean

Flag for associating public IP addresses to the resources within the network.

Returned: always

gcp

dictionary

Google networking specifics for the Environment.

Returned: when supported

networkName

string

VNet identifier.

Returned: always

Sample: "example-vnet"

sharedProjectId

string

The Id of the Google project associated with the VPC.

Returned: always

Sample: "my-project"

usePublicIp

boolean

Flag for associating public IP addresses to the resources within the network.

Returned: always

networkCidr

string

Range of private IPv4 addresses that resources will use for the Environment.

Returned: always

Sample: "10.10.0.0/16"

subnetIds

list / elements=string

Subnet identifiers for the Environment.

Returned: always

Sample: ["['subnet-04a332603a269535f', 'subnet-07bbea553ca667b66', 'subnet-0aad7d6d9aa66d1e7']"]

subnetMetadata

complex

Additional subnet metadata for the Environment.

Returned: always

__subnetId__

dictionary

Keyed subnet identifier.

Returned: always

availabilityZone

string

Availability zone (AWS only)

Returned: when supported

Sample: "us-west-2a"

subnetId

string

Identifier for the subnet

Returned: always

Sample: "subnet-04a332603a269535f"

subnetName

string

Name of the subnet

Returned: always

Sample: "subnet-04a332603a269535f"

proxyConfig

dictionary

Proxy configuration of the Environment.

Returned: when supported

crn

string

CDP CRN for the proxy configuration.

Returned: always

Sample: "crn:cdp:environments:us-west-1:558bc1d2-8867-4357-8524-311d51259233:credential:38eeb2b9-6e57-4d10-ad91-f6d9bceecb54"

description

string

Description of the proxy..

Returned: always

Sample: "The proxy configuration description"

host

string

Proxy host.

Returned: always

Sample: "some.host.example.com"

password

string

Proxy user password.

Returned: always

Sample: "secret_password"

port

string

Proxy port.

Returned: always

Sample: "8443"

protocol

string

Proxy protocol.

Returned: always

Sample: "https"

proxyConfigName

string

Name of the proxy configuration.

Returned: always

Sample: "the-proxy-config"

user

string

Proxy user name.

Returned: always

Sample: "the_username"

region

string

Cloud provider region of the Environment.

Returned: always

Sample: "us-east-1"

securityAccess

dictionary

Security control configuration for FreeIPA and Datalake deployment in the Environment.

Returned: always

cidr

string

CIDR range which is allowed for inbound traffic. Either IPv4 or IPv6 is allowed.

Returned: when supported

Sample: "0.0.0.0/0"

defaultSecurityGroupId

string

Security group associated with Knox-enabled hosts.

Returned: when supported

Sample: "/subscriptions/01234-56789-abcd/resourceGroups/example-environment/providers/Microsoft.Network/ networkSecurityGroups/example-default-nsg"

securityGroupIdForKnox

string

Security group associated with all other hosts (non-Knox).

Returned: when supported

Sample: "/subscriptions/01234-56789-abcd/resourceGroups/example-environment/providers/Microsoft.Network/ networkSecurityGroups/example-knox-nsg"

status

string

Status of the Environment.

Returned: always

Sample: "['AVAILABLE', 'CREATE_FAILED', 'CREATION_INITIATED', 'ENV_STOPPED', 'FREEIPA_CREATION_IN_PROGRESS', 'FREEIPA_DELETE_IN_PROGRESS', 'FREEIPA_DELETED_ON_PROVIDER_SIDE', 'START_FREEIPA_FAILED', 'STOP_FREEIPA_STARTED']"

statusReason

string

Description for the status code of the Environment.

Returned: when supported

sdk_out

string

Returns the captured CDP SDK log.

Returned: when supported

sdk_out_lines

list / elements=string

Returns a list of each line of the captured CDP SDK log.

Returned: when supported

Authors

  • Webster Mudge (@wmudge)

  • Dan Chaffelson (@chaffelson)

  • Christian Leroy