thalesgroup.ciphertrust.connection_manager_azure module – Manage connections to the Azure cloud

Note

This module is part of the thalesgroup.ciphertrust collection (version 1.0.0).

To install it, use: ansible-galaxy collection install thalesgroup.ciphertrust.

To use it in a playbook, specify: thalesgroup.ciphertrust.connection_manager_azure.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

  • This is a Thales CipherTrust Manager module for working with the CipherTrust Manager APIs, more specifically with Connection Manager API for Azure

Parameters

Parameter

Comments

active_directory_endpoint

string

Azure stack active directory authority URL

Default: "none"

azure_stack_connection_type

string

Azure stack connection type

Default: "none"

azure_stack_server_cert

string

Azure stack server certificate

Default: "none"

cert_duration

integer

Duration in days for which the azure certificate is valid, default (730 i.e. 2 Years)

Default: 730

certificate

string

User has the option to upload external certificate for Azure Cloud connection. This option cannot be used with option is_certificate_used and client_secret.User first has to generate a new Certificate Signing Request (CSR) in POST /v1/connectionmgmt/connections/csr. The generated CSR can be signed with any internal or external CA. The Certificate must have an RSA key strength of 2048 or 4096. User can also update the new external certificate in the existing connection in Update (PATCH) API call. Any unused certificate will automatically deleted in 24 hours.

Default: "none"

client_id

string

Unique Identifier (client ID) for the Azure application

Default: "none"

client_secret

string

Secret key for the Azure application. Required in Azure Stack connection.

Default: "none"

cloud_name

string

Name of the cloud

Default: "none"

connection_id

string

Unique ID of the connection to be updated

Default: "none"

description

string

Description about the connection

Default: "none"

is_certificate_used

boolean

User has the option to choose the Certificate Authentication method instead of Client Secret for Azure Cloud connection. In order to use the Certificate, set it to true. Once the connection is created, in the response user will get a certificate. By default, the certificate is valid for 2 Years. User can update the certificate in the existing connection by setting it to true in Update (PATCH) API call.

Choices:

  • false

  • true

key_vault_dns_suffix

string

Azure stack key vault dns suffix

Default: "none"

localNode

dictionary / required

this holds the connection parameters required to communicate with an instance of CipherTrust Manager (CM)

holds IP/FQDN of the server, username, password, and port

password

string / required

admin password of CM

server_ip

string / required

CM Server IP or FQDN

server_port

integer / required

Port on which CM server is listening

Default: 5432

server_private_ip

string / required

internal or private IP of the CM Server, if different from the server_ip

user

string / required

admin username of CM

verify

boolean / required

if SSL verification is required

Choices:

  • false ← (default)

  • true

management_url

string

Azure stack management URL

Default: "none"

meta

dictionary

Optional end-user or service data stored with the connection

name

string / required

Unique connection name

Default: "none"

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

products

list / elements=string

Array of the CipherTrust products associated with the connection.

Default: ["none"]

resource_manager_url

string

Azure stack resource manager URL

Default: "none"

tenant_id

string

Tenant ID of the Azure application

Default: "none"

vault_resource_url

string

Azure stack vault service resource URL

Default: "none"

Examples

- name: "Create Azure Connection"
  thalesgroup.ciphertrust.connection_manager_azure:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: create
    name: azure-connection
    products:
      - cckm
    client_secret: 3bf0dbe6-a2c7-431d-9a6f-4843b74c71285nfjdu2
    cloud_name: AzureCloud
    client_id: 3bf0dbe6-a2c7-431d-9a6f-4843b74c7e12
    tenant_id: 3bf0dbe6-a2c7-431d-9a6f-4843b74c71285nfjdu2

- name: "Update Azure Connection"
  thalesgroup.ciphertrust.connection_manager_azure:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
    op_type: patch

Authors

  • Anurag Jain, Developer Advocate Thales Group