Surgient Success

Hello,

I would like to create scripts using vcsadmin.exe to create new users.  Is there documentation or samples using vcsadmin.exe?

- Thanks 

With, vcsadmin.exe, you have the option to supply it a "script".

 C:\Program Files\Surgient\VCS>vcsadmin -help
Usage: vcsadmin [options] [command [command options]]
  where options are:
    -organization <organization> Optional organization name, defaults to the int
ernal organization
    -account      <account>    Account name
    -password     <password>   Password for account
    -script       <script>     Script file containing commands to run
    -verbose                   Display verbose error messages
    -help                      Display help message

  Use "vcsadmin help" to show available commands

If you wish to use vcsadmin.exe to script out user creation, then you can put the accountadd commands in file and pass it into vcsadmin.exe

1.  Create a file called: addusers.vs, and paste the following information in the file:

 2. Execute vcsadmin.exe with the script file:

C:\Program Files\Surgient\VCS> vcsadmin.exe -a admin -p password -script addusers.vs

Hi,

Thanks but I am getting an exception error when using your syntax.  Is something missing like a parameter for -username or -password ?

accountadd -organization org1 -displayname userName1 -email user1@mydomain.com user1 myPassword1

Also, is there a parameter to link the account to an LDAP account authority?

- Thanks

That syntax looks correct - what is the exception you're seeing?   You can get a complete exception stack trace by including the -verbose option on your vcsadmin command line, e.g.,

 vcsadmin -a accountName -p password -verbose

To use the LDAP account authority, use the -authority flag on accountadd and supply the authority name.  This presumes that you've already configured an LDAP account authority from the Management Console.

> help accountadd
Usage:  accountadd [options] accountName [password]
  where options are:
    -help                      Display help message
    -displayname  <displayname> Display name
    -persona      <persona>    Persona internal name
    -email        <email>      Email address
    -description  <description> Account description
    -organization <organization> Organization account belongs to
    -authority    <authority>  Account authority
    -group        <group>      Account groups
    -culture      <culture>    Account culture code (language-locale, e.g. 'en-US')
    -noninteractive              If set, account is a non-interactive account

 - Neal

Hi Neal,

I have it all working now.  Thanks for your help.  Do you have any documentation for all of the command syntax for vcsadmin.

- Thanks 

No, there's no official documentation.  However, it is largely self-documenting once you understand the command syntax.   From the vcsadmin prompt ">" , typing "help" gives a list of all available sub-commands.  You can then say "help subcommand" to get the syntax for a specific command.  If you're not sure what the exact name of a sub-command is, you can type something like "help account" and it will return a list of all account commands. (Since the list of all commands is pretty long.)

As for individual command syntax, they generally follow the POSIX getopts conventions,  e.g., optional arguments are specified first, followed by required arguments.  Required arguments are positional while optional arguments require a tag like "-optionname".

Good luck!

 Neal