Syntax: Site Tools

CreateSite


Tool name:
  CreateSite

Description: 
  Creates a site with the specified name, consisting of the specified nodes. 
 
Usage: 
  runUMTool CreateSite -sitename=<sitename> -rnames=<rnames> [optional_args] 
 
Examples: 
  CreateSite -sitename=site0 -rnames=nsp://localhost:11000,nsp://localhost:11010 
 
Required arguments: 

  sitename : 
    Name of the site to be created. 

  rnames : 
    Server URLs to be considered for the site. Can be more than one URL, 
    separated by a comma. 
    The proper format is [nsp/nhp/nsps/nhps]://[hostname]:[port] or 
    shm://[path/to/file]. 
 
Optional Parameters: 

  username : 
    Your Universal Messaging server username. 

  password : 
    Your Universal Messaging server password.

DeleteSite


Tool name:
  DeleteSite

Description: 
  Deletes a site with the specified name from all the nodes associated with it. 
 
Usage: 
  runUMTool DeleteSite -sitename=<sitename> -rname=<rname> [optional_args] 
 
Examples: 
  DeleteSite -sitename=site0 -rname=nsp://localhost:11000 
 
Required arguments: 

  sitename : 
    Name of the site to be deleted. 

  rname : 
    Server URL to be considered for the site. Can be more than one URL, 
    separated by a comma. 
    The proper format is [nsp/nhp/nsps/nhps]://[hostname]:[port] or 
    shm://[path/to/file]. 
 
Optional Parameters: 

  username : 
    Your Universal Messaging server username. 

  password : 
    Your Universal Messaging server password.

SetPrimeSite


Tool name:
  SetPrimeSite

Description: 
  Toggles the specified site's prime status. 
 
Usage: 
  runUMTool SetPrimeSite -sitename=<sitename> -rname=<rname> 
    -setprime=<setprime> [optional_args] 
 
Examples: 
  SetPrimeSite -sitename=site0 -rname=nhp://localhost:11000 -setprime=true 
 
Required arguments: 

  sitename : 
    Name of the site to be configured. 

  rname : 
    Server URL to be considered for the site. 

  setprime : 
    True/False flag to set/unset a site being the prime site. 
 
Optional Parameters: 

  username : 
    Your Universal Messaging server username. 

  password : 
    Your Universal Messaging server password.

ShowSites


Tool name:
  ShowSites

Description: 
  Displays the configuration of the sites. 
 
Usage: 
  runUMTool ShowSites -rname=<rname> [optional_args] 
 
Examples: 
  ShowSites -rname=nhp://localhost:11000 
 
Required arguments: 

  rname : 
    Server URL to be considered for the site. 
 
Optional Parameters: 

  username : 
    Your Universal Messaging server username. 

  password : 
    Your Universal Messaging server password.