xsadmin tool to xscmd tool migration

In previous releases, the xsadmin tool was a sample command-line utility to monitor the state of the environment. The xscmd tool has been introduced as an officially supported administrative and monitoring command-line tool. If you were previously using the xsadmin tool, consider migrating your commands to the new xscmd tool.

Deprecated featureImportant: The xsadmin utility has now been deprecated. Use the xscmd utility instead. The xscmd utility is provided as a supported utility for monitoring and administering your environment. For more information, see Administering with the xscmd utility.

xsadmin and xscmd command equivalents

Table 1. Arguments for the xsadmin utility and xscmd equivalent commands. Some xscmd commands have a short form and a long form. The short form commands have one dash (-), and the long form commands have two dashes (--). You can use either form interchangeably.
xsadmin Command Line Argument xscmd Equivalent Command xscmd Command Parameters
-bp
  • -cep hostname:listener_port
  • --catalogEndpoint hostname:listener_port
 n/a
-ch
  • -cep hostname:listener_port
  • --catalogEndpoint hostname:listener_port
 n/a
-clear -c clearGrid -g, -ms, -v, -m, (-cep)
-containers
  • -c showPlacement -containercontainerName
  • -c showPlacement -server serverName
 -e, -i, , -st, -snp, -ct, -s, -p, -hf, -z, -g, -m, -ms
-continuous n/a n/a
-coregroups
  • -c listCoreGroupMembers -cg core_group
 n/a
-dismissLink <catalog_service_domain> -c dismissLink
  • -fd <foreignCatalogServiceDomain>
  • --foreignCatalogServiceDomain <foreignCatalogServiceDomain>
-dmgr n/a - this argument is automatically determined with xscmd n/a
-empties arg specific to a new command n/a
-establishLink <foreign_domain_name> <host1:port1,host2:port2...> -c establishLink
  • -fd <foreignCatalogServiceDomain> -fe <host1:port1,host2:port2...>
  • --foreignCatalogServiceDomain <foreignCatalogServiceDomain> -foreignEndPoints <host1:port1,host2:port2...>
-fc
  • -ct
  • --container
 n/a
-fh
  • -hf
  • --hostFilter
 n/a
-fm
  • -m
  • --map
 n/a
-fnp
  • -snp
  • --serversWithNoPrimaries
 n/a
-fp
  • -p
  • --partitionId
 n/a
-fs
  • -s
  • --server
 n/a
-fst
  • -st <shard_type>
  • --shardType <shard_type>
Shard values: P=primary A=asyncReplica S=syncReplica		 n/a
-fz
  • -z
  • --zone
 n/a
-force arg specific to a new command  
-g
  • -g
  • --objectGrid
 n/a
-getstatsspec -c getStatsSpec n/a
-getTraceSpec -c getTraceSpec n/a
-h You can run help with or without a specific command name:
  • -h
  • --help
  • -h <command_name>
  • --help <command_name>
 n/a
-hosts -c listHosts -g, -ms, -st, -c, -s, -hf, -z
-jmxUrl
  • -cep hostname:listener_port
  • --catalogEndpoint hostname:listener_port
 n/a
-l -c listObjectGridNames n/a
-m
  • -ms
  • --mapSet
 n/a
-mapsizes -c showMapSizes -g, -ms, -i, [-ct, -z, -s, -hf, sht [P,A,S], -p]
-mbeanservers -c listAllJMXAddresses n/a
-overridequorum -c overrideQuorum n/a
-password
  • -pwd
  • --password
 n/a
-p
  • -cep hostname:listener_port
  • --catalogEndpoint hostname:listener_port
 n/a
-placementStatus -c placementServiceStatus -g, -ms
-primaries -c showPlacement -sf P -e, -i, , -st, -snp, -ct, -s, -p, -hf, -z, -g, -m, -ms
-profile To save the current security settings as a security profile:
  • -ssp profile_name
  • --saveSecProfile profile_name
To use a specified security profile:
  • -sp profile_name
  • --securityProfile profile_name
  
-quorumstatus -c showQuorumStatus n/a
-releaseShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> -c releaseShard -c, -g, -ms, -p
-reserved
  • -sf R
  • --shardFilter R
n/a
-reserveShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> -c reserveShard -c, -g, -ms, -p
-resumeBalancing <objectgrid_name> <map_set_name> -c resumeBalancing -g, -ms
-revisions -c revisions -s,-p,-g,-m
-routetable -c routetable -z, -hf,-p,-g,-ms
-settracespec <trace_string> -c setTraceSpec -spec <trace_string>
-swapShardWithPrimary <container_server_name> <objectgrid_name> <map_set_name> <partition_name> -c swapShardWithPrimary -c -g, -ms, -p
-setstatsspec <stats_spec> -c setStatsSpec -spec <stats_spec>
-suspendBalancing <objectgrid_name> <map_set_name> -c suspendBalancing -g, -ms
-ssl
  • -ssl
  • --enableSSL
n/a
-teardown -c teardown -f, , -st, -snp, -c, -s, -p, -hf, -z, -g, -ms, -m
-triggerPlacement -c triggerPlacement -g, -ms
-trustPass
  • -tsp
  • --trustStorePassword
n/a
-trustPath
  • -ts
  • --trustStore
n/a
-trustType
  • -tst
  • --trustStoreType
n/a
-unassigned -c showPlacement -sf U -e, -i, , -st, -snp, -ct, -s, -p, -hf, -z, -g, -m, -ms
-username
  • -user
  • --username
n/a
-v
  • -v
  • --verbose
n/a
-xml -c showPlacement n/a