Skip to content

Commands examples

This page lists some useful CLI examples.

Note

You can disable certificate validation for login to an authenticator using the --disable-certificate-verification flag. This option is not recommended.

Useful environment variables

  • ARK_PROFILE: Sets the profile to be used across the CLI
  • ARK_DISABLE_CERTIFICATE_VERIFICATION: Disables certificate verification for REST APIs

Configure command example

The configure command works in interactive or silent mode. When using silent mode, the required parameters need to specified. Here's an example of configuring ISP in silent mode:

ark configure --profile-name="PROD" --work-with-isp --isp-username="tina@cyberark.cloud.12345" --silent --allow-output

Login commands Example

The login command can work in interactive or silent mode. Here's an example of a silent login with the profile configured in the example above: 

ark login -s --isp-secret=CoolPasswordß

Exec command examples

Use the --help flag to view all exec options.

Add DPA database secret

ark exec dpa secrets db add-secret --secret-name mysecret --secret-type username_password --username user --password mypass

Delete DPA database secret

ark exec dpa secrets db delete-secret --secret-name mysecret

Add DPA database

ark exec dpa workspaces db add-database --name mydb --provider-engine postgres-sh --read-write-endpoint myendpoint.domain.com

List DPA databases

ark exec dpa workspaces db list-databases

Get VM policies stats

ark exec dpa policies vm policies-stats

Edit policies interactively example

This example shows how to locally work with a policies workspace, and edit, reset, and create policies that are applied to both databases and VM policies. After the local policies are ready, you can commit all the policies changes to the remote workspace.

To load and reload policies locally:

ark exec dpa policies vm editor load-policies

After loading the policies, use these commands to edit them: 

1
2
3
4
5
6
ark exec dpa policies vm editor edit-policies
ark exec dpa policies vm editor view-policies
ark exec dpa policies vm editor reset-policies
ark exec dpa policies vm editor generate-policy
ark exec dpa policies vm editor remove-policies
ark exec dpa policies vm editor policies diff

When they are ready to be committed, run: 

ark exec dpa policies vm editor commit-policies

Generate a short-lived SSO password for a database connection

ark exec dpa sso short-lived-password

Generate a short-lived SSO Oracle wallet for an Oracle database connection

ark exec dpa sso short-lived-oracle-wallet --folder ~/wallet

Generate a kubectl config file

ark exec dpa k8s generate-kubeconfig

Generate a kubectl config file and save it in the specified path

ark exec dpa k8s generate-kubeconfig --folder=/Users/My.User/.kube

List All Session Monitoring sessions from the last 24 hours

1
ark exec sm list-sessions

Count All Session Monitoring sessions from the last 24 hours

1
ark exec sm count-sessions

List All Session Monitoring sessions matching Search Query

1
ark exec sm list-sessions-by --search 'startTime ge 2023-12-03T08:55:29Z AND sessionDuration GE 00:00:01 AND protocol IN SSH,RDP,Database'

Count All Session Monitoring sessions matching Search Query

1
ark exec sm count-sessions-by --search 'startTime ge 2023-12-03T08:55:29Z AND sessionDuration GE 00:00:01 AND protocol IN SSH,RDP,Database'

Count All Session Monitoring sessions from the last 24 hours

1
ark exec sm count-sessions

Retrieve a session by id

1
ark exec sm session --session-id 5e62bdb8-cd81-42b8-ac72-1e06bf9c496d

List all session activities

1
ark exec sm list-session-activities --session-id 5e62bdb8-cd81-42b8-ac72-1e06bf9c496d

Count all session activities

1
ark exec sm count-session-activities --session-id 5e62bdb8-cd81-42b8-ac72-1e06bf9c496d

List all session activities with specific command

1
ark exec sm list-session-activities-by --session-id 5e62bdb8-cd81-42b8-ac72-1e06bf9c496d --command-contains 'ls'

Count all session activities with specific command

1
ark exec sm count-session-activities-by --session-id 5e62bdb8-cd81-42b8-ac72-1e06bf9c496d --command-contains 'ls'

Display general sessions statistics from the last 30 days

1
ark exec sm sessions-stats

List all identity entities, including roles users and groups

1
ark exec identity directories list-directories-entities

List only identity roles

1
ark exec identity directories list-directories-entities --entity-types ROLE

Create a role with DPA show tile admin right

1
ark exec identity roles create-role --role-name RoleName --admin-rights "ServiceRight/dpaShowTile"

Delete a role by name

1
ark exec identity roles delete-role --role-name RoleName

Create a new user

1
ark exec identity users create-user --username myname --email email@email.com --password MyPassword

Delete a user by name

1
ark exec identity users delete-user --username myname

Add an authentication profile

1
ark exec identity policies add-authentication-profile --auth-profile-name myprofile --first-challenges UP --second-challenges EMAIL

Add a policy

1
ark exec identity policies add-policy --policy-name mypolicy --role-names RoleName --auth-profile-name myprofile

Create a PCloud Safe

1
ark exec pcloud safes add-safe --safe-name=safe

Create a PCloud Account

1
ark exec pcloud accounts add-account --name account --safe-name safe --platform-id='UnixSSH' --username root --address 1.2.3.4 --secret-type=password --secret mypass

List available platforms

1
ark exec pcloud platforms list-platforms