SanteDB Administration Console

The SanteDB iCDR administrative console is a client tool which allows system administrators to quickly manage their iCDR instances from a command line. This tool is useful when:
Internet connectivity is extremely limited and text interface is preferred
You need to save output/reports for administrative functions to files
You have not yet setup the web-based administrative portal
Starting the Console
You can launch the command line on the same machine as the iCDR service from the start menu or by typing the sdbac command in the command line. If you need to connect to a different server/realm the basic syntax is:
1
sdbac --realm=<server-ip-or-name> --port=<port> [--tls] 
Copied!
The command line options for sdbac are listed below:
Short
Long
Description
-r
--realm
The server/realm to which you're connecting.
-a
--appId
The application identifier if the default administrative console application
has not been enabled by the system administrator.
-s
--secret
The application secret if the default has been changed by the administrator
​
--port
The port to connect to the iCDR API on
-t
--tls
If specified, instruct the console administrative application to connect
via TLS
-u
--user
The username to login with
-p
--password
The password to use for authentication
-v
--verbose
When present, output all server and client events with full stack traces
-x
--proxy
When specified route all traffic through a proxy
-b
--oauth-basic
When specified, instructs the client to send client credentials via HTTP BASIC
rather than through the request body of the OAUTH request.
Getting Help
You can run the help command in order to get a list of commands which are available on the administrative console. 
1
> help
2
aa.add              Add Assigning Authority application
3
aa.list             Query assigning authorties/identity domains
4
applet.download     Download the applet
5
applet.list         Lists all applets installed on the server
6
application.add     Add security application
7
application.del     De-activates an application in the SanteDB instance
8
application.info    Displays detailed information about the application
9
application.list    List Security Applications
10
application.lock    Engages or disengages the application lock
11
application.undel   Re-activates an application in the SanteDB instance
12
cdr.query           Query data from CDR
13
clear               Clears the screen
14
device.add          Add security device
15
device.alter        Alter security device
16
device.del          De-activates a device in the SanteDB instance
17
device.info         Displays detailed information about the device
18
device.list         List Security Devices
19
device.lock         Engages or disengages the device lock
20
device.undel        Re-activates a device in the SanteDB instance
21
exit                Quits the administrative shell
22
help                Shows help
23
log.cat             Lists the contents of the specified file
24
log.list            Lists the available log files
25
log.messages        Outputs the most recent log file
26
policy.assign       Assign security policies to objects
27
policy.list         List security policies
28
role.add            Adds a role to the current SanteDB instance
29
role.info           Displays detailed information about the role
30
role.list           List Security Roles
31
server.asm          Shows the server assembly information
32
server.info         Gets diagnostic information from the server
33
server.services     Shows the server service information
34
server.threads      Shows the server thread information
35
user.add            Adds a user to the SanteDB instance
36
user.del            De-activates a user to the SanteDB instance
37
user.info           Displays detailed information about the user
38
user.list           Lists users in the SanteDB instance
39
user.lock           Engages or disengages the user lock
40
user.password       Changes a users password
41
user.roles          Change roles for a user
42
user.undel          Re-activates a user to the SanteDB instance
43
ver                 Shows current Admin Console Version
44
whoami              Identifies the current authentication principal
45
Use:
46
        help cmd
47
For command specific help
Copied!
If you require help for a specific command use the help command syntax, for example, to get help with user.list:
1
> help user.list
2
user.list parms - Lists users in the SanteDB instance
3
           + This command lists all users in the user database regardless of their status, or class. To filter use the filter parameters listed.
4
 -l                 Filter on locked status
5
 -a                 Show obsolete non-active status
6
 -h                 Filter on human class only
7
 -s                 Filter on system class only
8
 -u                 The username of the user
Copied!
Topics
User Administration
Group / Role Administration
Policy Administration
Device Administration
Application Administration
​

Reviewing Audits

User Administration

Last modified 2mo ago

Copy link

Contents

Starting the Console

Getting Help

Topics