Connector CLI utility

This topic describes how to use the Connector CLI utility to manage connectors and view information about its status.

Run the Connector CLI utility

Run the following command to start the Connector CLI utility:

 

remote-access-cli

This utility has the commands listed below.

 

This list is constantly being improved. Use the "help" command to view an updated list.

Built-in commands

Command

Description

clear

Clear the shell screen

exit, quit

Exit the shell

help

Display help about available commands

history

Display or save the history of previously run commands

script

Read and execute commands from a file

Login commands

Command

Description

Options

init

Initialize connector

 

login

Login to the Remote Access connector

 

reset

Hard reset the Remote Access connector

The reset function removes all configurations from your connector, including logs, certificates, vendors, applications, etc.

--full or -f - Use if you intend to use this connector for another tenant
(Optional. Default = false)

Settings commands

Command

Description

Options

request-ad-settings

Request AD settings

 

request-apps

Request applications

 

request-vendors

Request vendors and groups

 

set-message-colors

Set the foreground and background colors for error and warning messages in the CLI utility.

Values for messages:

1 - Error message

2 - Warning message

Values for colors:

0 - Black

1 - Red

2 - Green

3 - Yellow

4 - Blue

5 - Magenta

6 - Cyan

7 - White

-r or --reset: reset to defaults

Mandatory: no

show-ad-settings

Show AD settings

 

show-apps

Show applications

 

show-groups

Show groups

-l or --ldap - Get groups from LDAP
(Optional. Default = false)

show-status

Show status

 

show-vendors

Show vendors

show-users [-g] [-l] [-a]

-g or --groups - Use to see user group names
(Optional. Default = false)

-l or --ldap - Get users from LDAP
(Optional. Default = false)

-a or --all - Use to see currently inactive provisioned users
(Optional. Default = false)

show-version

Show CLI version

 

verify-ad-settings

Verify AD settings

 

Support commands

Command Description

Options

check-time

Check time difference with Remote Access service

 

check-url

Check url availability

--url string - Specify full url (e.g., https://www.google.com)
(Mandatory)

get-logs

Get connector logs and create a bundled .tar.gz

-d or --dir string - Specify directory to save the logs
(Optional. Default = /home/cyberark/snap/remote-access-cli/common/savedLogs/remote-access-clilogs.<TIMESTAMP>.tar.gz)

-f or --full - Use to retrieve full logs
(Optional. Default = false)

restart

Restart the Remote Access connector

 

set-log-level

Set logging level

set-log-level [--reset] [[--connector] string] [[--rproxy] string] [[--ldap] int]

-r or --reset - Reset to default
(Optional. Default = false)

-c or --connector - Set connector log level (info|debug|trace)
(Optional)

-p or --rproxy - Set reverse proxy log level (warn|info|debug)
(Optional)

-l or --ldap - Set ldap log level
(Optional. Default = 0)

show-proxy

Get the Remote Access connector proxy settings

 

VendorLDAP commands

Command

Description

Options

configure-core-pas

Configure Remote Access Directory in PVWA

 

init-ldap

Set LDAP configuration

 

show-ldap-config

Show LDAP configuration

-p or --showPassword - Use to see clear text bind user password
(Optional, Default = false)

stop-ldap

Delete LDAP configuration

 

update-ldap

Refresh LDAP configuration