You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by ma...@apache.org on 2015/12/01 17:01:14 UTC
[4/4] syncope git commit: cli docs: realm, group, SYNCOPE-722
cli docs: realm, group, SYNCOPE-722
Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/78204b93
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/78204b93
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/78204b93
Branch: refs/heads/master
Commit: 78204b93ebb7197b796923704506528cb9fca11c
Parents: 748793c
Author: massi <ma...@tirasa.net>
Authored: Tue Dec 1 16:51:53 2015 +0100
Committer: massi <ma...@tirasa.net>
Committed: Tue Dec 1 16:51:53 2015 +0100
----------------------------------------------------------------------
src/main/asciidoc/cli-group.adoc | 205 ++++++++++++++++++++++++++++++++++
src/main/asciidoc/cli-realm.adoc | 111 ++++++++++++++++++
src/main/asciidoc/cli.adoc | 6 +-
3 files changed, 321 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/syncope/blob/78204b93/src/main/asciidoc/cli-group.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-group.adoc b/src/main/asciidoc/cli-group.adoc
new file mode 100644
index 0000000..032b94a
--- /dev/null
+++ b/src/main/asciidoc/cli-group.adoc
@@ -0,0 +1,205 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+==== Group command
+The group command serves to retrieve the information about the configured groups.
+
+===== Help message
+[source,bash]
+----
+Usage: group [options]
+ Options:
+ --help
+ --details
+ --list
+ --read
+ Syntax: --read {GROUP-ID} {GROUP-ID} [...]
+ --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+ --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+ --delete
+ Syntax: --delete {GROUP-ID} {GROUP-ID} [...]
+----
+
+===== Details option
+This option shows a table with group amount and some information.
+
+[source]
+--
+$ ./syncopeadm.sh group --details
+--
+
+[source]
+--
+
+You are runnig: group --details
+
+##################################
+# #
+# GROUPS DETAILS #
+# #
+##################################
+# # #
+# DETAIL # VALUE #
+# # #
+##################################
+# # #
+# Total number # 16 #
+# Without resources # 10 #
+# Without attributes # 0 #
+# On root realm # 14 #
+# On the other realm # 2 #
+# # #
+##################################
+
+--
+
+===== List option
+Running the command with this option you will see the list of the groups.
+
+[source]
+--
+$ ./syncopeadm.sh group --list
+--
+
+[source]
+--
+
+You are runnig: group --list
+
+ > GROUP ID: 1
+ name: root
+ type: GROUP
+ realm: /
+ status: null
+ user owner: null
+ group owner: null
+ RESOURCES:
+ PLAIN ATTRIBUTES:
+ - icon: [niceIcon]
+
+ - show: [true]
+
+ - rderived_sx: [sx]
+
+ - rderived_dx: [dx]
+
+ DERIVED ATTRIBUTES:
+ - displayProperty: [niceIcon: true] - is readonly
+
+ - rderiveddata: [sx-dx] - is readonly
+
+ - rderivedschema: [sx-dx] - is readonly
+
+ - rderToBePropagated: [sx-dx] - is readonly
+
+ VIRTUAL ATTRIBUTES:
+[...]
+--
+
+===== Read option
+The option to read the group passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh group --read {GROUP-ID} {GROUP-ID} [...]
+--
+
+[source]
+--
+
+You are runnig: group --read 15
+
+ > GROUP ID: 15
+ name: additional
+ type: GROUP
+ realm: /even
+ status: null
+ user owner: null
+ group owner: null
+ RESOURCES:
+ PLAIN ATTRIBUTES:
+ DERIVED ATTRIBUTES:
+ - displayProperty: [: ] - is readonly
+
+ - rderToBePropagated: [-] - is readonly
+
+ - rderiveddata: [-] - is readonly
+
+ - rderivedschema: [-] - is readonly
+
+ VIRTUAL ATTRIBUTES:
+
+--
+
+===== Read attribute of type option
+The option to read the specified attribute type of the group passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh group --read-attr-by-schema-type {GROUP-ID} {SCHEMA-TYPE}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+--
+
+[source]
+--
+
+You are runnig: group --read-attr-by-schema-type 15 DERIVED
+ - displayProperty: [: ] - is readonly
+
+ - rderToBePropagated: [-] - is readonly
+
+ - rderiveddata: [-] - is readonly
+
+ - rderivedschema: [-] - is readonly
+
+--
+
+===== Read an attribute of type option
+The option to read the specified attribute name of the group passed as input.
+
+[source]
+--
+$ ./syncopeadm.sh group --read-attr-by-schema {GROUP-ID} {SCHEMA-TYPE} {SCHEMA-NAME}
+ Schema type: PLAIN / DERIVED / VIRTUAL
+--
+
+[source]
+--
+
+You are runnig: group --read-attr-by-schema 12 PLAIN title
+ - title: [r12]
+
+--
+
+===== Delete option
+The option to delete a specified group.
+
+[source]
+--
+$ ./syncopeadm.sh group --delete {GROUP-ID} {GROUP-ID} [...]
+--
+
+The delete option, as can be imagined, tries to remove a specified group.
+The output will be something like:
+[source]
+--
+ - Group {GROUP-ID} successfully deleted
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/78204b93/src/main/asciidoc/cli-realm.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli-realm.adoc b/src/main/asciidoc/cli-realm.adoc
new file mode 100644
index 0000000..2b6855b
--- /dev/null
+++ b/src/main/asciidoc/cli-realm.adoc
@@ -0,0 +1,111 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+==== Realm command
+The realm command serves to retrieve the information about the configured realm.
+
+===== Help message
+[source,bash]
+----
+Usage: realm [options]
+ Options:
+ --help
+ --details
+ --list
+----
+
+===== Details option
+This option shows a table with realm amount.
+
+[source]
+--
+$ ./syncopeadm.sh realm --details
+--
+
+[source]
+--
+
+You are runnig: realm --details
+
+############################
+# #
+# REALMS DETAILS #
+# #
+############################
+# # #
+# DETAIL # VALUE #
+# # #
+############################
+# # #
+# Total number # 4 #
+# # #
+############################
+
+--
+
+===== List option
+Running the command with this option you will see the list of the realms.
+
+[source]
+--
+$ ./syncopeadm.sh realm --list
+--
+
+[source]
+--
+
+You are runnig: realm --list
+
+ > REALM ID: 1
+ name: /
+ full path: /
+ actions: []
+ templates: {}
+ parent id: 0
+ account policy id: null
+ password policy id: 4
+
+ > REALM ID: 2
+ name: odd
+ full path: /odd
+ actions: []
+ templates: {}
+ parent id: 1
+ account policy id: 6
+ password policy id: 4
+
+ > REALM ID: 3
+ name: even
+ full path: /even
+ actions: []
+ templates: {}
+ parent id: 1
+ account policy id: null
+ password policy id: 4
+
+ > REALM ID: 4
+ name: two
+ full path: /even/two
+ actions: []
+ templates: {}
+ parent id: 3
+ account policy id: 5
+ password policy id: 2
+
+--
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/syncope/blob/78204b93/src/main/asciidoc/cli.adoc
----------------------------------------------------------------------
diff --git a/src/main/asciidoc/cli.adoc b/src/main/asciidoc/cli.adoc
index 582b140..4d6784d 100644
--- a/src/main/asciidoc/cli.adoc
+++ b/src/main/asciidoc/cli.adoc
@@ -50,4 +50,8 @@ include::cli-info.adoc[]
include::cli-entitlement.adoc[]
-include::cli-domain.adoc[]
\ No newline at end of file
+include::cli-domain.adoc[]
+
+include::cli-realm.adoc[]
+
+include::cli-group.adoc[]
\ No newline at end of file