cpsadm - command that is used to perform CPS administrative and maintenance tasks

cpsadm -s cp server -a action [-p port num] [-c cluster name] [-u uuid] [-e username@domain.com] [-f user role] [-g domain type] [-h hostname] [-n nodeid] [-o victim’s hostname] [-v victim’s nodeid]

cpsadm [-help]

VRTScps

The cpsadm command is used to perform CPS administrative and maintenance tasks.

-a	This option is used to specify action (one of the following actions: add_clus, rm_clus, add_node, rm_node, add_user, rm_user,add_clus_to_user, rm_clus_from_user, reg_node, unreg_node, preempt_node, list_membership, list_nodes, list_users, halt_cps, db_snapshot, ping_cps)
-c	This option is used to specify client cluster name
-e	This option is used to specify user to be added to CPS (username@domain.com)
-f	This option is used to specify user role (cps_admin or cps_operator)
-g	This option is used to specify a domain type (nis, nisplus, ldap, or unixpwd)
-h	This option is used to specify hostname
-n	This option is used to specify nodeid of client cluster node
-o	This option is used to specify victim node’s hostname
-p	This option is used to specify the port number to connect to the CP server
-s	This option is used to specify the CP server fqdn/vip
-u	This option is used to specify the UUID of the client cluster
-v	This option is used to specify victim node’s nodeid

The following are cpsadm command examples using the various options.

Add a client cluster to the CPS configuration.
	cpsadm -s <cp server> -a add_clus -c <cluster name> -u <uuid>
Remove a client cluster from the CPS configuration.
	cpsadm -s <cp server> -a rm_clus -c <cluster name>
List nodes in the CPS configuration.
	cpsadm -s <cp server> -a list_nodes -c <cluster name>
Add a node to a client cluster for the CPS configuration.
	cpsadm -s <cp server> -a add_node -c <cluster name> -n <nodeid> -h <hostname>
Remove a node from a client cluster for the CPS configuration.
	cpsadm -s <cp server> -a rm_node -u <uuid> -n <nodeid>
List users in the CPS configuration.
	cpsadm -s <cp server> -a list_users
Add a user to the CPS configuration.
	cpsadm -s <cp server> -a add_user -e <username@domain> -g <domain type>
Remove a user from the CPS configuration.
	cpsadm -s <cp server> -a rm_user -e <username@domain> -g <domain type>
List the membership of all nodes registered in a given client cluster.
	cpsadm -s <cp server> -a list_membership -c <cluster name>
Register a node within a client cluster for the CPS configuration.
	cpsadm -s <cp server> -a reg_node -u <uuid> -n <nodeid> -h <hostname>
Unregister a node from a client cluster for the CPS configuration.
	cpsadm -s <cp server> -a unreg_node -c <cluster name> -n <nodeid>
Pre-empt a node within a client cluster.
	cpsadm -s <cp server> -a preempt_node -u <uuid> -n <nodeid> -v <victim’s nodeid>
Enable access for a user to a specific client cluster.
	cpsadm -s <cp server> -a add_clus_to_user -c <cluster name> -e <username@domain> -g <domain type> -f <user role>
Disable access for a user to a specific client cluster.
	cpsadm -s <cp server> -a rm_clus_from_user -u <uuid> -e <username@domain> -g <domain type>
Stop the CPS.
	cpsadm -s <cp server> -a halt_cps
Ping the CPS.
	cpsadm -s <cp server> -a ping_cps
Take a snapshot of the CPS database.
	cpsadm -s <cp server> -a db_snapshot

The following are cpsadm command usage examples.

1. Add a client cluster to the CPS configuration.

usage: cpsadm -s <cp server> -a add_clus [-p port num] -c <cluster name> -u <uuid>

where:

