bitwarden/help
1
0
Fork 0
mirror of https://github.com/bitwarden/help synced 2025-12-10 13:23:16 +00:00
Code Issues Releases Wiki Activity

docs for configsync params

Browse Source
This commit is contained in:
Kyle Spearrin
2017-05-24 14:02:06 -04:00
parent 484aa344ac
commit ad225cb584
1 changed files with 37 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
_articles/organizations/directory-sync.md
View File

@@ -136,9 +136,35 @@ Any sensitive information such as secret keys and server passwords are encrypted
Optionally, from the command line:
```
Console.exe configsync [-g] [-u] [-i] [-uf] [-gf] [-rd] [ad/ldap: [-go] [-gp] [-gf] [-gn] [-uo] [-up] [-ue] [-m] [-ps] [-ep] [-c] [-r]]
Console.exe configsync [-g] [-u] [-i] [-uf] [-gf] [-rd] [ad/ldap: [-go] [-gp] [-gn] [-uo] [-up] [-ue] [-m] [-ps] [-ep] [-es] [-c] [-r]]
```
| Description | Argument | Example Value | Required | Notes |
|-----------------|----------|------------------------|----------|----------------------------------------------------|
| Sync Groups | -g | n/a | n | |
| Sync Users | -u | n/a | n | |
| Sync Interval | -i | 5 | n | Value is in minutes. |
| User Filter | -uf | (&(objectClass=user)) | n | Value syntax is different for each directory type. |
| Group Filter | -gf | (&(objectClass=group)) | n | Value syntax is different for each directory type. |
| Remove Disabled | -rd | n/a | n | |
#### Active Directory / Other LDAP
| Description | Argument | Example Value | Required |
|-------------------------|----------|----------------|----------|
| Group Object Class | -go | group | y |
| User Object Class | -uo | user | y |
| Group Path | -gp | CN=Groups | n |
| User Path | -up | CN=Users | n |
| Group Name Attribute | -gn | name | n |
| User Email Attribute | -ue | mail | n |
| Member Attribute | -m | member | n |
| Use Email Prefix/Suffix | -ps | n/a | n |
| Email Prefix Attribute | -ep | sAMAccountName | n |
| Email Suffix | -es | @company.com | n |
| Creation Date Attribute | -c | whenCreated | n |
| Revision Date Attribute | -r | whenChanged | n |
### Manually simulate a sync
You can simulate a directory sync in order to check that all of your configuration settings are setup and working as expected. A sync simulation will query the directory server and print the results to the screen. The results that you see printed to the screen will be what is uploaded and synced to your bitwarden organization whenever a real sync is invoked.
@@ -150,9 +176,13 @@ You can simulate a directory sync in order to check that all of your configurati
Optionally, from the command line:
```
Console.exe sim
Console.exe sim [-f]
```
| Description | Argument | Example Value | Required | Notes |
|-------------|----------|---------------|----------|---------------------|
| Force | -f | n/a | n | Forces a full sync. |
### Perform a sync
1. Launch the Directory Connector console by double clicking the shortcut.
@@ -161,9 +191,13 @@ Console.exe sim
Optionally, from the command line:
```
Console.exe sync
Console.exe sync [-f]
```
| Description | Argument | Example Value | Required | Notes |
|-------------|----------|---------------|----------|---------------------|
| Force | -f | n/a | n | Forces a full sync. |
### Manage the background service
The background service allows sync operations to run in the background based on the interval set in your sync configuration.