# Endpoint Privilege Manager Commands

## Overview

Endpoint Privilege Manager is an advanced Privileged Elevation and Delegation Management (PEDM) solution that provides secure, just-in-time elevated privileges across your IT environments.

{% hint style="info" %}
The PEDM commands make use of a local SQLite file that is generated in the user's configuration folder, such as `~/.keeper/keeper_db.sqlite`. This database is used to cache all of the retrieved information across endpoints.
{% endhint %}

## **pedm Command**

**command:** `pedm`

**Detail:**  Manage Keeper Endpoint Privilege Manager deployments, agents, policies, collections and approvals.

<pre><code><strong>My Vault> pedm -h                                                       
</strong>pedm command [--options]

Command     Description
----------  ------------------------------------
sync-down   Sync down PEDM data from the backend
deployment  Manage PEDM deployments 
agent       Manage PEDM agents
policy      Manage PEDM policies
collection  Manage PEDM collections 
approval    Manage PEDM requests and approvals
</code></pre>

**Sub Commands**

* [sync-down](#sub-command-sync-down)
* [deployment](#sub-command-deployment)
* [agent](#sub-command-agent)
* [policy](#sub-command-policy)
* [collection](#sub-command-collection)
* [approval](#sub-command-approval)

***

### **Sub-Command: sync-down**

**Detail:** Sync down PEDM data from the backend

<pre><code><strong>My Vault> pedm sync-down -h                                                 
</strong>usage: sync-down [-h] [--reload]

Sync down PEDM data from the backend

options:
  -h, --help  show this help message and exit
  --reload    Perform full sync
</code></pre>

***

### **Sub-Command: deployment**

**Detail:** Manage PEDM deployments

<pre><code><strong>My Vault> pedm deployment -h
</strong>pedm command [--options]

Command    Description
---------  --------------------------------
list       List PEDM deployments
add        Add PEDM deployments
edit       Update PEDM deployment
delete     Delete PEDM deployment
download   Download PEDM deployment package
</code></pre>

#### list

```
My Vault> pedm deployment list -h                       
usage: list [-h] [--format {table,csv,json,pdf}] [--output OUTPUT] [-v]

List PEDM deployments

options:
  -h, --help            show this help message and exit
  --format {table,csv,json,pdf}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
  -v, --verbose         print verbose information

```

#### add

```
My Vault> pedm deployment add -h                      
usage: add [-h] [-f] [--spiffe-cert SPIFFE] name

Add PEDM deployments

positional arguments:
  name                  Deployment name

options:
  -h, --help            show this help message and exit
  -f, --force           do not prompt for confirmation
  --spiffe-cert SPIFFE  File containing SPIFFE server certificate

```

#### edit

```
My Vault> pedm deployment edit -h
usage: update [-h] [--disable {on,off}] [--spiffe-cert SPIFFE] [--name NAME] DEPLOYMENT

Update PEDM deployment

positional arguments:
  DEPLOYMENT            Deployment name or UID

options:
  -h, --help            show this help message and exit
  --disable {on,off}    do not prompt for confirmation
  --spiffe-cert SPIFFE  File containing SPIFFE server certificate
  --name NAME           Deployment name
```

#### delete

```
My Vault> pedm deployment delete -h
usage: delete [-h] [-f] DEPLOYMENT [DEPLOYMENT ...]

Delete PEDM deployment

positional arguments:
  DEPLOYMENT   Deployment name or UID

options:
  -h, --help   show this help message and exit
  -f, --force  do not prompt for confirmation
```

#### download

```
My Vault> pedm deployment download -h                      
usage: download [-h] [--file FILE] DEPLOYMENT

Download PEDM deployment package

positional arguments:
  DEPLOYMENT   Deployment name or UID

options:
  -h, --help   show this help message and exit
  --file FILE  File name

```

***

### **Sub-Command: agent**

**Detail:** Manage PEDM agents

<pre><code><strong>My Vault> pedm agent -h                         
</strong>pedm command [--options]

Command     Description
----------  -------------------------
list        List PEDM agents
edit        Update PEDM agents
delete      Delete PEDM agents
collection  List PEDM agent resources
</code></pre>

#### list

```
My Vault> pedm agent list -h             
usage: list [-h] [--format {table,csv,json,pdf}] [--output OUTPUT] [-v]

List PEDM agents

options:
  -h, --help            show this help message and exit
  --format {table,csv,json,pdf}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
  -v, --verbose         print verbose information

```

#### edit

```
My Vault> pedm agent edit -h                          
usage: update [-h] [--enable {on,off}] [--deployment DEPLOYMENT] agent [agent ...]

Update PEDM agents

positional arguments:
  agent                 Agent UID(s)

options:
  -h, --help            show this help message and exit
  --enable {on,off}     Enables or disables agents
  --deployment DEPLOYMENT
                        Moves agent to deployment
```

#### delete

```
My Vault> pedm agent delete -h                             
usage: update [-h] [--force] agent [agent ...]

Delete PEDM agents

positional arguments:
  agent       Agent UID(s)

options:
  -h, --help  show this help message and exit
  --force     do not prompt for confirmation
```

#### collection

```
My Vault> pedm agent collection -h 
usage: list [-h] [--format {table,csv,json,pdf}] [--output OUTPUT] [-v] [--type TYPE] agent

List PEDM agent resources

positional arguments:
  agent                 Agent UID

options:
  -h, --help            show this help message and exit
  --format {table,csv,json,pdf}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
  -v, --verbose         print verbose information
  --type TYPE           collection type filter

```

***

### **Sub-Command: policy**

**Detail:** Manage PEDM policies

<pre><code><strong>My Vault> pedm policy -h  
</strong>pedm command [--options]

Command    Description
---------  ----------------------------
list       List PEDM policies
add        Add PEDM policy
edit       Edit PEDM policy
view       View PEDM policy
agents     Show agents for policies
assign     Assign collections to policy
delete     Delete PEDM policy
</code></pre>

#### list

<pre><code><strong>My Vault> pedm policy list -h               
</strong>usage: list [-h] [--format {table,csv,json,pdf}] [--output OUTPUT]

List PEDM policies

options:
  -h, --help            show this help message and exit
  --format {table,csv,json,pdf}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
</code></pre>

#### add

<pre><code><strong>My Vault> pedm policy add -h      
</strong>usage: add [-h] [--user-filter USER_FILTER] [--machine-filter MACHINE_FILTER] [--app-filter APP_FILTER] [--date-filter DATE_FILTER]
           [--time-filter TIME_FILTER] [--day-filter DAY_FILTER] [--risk-level RISK_LEVEL]
           [--policy-type {elevation,file_access,command,least_privilege}] [--policy-name POLICY_NAME]
           [--control {allow,deny,audit,notify,mfa,justify,approval}] [--status {enforce,monitor,monitor_and_notify}] [--enable {on,off}]

Add PEDM policy

options:
  -h, --help            show this help message and exit
  --user-filter USER_FILTER
                        Policy user filter. User collection UID or *
  --machine-filter MACHINE_FILTER
                        Policy machine filter. Machine collection UID
  --app-filter APP_FILTER
                        Policy application filter. Application collection UID
  --date-filter DATE_FILTER
                        Policy date filter. Date range in ISO format. YYYY-MM-DD:YYYY-MM-DD
  --time-filter TIME_FILTER
                        Policy time filter. Time. 24 hours format: HH:MM-HH:MM
  --day-filter DAY_FILTER
                        Policy day filter. Day of Week
  --risk-level RISK_LEVEL
                        Policy risk level
  --policy-type {elevation,file_access,command,least_privilege}
                        Policy type
  --policy-name POLICY_NAME
                        Policy name
  --control {allow,deny,audit,notify,mfa,justify,approval}
                        Policy controls
  --status {enforce,monitor,monitor_and_notify}
                        Policy Status
  --enable {on,off}     Enables or disables policy
</code></pre>

#### edit

<pre><code><strong>My Vault> pedm policy edit -h                                                                                                                           
</strong>usage: edit [-h] [--user-filter USER_FILTER] [--machine-filter MACHINE_FILTER] [--app-filter APP_FILTER] [--date-filter DATE_FILTER]
            [--time-filter TIME_FILTER] [--day-filter DAY_FILTER] [--risk-level RISK_LEVEL] [--policy-name POLICY_NAME]
            [--control {allow,deny,audit,notify,mfa,justify,approval}] [--status {enforce,monitor,monitor_and_notify}] [--enable {on,off}]
            policy

Edit PEDM policy

positional arguments:
  policy                Policy UID

options:
  -h, --help            show this help message and exit
  --user-filter USER_FILTER
                        Policy user filter. User collection UID or *
  --machine-filter MACHINE_FILTER
                        Policy machine filter. Machine collection UID
  --app-filter APP_FILTER
                        Policy application filter. Application collection UID
  --date-filter DATE_FILTER
                        Policy date filter. Date range in ISO format. YYYY-MM-DD:YYYY-MM-DD
  --time-filter TIME_FILTER
                        Policy time filter. Time. 24 hours format: HH:MM-HH:MM
  --day-filter DAY_FILTER
                        Policy day filter. Day of Week
  --risk-level RISK_LEVEL
                        Policy risk level
  --policy-name POLICY_NAME
                        Policy name
  --control {allow,deny,audit,notify,mfa,justify,approval}
                        Policy controls
  --status {enforce,monitor,monitor_and_notify}
                        Policy Status
  --enable {on,off}     Enables or disables policy

</code></pre>

#### view

<pre><code><strong>My Vault> pedm policy view -h                                     
</strong>usage: view [-h] [--format {table,json}] [--output OUTPUT] policy

View PEDM policy

positional arguments:
  policy                Policy UID or name

options:
  -h, --help            show this help message and exit
  --format {table,json}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
</code></pre>

#### agents

```
My Vault> pedm policy agents -h                                 
usage: agent [-h] policy [policy ...]

Show agents for policies

positional arguments:
  policy      Policy UID or name

options:
  -h, --help  show this help message and exit
```

#### assign

```
My Vault> pedm policy assign -h                          
usage: assign [-h] [-c COLLECTION] policy [policy ...]

Assign collections to policy

positional arguments:
  policy                Policy UID or name

options:
  -h, --help            show this help message and exit
  -c, --collection COLLECTION
                        Collection UID

```

#### delete

<pre><code><strong>My Vault> pedm policy delete -h
</strong>usage: delete [-h] policy [policy ...]

Delete PEDM policy

positional arguments:
  policy      Policy UID or name

options:
  -h, --help  show this help message and exit
</code></pre>

***

### **Sub-Command: collection**

**Detail:** Manage PEDM collections

<pre><code><strong>My Vault> pedm collection -h                                   
</strong>pedm command [--options]

Command     Description
----------  -----------------------------------
list        List PEDM collections
view        Show PEDM collection details
add         Creates PEDM collections
update      Update PEDM collection
delete      Delete PEDM collections
connect     Link values to PEDM collection
disconnect  Unlink values from PEDM collections
wipe-out    Wipe out PEDM collections
</code></pre>

#### list

<pre><code><strong>My Vault> pedm collection list -h                                                                                       
</strong>usage: list [-h] [--format {table,csv,json,pdf}] [--output OUTPUT] [-v] [--type TYPE] [--pattern PATTERN]

List PEDM collections

options:
  -h, --help            show this help message and exit
  --format {table,csv,json,pdf}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
  -v, --verbose         print verbose information
  --type TYPE           collection type filter
  --pattern PATTERN     collection search pattern
</code></pre>

#### view

```
My Vault> pedm collection view -h                                                                                                                       
usage: view [-h] [--format {table,csv,json,pdf}] [--output OUTPUT] [-v] [--link LINK] collection [collection ...]

Show PEDM collection details

positional arguments:
  collection            Collection UID

options:
  -h, --help            show this help message and exit
  --format {table,csv,json,pdf}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
  -v, --verbose         print verbose information
  --link LINK           Show link details
```

#### add

```
My Vault> pedm collection add -h                                           
usage: add [-h] [--type TYPE] collection [collection ...]

Creates PEDM collections

positional arguments:
  collection   Collection name

options:
  -h, --help   show this help message and exit
  --type TYPE  collection type
```

#### update

```
My Vault> pedm collection update -h                               
usage: update [-h] [--type TYPE] --name NAME collection

Update PEDM collection

positional arguments:
  collection   Collection

options:
  -h, --help   show this help message and exit
  --type TYPE  collection type (optional)
  --name NAME  Collection name
```

#### delete

```
My Vault> pedm collection delete -h                         
usage: delete [-h] [-f] collection [collection ...]

Delete PEDM collections

positional arguments:
  collection   Collection or @orphan_resource

options:
  -h, --help   show this help message and exit
  -f, --force  do not prompt for confirmation
```

#### disconnect

```
My Vault> pedm collection disconnect -h                 
usage: unlink [-h] [--collection COLLECTION] [-f] links [links ...]

Unlink values from PEDM collections

positional arguments:
  links                 UIDs to unlink

options:
  -h, --help            show this help message and exit
  --collection, -c COLLECTION
                        Parent collection UID or name
  -f, --force           do not prompt for confirmation
```

#### wipe-out

```
My Vault> pedm collection wipe-out -h                                            
usage: wipe-out [-h] [--type TYPE]

Wipe out PEDM collections

options:
  -h, --help   show this help message and exit
  --type TYPE  collection type
```

***

### **Sub-Command:** approval

**Detail:** Manage PEDM requests and approvals

<pre><code><strong>My Vault> pedm approval -h                                                    
</strong>pedm command [--options]

Command    Description
---------  -----------------------------
list       List PEDM approval requests
action     Modify PEDM approval requests
</code></pre>

#### list

Get the current list of outstanding approvals

```
My Vault> pedm approval list -h 
usage: list [-h] [--format {table,csv,json,pdf}] [--output OUTPUT] [--type {approved,denied,pending}]

List PEDM approval requests

options:
  -h, --help            show this help message and exit
  --format {table,csv,json,pdf}
                        format of output
  --output OUTPUT       path to resulting output file (ignored for "table" format)
  --type {approved,denied,pending}
                        approval type filter
```

#### action

Perform an action on a request, such as approving, removing or denying the request.

```
My Vault> pedm approval action -h 
usage: action [-h] [--approve APPROVE] [--deny DENY] [--remove REMOVE]

Modify PEDM approval requests

options:
  -h, --help         show this help message and exit
  --approve APPROVE  Request UIDs for approval
  --deny DENY        Request UIDs for denial
  --remove REMOVE    Request UIDs for removal. UID, @approved, @denied, @pending
```
