CIFS/SMB

CIFS/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

• Host - IP or FQDN of the SMB share server.

• Port - the port where the SMB service is running on the host.

  Note

  The Host and Port fields must be specified together, or do not specify any of them. If Host and Port are not specified while creating a connection, these fields cannot be added later.

• Username - username to access the SMB share.

• Password - password to access the SMB share.

• Domain - workgroup or domain under which the username is configured. It is an optional field.

Click Next to move to the Add Products screen of the Add Connection wizard.

Managing SMB Connections using ksctl

The following operations can be performed:

• Create/Get/Update/Delete an SMB connection

• List all SMB connections

Creating an SMB Connection

To create an 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 an SMB Connection

To get details of an 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 an SMB Connection

To update an 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 an SMB Connection

To delete an 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"
        }
    ]
}