o	-a is used to specify action
o	-c is used to specify cluster name
o	-p is used to specify the port number
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
2. Remove a client cluster from the CPS configuration.
usage: cpsadm -s <cp server> -a rm_clus [-p port num] {-c <cluster name> | -u <uuid>}
where:
o	-a is used to specify action
o	-p is used to specify the port number
o	-c is used to specify cluster name
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
3. List the nodes in a client cluster for the CPS configuration.
usage: cpsadm -s <cp server> -a list_nodes [-c <cluster name> | -u <uuid>]
where:
o	-a is used to specify action
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-c is used to specify cluster name
o	-u is used to specify UUID
4. Add a node to a client cluster for the CPS configuration.
usage: cpsadm -s <cp server> -a add_node {-c <cluster name> | -u <uuid>} -n <nodeid> -h <hostname>
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-h is used to specify fully qualified hostname
o	-n is used to specify a host’s nodeid
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
5. Remove a node from a client cluster for the CPS configuration.
usage: cpsadm -s <cp server> -a rm_node {-c <cluster name> | -u <uuid>} -n <nodeid> [-h <hostname>]
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-h is used to specify fully qualified hostname
o	-n is used to specify a host’s nodeid
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
6. Prempt a node within a client cluster.
usage: cpsadm -s <cp server> -a preempt_node {-c <cluster name> | -u <uuid>} -n <nodeid> -v <victim’s nodeid>
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-n is used to specify a host’s nodeid
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
o	-v is used to specify victim node’s nodeid
7. Register a node to a client cluster for the CPS configuration.
usage: cpsadm -s <cp server> -a reg_node {-c <cluster name> | -u <uuid>} -n <nodeid> [-h <hostname>]
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-h is used to specify fully qualified hostname
o	-n is used to specify a host’s nodeid
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
8. Unregister a node within a client cluster for the CPS configuration.
usage: cpsadm -s <cp server> -a unreg_node {-c <cluster name> | -u <uuid>} -n <nodeid> [-h <hostname>]
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-h is used to specify fully qualified hostname
o	-n is used to specify a host’s nodeid
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
9. List membership of all registered nodes in a given client cluster.
usage: cpsadm -s <cp server>-a list_membership {-c <cluster name> | -u <uuid>}
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
10. List users in CPS configuration.
usage: cpsadm -s <cp server> -a list_users [-c <cluster name> | -u <uuid>]
where:
o	-a is used to specify action
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-c is used to specify cluster name
o	-u is used to specify UUID
11. Add user to the CPS configuration. Enable access for the user to CPS.
usage: cpsadm -s <cp server> -a add_user -e <username@domain> -g <domain type>
where:
o	-a is used to specify action
o	-e is used to specify user to be added to CPS (username@domain.com)
o	-g is used to specify a domain type (nis, nisplus, ldap, or unixpwd)
o	-s is used to specify virtual IP/virtual hostname of the CP server
12. Remove user from the CPS configuration. Disable access for the user to CPS.
usage: cpsadm -s cp server -a rm_user -e <username@domain> -g <domain type>
where:
o	-a is used to specify action
o	-e is used to specify user to be added to CPS (username@domain.com)
o	-g is used to specify a domain type (nis, nisplus, ldap, or unixpwd)
o	-s is used to specify virtual IP/virtual hostname of the CP server
13. Add user to the client cluster. Enable access to a client cluster for a user.
usage: cpsadm -s <cp server> -a add_clus_to_user {-c <cluster name> | -u uuid} -e <username@domain> -g <domain type> -f <user role>
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-e is used to specify user to be added to CPS (username@domain.com)
o	-f is used to specify user role (cps_admin or cps_operator
o	-g is used to specify a domain type (nis, nisplus, ldap, or unixpwd)
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
14. Remove user from the client cluster. Disable access for a user to a specific client cluster.
usage: cpsadm -s <cp server> -a rm_clus_from_user {-c <cluster name> |-u uuid} -e <username@domain> -g <domain type> [-f <user role>]
where:
o	-a is used to specify action
o	-c is used to specify cluster name
o	-e is used to specify user to be added to CPS (username@domain.com)
o	-f is used to specify user role (cps_admin or cps_operator
o	-g is used to specify a domain type (nis, nisplus, ldap, or unixpwd)
o	-s is used to specify virtual IP/virtual hostname of the CP server
o	-u is used to specify UUID
o	-u is used to specify UUID
15. Stop the CPS.
usage: cpsadm -s <cp server> -a halt_cps
where:
o	-a is used to specify action
o	-s is used to specify virtual IP/virtual hostname of the CP server
16. Ping the CPS.
usage: cpsadm -s cp server -a ping_cps
where:
o	-a is used to specify action
o	-s is used to specify virtual IP/virtual hostname of the CP server
17. Take a CPS database snapshot.
usage: cpsadm -s <cp server> -a db_snapshot
where:
o	-a is used to specify action
o	-s is used to specify virtual IP/virtual hostname of the CP server

Copyright (c) 2009 Symantec Corporation.

All rights reserved.