Please Note:

Server Message Block (SMB)

SMB connections to the CipherTrust Manager can be configured using the following:

Managing SMB Connections using GUI
Managing SMB Connections using ksctl

Managing SMB Connections using GUI

Note

The SMB connections are supported in the root domain only.

Username - username to access the SMB share.
Password - password to access the SMB share.
Host - IP or FQDN of the SMB share server.
Port - the port where the SMB service is running on the host.
Domain - workgroup or domain under which the username is configured. It is an optional field.
Path - path to the file-share for which the credentials need to be tested. It is only required to test the connections.

Note

The Common Internet File System (CIFS) is a dialect of SMB.

Click Next to move to the next step.

Managing SMB Connections using ksctl

The following operations can be performed:

Create/Get/Update/Delete an SMB connection
List all SMB connections
Test an existing SMB connection

Creating a SMB Connection

To create a SMB connection, run:

Syntax

ksctl connectionmgmt smb create --name <Connection-Name> --host <Hostname> --port <Port> --Username <SMB-Connection-Username> ---conn-password  <SMB-Connection-Password>

Example Request

ksctl connectionmgmt smb create --name smbConnection1 --host xx.xxx.xxx.xxx --port 445 --username test1 --conn-password 1234

Example Response

{
    "id": "5b32eb85-5c8e-4416-a749-b0b0b8916213",
    "uri": "kylo:kylo:connectionmgmt:connections:smbconnection1-5b32eb85-5c8e-4416-a749-b0b0b8916213",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2021-02-03T08:49:10.5042906Z",
    "updatedAt": "2021-02-03T08:49:10.502989201Z",
    "service": "SMB",
    "category": "File-Share",
    "last_connection_ok": null,
    "last_connection_at": "0001-01-01T00:00:00Z",
    "name": "smbConnection1",
    "username": "test1",
    "host": "xx.xxx.xxx.xxx",
    "Port": "445"
}

Getting Details of a SMB Connection

To get details of a SMB connection, run:

Syntax

ksctl connectionmgmt smb get --id <Connection-Name/ID>

Example Request

ksctl connectionmgmt smb get --id 7ee52a57-19d4-4202-b900-edd299bb6d7a

Example Response

{
    "id": "7ee52a57-19d4-4202-b900-edd299bb6d7a",
    "uri": "kylo:kylo:connectionmgmt:connections:smbconnection-7ee52a57-19d4-4202-b900-edd299bb6d7a",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2021-02-03T03:55:03.541011Z",
    "updatedAt": "2021-02-03T03:55:03.538119Z",
    "service": "SMB",
    "category": "File-Share",
    "last_connection_ok": null,
    "last_connection_at": "0001-01-01T00:00:00Z",
    "name": "smbConnection",
    "products": [
        "CTE"
    ],
    "description": "a description of the connection",
    "username": "user",
    "domain": "domainName",
    "host": "1.2.3.4",
    "Port": "445"
}

Updating a SMB Connection

To update a SMB connection, run:

Syntax

ksctl connectionmgmt smb modify --id <Connection-Name/ID> --products <Product-Names> --conn-password <SMB-Connection-Password> --meta <Key-Values>

Example Request

ksctl connectionmgmt smb modify --id 7ee52a57-19d4-4202-b900-edd299bb6d7a --conn-password 1234 --username test2

Example Response

{
    "id": "7ee52a57-19d4-4202-b900-edd299bb6d7a",
    "uri": "kylo:kylo:connectionmgmt:connections:smbconnection-7ee52a57-19d4-4202-b900-edd299bb6d7a",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2021-02-03T03:55:03.541011Z",
    "updatedAt": "2021-02-03T08:58:21.490072287Z",
    "service": "SMB",
    "category": "File-Share",
    "last_connection_ok": null,
    "last_connection_at": "0001-01-01T00:00:00Z",
    "name": "smbConnection",
    "products": [
        "CTE"
    ],
    "meta": "",
    "description": "a description of the connection",
    "host": "1.2.3.4",
    "domain": "domainName",
    "username": "test2",
    "port": "445"
}

Deleting a SMB Connection

To delete a SMB connection, run;

Syntax

ksctl connectionmgmt smb delete --id <Connection-Name/ID>

Example Request

ksctl connectionmgmt smb delete --id 7ee52a57-19d4-4202-b900-edd299bb6d7a

There will be no response if SMB connection is deleted successfully.

Getting List of SMB Connections

To list all the SMB connections, run:

Syntax

ksctl connectionmgmt smb list

Example Request

ksctl connectionmgmt smb list

Example Response

{
    "skip": 0,
    "limit": 10,
    "total": 2,
    "resources": [
        {
            "id": "5b32eb85-5c8e-4416-a749-b0b0b8916213",
            "uri": "kylo:kylo:connectionmgmt:connections:smbconnection1-5b32eb85-5c8e-4416-a749-b0b0b8916213",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2021-02-03T08:49:10.504291Z",
            "updatedAt": "2021-02-03T08:49:10.502989Z",
            "service": "SMB",
            "category": "File-Share",
            "last_connection_ok": null,
            "last_connection_at": "0001-01-01T00:00:00Z",
            "name": "smbConnection1",
            "username": "test1",
            "host": "xx.xxx.xxx.xxx",
            "Port": "445"
        },
        {
            "id": "7ee52a57-19d4-4202-b900-edd299bb6d7a",
            "uri": "kylo:kylo:connectionmgmt:connections:smbconnection-7ee52a57-19d4-4202-b900-edd299bb6d7a",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2021-02-03T03:55:03.541011Z",
            "updatedAt": "2021-02-03T03:55:03.538119Z",
            "service": "SMB",
            "category": "File-Share",
            "last_connection_ok": null,
            "last_connection_at": "0001-01-01T00:00:00Z",
            "name": "smbConnection",
            "products": [
                "CTE"
            ],
            "description": "a description of the connection",
            "username": "user",
            "domain": "domainName",
            "host": "1.2.3.4",
            "Port": "445"
        }
    ]
}

Testing an Existing SMB Connection

To test an existing SMB connection, run;

Syntax

ksctl connectionmgmt smb test --id <Connection-Name/ID> --share-path <Share-Path>

ksctl connectionmgmt smb test --host <Hostname> --port <Port> --username <SMB-Connection-Username> --conn-password <SMB-Connection-Password> --share-path <Share-Path>

Example Request 1

ksctl connectionmgmt smb test --id 7ee52a57-19d4-4202-b900-edd299bb6d7a --share-path shared

Example Response 1

{
    "connection_ok": true
}

Example Request 2

ksctl connectionmgmt smb test --host xx.xxx.xxx.xxx --port 445 --username test1 --conn-password 1234 --share-path shared

Example Response 2

{
    "connection_ok": true
}

Server Message Block (SMB)

Managing SMB Connections using GUI

Managing SMB Connections using ksctl

Creating a SMB Connection

Getting Details of a SMB Connection

Updating a SMB Connection

Deleting a SMB Connection

Getting List of SMB Connections

Testing an Existing SMB Connection

On this page

Suggest A Change