thalesgroup.ciphertrust.connection_manager_scp module – Manage SCP connections to external systems
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_scp
.
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 SCP
Parameters
Parameter |
Comments |
---|---|
Authentication type for SCP. Accepted values are “key” or “password” Default: |
|
Unique ID of the connection to be updated Default: |
|
Description about the connection Default: |
|
Hostname or FQDN of SCP Default: |
|
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 |
|
admin password of CM |
|
CM Server IP or FQDN |
|
Port on which CM server is listening Default: |
|
internal or private IP of the CM Server, if different from the server_ip |
|
admin username of CM |
|
if SSL verification is required Choices:
|
|
Optional end-user or service data stored with the connection |
|
Unique connection name Default: |
|
Operation to be performed Choices:
|
|
Password for SCP Default: |
|
A path where the file to be copied via SCP. Example “/home/ubuntu/datafolder/” Default: |
|
Port where SCP service runs on host (usually 22) Default: |
|
Array of the CipherTrust products associated with the connection. Default: |
|
Public key of destination host machine. It will be used to verify the host’s identity by verifying key fingerprint. You can find it in /etc/ssh/ at host machine. Default: |
|
Username for accessing SCP Default: |
Examples
- name: "Create SCP Connection"
thalesgroup.ciphertrust.connection_manager_scp:
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: "Syslog Connection"
products:
- backup/restore
host: 1.2.3.4
port: 22
username: user
auth_method: Password
password: password
path_to: "/home/path/to/directory/"
public_key: "key"
- name: "Update SCP Connection"
thalesgroup.ciphertrust.connection_manager_scp:
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