This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Accessing the PPC CLI

The Protegrity Provisioned Cluster (PPC) CLI provides a command-line interface for managing policies, users, and log forwarding. Access is established over SSH using the private key generated during the PPC installation.

1 - Prerequisites

The deployment includes a CLI container that provides command-line access to the Protegrity Management CLI using SSH, on both Linux and Windows.

To access the PPC CLI, ensure that the following prerequisites are met.

  • SSH Keys: The SSH private key that corresponds to the public key configured in the pty-cli pod is required.

  • Network Access: Ensure to have network connectivity to the cluster.

  • Resolve FQDN: Use Route 53 configuration on AWS to resolve the PPC FQDN specified during the installation to the internal load balancer. For more information, refer to Prerequisites.

The private key to access the CLI pod will be in the .ssh directory.

From the .ssh/ directory:

ssh -i /home/admin/.ssh/<cluster_name>_user_svc ptyitusr@<user-provided-fqdn>

The private key to access the CLI pod will be in the .ssh directory. Copy the key file to a directory on the local Windows machine.

  • Using Windows SSH Client (Windows 10/11 with OpenSSH):

    ssh -i C:\path\to\copied\file\.ssh -p 22 ptyitusr@<user-provided-fqdn>

  • Using PuTTY:

    • Host Name: <user-provided-fqdn>
    • Port: 22
    • Connection Type: SSH
    • Under Connection > SSH > Auth, browse and select your private key file (.ppk format)
    • Username: ptyitusr

2 - Accessing the PPC CLI

Once connected, the Protegrity CLI welcome banner is displayed. Enter the following parameters when prompted:

  • Username: Application username
  • Password: Application password

For more information about the default credentials, refer to the Release Notes.

The CLI supports three main command categories:

  • pim: Policy Information Management commands for data protection policies.
  • admin: User, Role, Permission, and Group management commands.
  • insight: Log forwarding to external SIEM and syslog servers.

Note: Ensure that at least one additional backup administrator user is configured with the same administrative privileges as the primary admin user.
If the primary admin account is locked or its credentials are lost, restoring the system from a backup is the only recovery option.