summaryrefslogtreecommitdiffstats
path: root/lrm/admin/lrmadmin.txt
diff options
context:
space:
mode:
Diffstat (limited to 'lrm/admin/lrmadmin.txt')
-rw-r--r--lrm/admin/lrmadmin.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/lrm/admin/lrmadmin.txt b/lrm/admin/lrmadmin.txt
new file mode 100644
index 0000000..739aa70
--- /dev/null
+++ b/lrm/admin/lrmadmin.txt
@@ -0,0 +1,60 @@
+# LRM Admin Command-line Interface
+# It's a draft
+NAME
+ lrmadmin - Local Resource Manager Commander-line Daministrator Tools
+
+SYNOPSIS
+lrmadmin {-d|--daemon}
+ {-A|--add} <rscid> <rsc_class> <rsc_type> [<rsc_params_list>]
+ {-D|--delete} <rscid>
+ {-F|--flush} <rscid>
+ {-E|--execute} <rscid> <operator> <timeout> [<operator_parameters_list>]
+ {-M|--monitor} -s <rscid> <operator> <timeout> <interval>
+ [<operator_parameters_list>]
+ {-M|--monitor} {-g|-c} <rscid>
+ {-S|--status} <rscid>
+ {-L|--listall}
+ {-I|--information} <rsc_id>
+ {-R|--rasupported}
+ {-h|--help}
+
+Detailed Explanation for Options
+
+Lrmd daemon options
+ {-d|--daemon}
+# -s The status of lrmd: running or not running
+# -r Reset lrmd (?)
+
+Resource options
+ {-A|--add} <rscid> <rsc_class> <rsc_type> [<rsc_params_list>]
+ Add a resource.
+
+ {-D|--delete} <rscid>
+ Delete a resource
+
+ {-E|--execute} <rscid> <operator> <timeout> [<operator_parameters_list>]
+ Let resource agent to performance the operation
+
+ {-F|--flush} <rscid>
+ Clear all pending operation on the resource agnency
+
+ {-M|--monitor} {-s|-g} <rscid> <interval>
+ -s rscname Set a monitors on the resource agent
+ -g Get the information about the monitors on the
+ resource agent
+
+ {-S|--status} <rscid>
+ Get the status of current resource agent
+
+ {-L|--listall}
+ List all available resource agent
+
+ {-I|--information} <rsc_id>
+ List the information about a resource
+
+ {-R|--rasupported}
+ List the support types of resource agent such as OCF and etc.
+
+Other options
+ {-h|--help}
+ Display the help screen