azure.azcollection.azure_rm_openshiftmanagedcluster_info module – Get Info onf Azure Red Hat OpenShift Managed Cluster

Note

This module is part of the azure.azcollection collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. 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 azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_openshiftmanagedcluster_info.

New in azure.azcollection 1.11.0

Synopsis

• Create, update and delete instance of Azure Red Hat OpenShift Managed Cluster instance.

Requirements

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

• python >= 2.7

• The host that executes this module must have the azure.azcollection collection installed via galaxy

• All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

• Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack. Default: "latest"
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The msi was added in Ansible 2.6. Choices: "auto" ← (default) "cli" "credential_file" "env" "msi"
cert_validation_mode string added in azure.azcollection 0.0.1	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. Choices: "ignore" "validate"
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the AZURE_CLIENT_ID environment variable.
cloud_environment string added in azure.azcollection 0.0.1	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. Default: "AzureCloud"
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable. Choices: false ← (default) true
log_mode string	Parent argument.
log_path string	Parent argument.
name string	Resource name.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string	The name of the resource group.
secret string	Azure client secret. Use when authenticating with a Service Principal.
subscription_id string	Your Azure subscription Id.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

Notes

Note

• For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

• Authentication is also possible using a service principal or Active Directory user.

• To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

• To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

• Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: List all Azure Red Hat OpenShift Managed Clusters for a given subscription
  azure_rm_openshiftmanagedcluster_info:
- name: List all Azure Red Hat OpenShift Managed Clusters for a given resource group
  azure_rm_openshiftmanagedcluster_info:
    resource_group: myResourceGroup
- name: Get Azure Red Hat OpenShift Managed Clusters
  azure_rm_openshiftmanagedcluster_info:
    resource_group: myResourceGroup
    name: myAzureFirewall

Return Values

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

Key	Description
id string	Resource ID. Returned: always Sample: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.RedHatOpenShift/openShiftClusters/mycluster"
location string	Resource location. Returned: always Sample: "eatus"
name string	Resource name. Returned: always Sample: "mycluster"
properties complex	Properties of a OpenShift managed cluster. Returned: always
apiserverProfile complex	API server configuration. Returned: always
visibility string	api server visibility. Returned: always Sample: "Public"
clusterProfile complex	Configuration for Openshift cluster. Returned: always
domain string	Domain for the cluster. Returned: always Sample: "mycluster"
fipsValidatedModules string	If FIPS validated crypto modules are used Returned: always Sample: "Enabled"
resourceGroupId string	The ID of the cluster resource group. Returned: always Sample: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus-cluster"
version string	Openshift version. Returned: always Sample: "4.4.17"
ingressProfiles list / elements=string	Ingress configruation. Returned: always Sample: [{"name": "default", "visibility": "Public"}]
masterProfile complex	Configuration for OpenShift master VMs. Returned: always
disk_encryption_set_id string	The resource ID of an associated DiskEncryptionSet, if applicable. Returned: successd
encryptionAtHost string	Whether master virtual machines are encrypted at host. Returned: always Sample: "Disabled"
subnetId string	The Azure resource ID of the master subnet (immutable). Returned: always Sample: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker"
vmSize string	Size of agent VMs (immutable). Returned: always Sample: "Standard_D8s_v3"
networkProfile complex	Configuration for OpenShift networking. Returned: always
outboundType string	The OutboundType used for egress traffic. Returned: always Sample: "Loadbalancer"
podCidr string	CIDR for the OpenShift Pods. Returned: always Sample: "10.128.0.0/14"
preconfiguredNSG string	Specifies whether subnets are pre-attached with an NSG Returned: always Sample: "Disabled"
serviceCidr string	CIDR for OpenShift Services. Returned: always Sample: "172.30.0.0/16"
provisioningState string	The current deployment or provisioning state, which only appears in the response. Returned: always Sample: "Creating"
servicePrincipalProfile complex	Service principal. Returned: always
clientId string	Client ID of the service principal. Returned: always Sample: "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx"
workerProfiles complex	Configuration of OpenShift cluster VMs. Returned: always
count integer	Number of agents (VMs) to host docker containers. Returned: always Sample: 3
diskSizeGB integer	disk size in GB. Returned: always Sample: 128
encryptionAtHost string	Whether worker virtual machines are encrypted at host. Returned: always Sample: "Disabled"
name string	Unique name of the pool profile in the context of the subscription and resource group. Returned: always Sample: "worker"
subnetId string	Subnet ID for worker pool. Returned: always Sample: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker"
vmSize string	Size of agent VMs. Returned: always Sample: "Standard_D4s_v3"
type string	Resource type. Returned: always Sample: "Microsoft.RedHatOpenShift/openShiftClusters"

Authors

• Paul Czarkowski (@paulczar)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)