8:07 p.m.
Author: jaredmorgs
Date: 2012-06-18 21:07:18 -0400 (Mon, 18 Jun 2012)
New Revision: 8726
Modified:
epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml
epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml
epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
Log:
https://bugzilla.redhat.com/show_bug.cgi?id=795937 - Added SCP information to the Admin
Guide
Modified: epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml
===================================================================
--- epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml 2012-06-18 13:52:47
UTC (rev 8725)
+++ epp/docs/branches/5.2/Admin_Guide/en-US/Administration_Guide.xml 2012-06-19 01:07:18
UTC (rev 8726)
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
%BOOK_ENTITIES;
]>
@@ -10,5 +10,6 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="chapter-2-REST.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="chapter-3-Command_Line_Interface.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="chapter-4-Management_Extensions.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="chapter-5-Administration_and_Monitoring.xml"
encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Revision_History.xml"/>
</book>
Modified: epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml 2012-06-18 13:52:47 UTC (rev
8725)
+++ epp/docs/branches/5.2/Admin_Guide/en-US/Book_Info.xml 2012-06-19 01:07:18 UTC (rev
8726)
@@ -8,8 +8,8 @@
<subtitle>For use with JBoss Enterprise Portal Platform 5</subtitle>
<productname>JBoss Enterprise Portal Platform</productname>
<productnumber>5.2</productnumber>
- <edition>5.2.1</edition>
- <pubsnumber>100</pubsnumber>
+ <edition>5.2.2</edition>
+ <pubsnumber>3</pubsnumber>
<abstract>
<para>
This document is a guide to administering an implementation of JBoss
Enterprise Portal Platform. It is intended for System Administrators and assumes a high
level of technical knowledge.
Modified: epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml 2012-06-18 13:52:47 UTC
(rev 8725)
+++ epp/docs/branches/5.2/Admin_Guide/en-US/Revision_History.xml 2012-06-19 01:07:18 UTC
(rev 8726)
@@ -8,6 +8,34 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>5.2.2-3</revnumber>
+ <date>Tue Jun 19 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>BZ#795937 - Incorporated SCP documentation from Confluence.
</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>5.2.2-1</revnumber>
+ <date>Tue Jun 19 2012</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>BZ#803567 - Incorporated JON plug-in documentation from
Confluence. Condensed information to make it more concise.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>5.2.1-100</revnumber>
<date>Tue Apr 17 2012</date>
<author>
Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml
===================================================================
--- epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-06-18 13:52:47
UTC (rev 8725)
+++ epp/docs/branches/5.2/Admin_Guide/en-US/chapter-1-Introduction.xml 2012-06-19 01:07:18
UTC (rev 8726)
@@ -1,284 +1,277 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
<chapter id="sid-8094332_GateInManagement-Introduction">
-
- <title>Introduction</title>
- <para>The management component of the portal allows portal resources to be
managed over commons interfaces like REST, CLI, and Portlets/Gadgets. This guide will
discuss these interfaces as well as general portal management concepts and terms. It will
then discuss specific management extensions included in the portal.</para>
- <section id="sid-8094332_GateInManagement-Terms">
-
- <title>Terms</title>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>
- <para>Term</para>
- </entry>
- <entry>
- <para>
+ <title>Introduction</title>
+ <para>The management component of the portal allows portal resources to be
managed over commons interfaces like REST, CLI, and Portlets/Gadgets. This guide will
discuss these interfaces as well as general portal management concepts and terms. It will
then discuss specific management extensions included in the portal.</para>
+ <section id="sid-8094332_GateInManagement-Terms">
+ <title>Terms</title>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>
+ <para>Term</para>
+ </entry>
+ <entry>
+ <para>
Description
</para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>Management Extension</para>
- </entry>
- <entry>
- <para>An extension to the management system which defines a managed
component.</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
- Managed Component
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>Management Extension</para>
+ </entry>
+ <entry>
+ <para>An extension to the management system which defines a managed
component.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para> Managed Component
</para>
- </entry>
- <entry>
- <para>A managed component, which has been registered via an
extension, serves as the root managed resource for a component.</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>A managed component, which has been registered via an
extension, serves as the root managed resource for a component.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
Managed Resource
</para>
- </entry>
- <entry>
- <para>
- A managed resource is a uniquely identified self describing
'resource' which can have operations and sub-resources registered to it.
+ </entry>
+ <entry>
+ <para>
+ A managed resource is a uniquely identified self describing
'resource' which can have operations and sub-resources registered to
it.
</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
Sub-resource
</para>
- </entry>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>
A managed resource whose parent is also a managed resource.
</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
Address
</para>
- </entry>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>
A management address is just the path of the managed resource with
syntax similar to a file on a file system, ie: /foo/bar
</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
Operation
</para>
- </entry>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>
An action that can be performed on a managed resource.
</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
Attributes
</para>
- </entry>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>
Custom input parameters available to operations.
</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="sid-8094332_GateInManagement-Goals">
-
- <title>Goals</title>
- <para>The management component provides a foundation for managing portal side
components. By doing so it allows management extensions to register resources and
operations over a set of API's, which in turn allows us to expose these over common
interfaces like REST and CLI. In other words, management extensions don't have to
worry about the interfaces in which they will be managed over. This allows us to add
additional interfaces without needing to change anything. Also by providing a set of
API's to obtain managed resources, interfaces are built in a consistent manner. So
managing the same component in one interface should be very similar if you were to manage
it in another.</para>
- </section>
- <section id="sid-8094332_GateInManagement-Operations">
-
- <title>Operations</title>
- <para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="sid-8094332_GateInManagement-Goals">
+ <title>Goals</title>
+ <para>The management component provides a foundation for managing portal side
components. By doing so it allows management extensions to register resources and
operations over a set of API's, which in turn allows us to expose these over
common interfaces like REST and CLI. In other words, management extensions don't
have to worry about the interfaces in which they will be managed over. This allows us to
add additional interfaces without needing to change anything. Also by providing a set of
API's to obtain managed resources, interfaces are built in a consistent manner.
So managing the same component in one interface should be very similar if you were to
manage it in another.</para>
+ </section>
+ <section id="sid-8094332_GateInManagement-Operations">
+ <title>Operations</title>
+ <para>
The following operations are operations that have been identified by the
management component to be common to most management extensions. The
<code>read-resource</code>
operation is really the only global operation supported in the core framework,
all other operations need to be implemented by the extensions, since these would be
specific to each extension.
</para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>
- <para>Operation Name</para>
- </entry>
- <entry>
- <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>
+ <para>Operation Name</para>
+ </entry>
+ <entry>
+ <para>
Description
</para>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
read-resource
</para>
- </entry>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>
The read-resource operation is responsible for reading the managed
resource; describing itself and listing any operations and/or sub-resources it may
contain.
- This is the primary operation to obtain information about a managed
component and it's managed resources.
+ This is the primary operation to obtain information about a managed
component and it's managed resources.
</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
add-resource
</para>
- </entry>
- <entry>
- <para>The add-resource operation is responsible for adding/creating
additional managed resources.</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>The add-resource operation is responsible for adding/creating
additional managed resources.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
remove-resource
</para>
- </entry>
- <entry>
- <para>The remove-resource operation is responsible for
removing/deleting an existing managed resource.</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>update-resource</para>
- </entry>
- <entry>
- <para>The update-resource operation is responsible for updating an
existing managed resources state.</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>The remove-resource operation is responsible for
removing/deleting an existing managed resource.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>update-resource</para>
+ </entry>
+ <entry>
+ <para>The update-resource operation is responsible for updating an
existing managed resources state.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
read-config-as-xml
</para>
- </entry>
- <entry>
- <para>The read-config-as-xml operation is responsible for
representing the current managed resource as xml configuration.</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>The read-config-as-xml operation is responsible for
representing the current managed resource as xml configuration.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
export-resource
</para>
- </entry>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>
The export-resource operation is responsible for exporting a managed
resource in a format that is acceptable and used in an import. The export-resource is
special in the
- sense that there's built-in functionality to recursively traverse
managed resources until it finds one that supports an export-resource operation. In other
words you can
+ sense that there's built-in functionality to recursively
traverse managed resources until it finds one that supports an export-resource operation.
In other words you can
- register an export-resource operation on a sub-resource and it will be
executed even by calling export-resource on any of it's ancestors.
+ register an export-resource operation on a sub-resource and it will be
executed even by calling export-resource on any of it's ancestors.
</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
import-resource
</para>
- </entry>
- <entry>
- <para>
+ </entry>
+ <entry>
+ <para>
The import-resource operation is responsible for importing managed
resources previously exported through an export-resource operation.
</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="sid-8094332_GateInManagement-ContentType">
-
- <title>Content Type</title>
- <para>Content type defines the format of management requests/responses. The
three content types supported at the moment are json, xml, and zip. Since
read-config-as-xml (xml), export-resource (zip), and import-resource (zip) are content
type specific operations, the response must be in that format. Other then that it's up
to the extension on which content type is supported for each operation.</para>
- </section>
- <section id="sid-8094332_GateInManagement-PathTemplates">
-
- <title>Path Templates</title>
- <para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="sid-8094332_GateInManagement-ContentType">
+ <title>Content Type</title>
+ <para>Content type defines the format of management requests/responses. The
three content types supported at the moment are json, xml, and zip. Since
read-config-as-xml (xml), export-resource (zip), and import-resource (zip) are content
type specific operations, the response must be in that format. Other then that
it's up to the extension on which content type is supported for each
operation.</para>
+ </section>
+ <section id="sid-8094332_GateInManagement-PathTemplates">
+ <title>Path Templates</title>
+ <para>
Path templates are something that management extensions use to define dynamic
content when registering resources. These path template variables are used during an
export-resource to filter these managed resources. By specifying the
<code>filter</code>
attribute of an export-resource operation, managed resources can be explicitly
included or excluded during export.
</para>
- <para>The filter attribute has the following value syntax:</para>
- <example>
- <title>Filter Syntax</title>
-
<programlisting>[path-var]:(!)?[name],...[name];...[path-var]:(!)?[name],...[name]</programlisting>
- </example>
- <para>where path-var is the path template variable name, name is the name of
a managed-resource, and the '!' char, which is optional, is to exclude that
resource rather then include it. Below are some examples that use the path template
variable 'foo':</para>
- <example>
- <title>Only include managed resource 'bar'</title>
- <programlisting>foo:bar</programlisting>
- </example>
- <example>
- <title>Include managed resource 'bar' and
'foo-bar'</title>
- <programlisting>foo:bar,foo-bar</programlisting>
- </example>
- <example>
- <title>Exclude managed resource 'bar'</title>
- <programlisting>foo:!bar</programlisting>
- </example>
- <example>
- <title>Exclude managed resource 'bar' and
'foo-bar'</title>
- <programlisting>foo:!bar,foo-bar</programlisting>
- </example>
- <example>
- <title>Multiple path template variables (foo and baz) separated by the
';' char</title>
- <programlisting>foo:bar,foo-bar;baz:blah</programlisting>
- </example>
- <note>
- <title>Note</title>
- <para>For more information on the usage of path templates specific to a
management extension, see the management extensions section below.</para>
- </note>
- </section>
- </chapter>
+ <para>The filter attribute has the following value syntax:</para>
+ <example>
+ <title>Filter Syntax</title>
+
<programlisting>[path-var]:(!)?[name],...[name];...[path-var]:(!)?[name],...[name]</programlisting>
+ </example>
+ <para>where path-var is the path template variable name, name is the name of a
managed-resource, and the '!' char, which is optional, is to exclude
that resource rather then include it. Below are some examples that use the path template
variable 'foo':</para>
+ <example>
+ <title>Only include managed resource 'bar'</title>
+ <programlisting>foo:bar</programlisting>
+ </example>
+ <example>
+ <title>Include managed resource 'bar' and
'foo-bar'</title>
+ <programlisting>foo:bar,foo-bar</programlisting>
+ </example>
+ <example>
+ <title>Exclude managed resource 'bar'</title>
+ <programlisting>foo:!bar</programlisting>
+ </example>
+ <example>
+ <title>Exclude managed resource 'bar' and
'foo-bar'</title>
+ <programlisting>foo:!bar,foo-bar</programlisting>
+ </example>
+ <example>
+ <title>Multiple path template variables (foo and baz) separated by the
';' char</title>
+ <programlisting>foo:bar,foo-bar;baz:blah</programlisting>
+ </example>
+ <note>
+ <title>Note</title>
+ <para>For more information on the usage of path templates specific to a
management extension, see the management extensions section below.</para>
+ </note>
+ </section>
+</chapter>
Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml
===================================================================
---
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2012-06-18
13:52:47 UTC (rev 8725)
+++
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-3-Command_Line_Interface.xml 2012-06-19
01:07:18 UTC (rev 8726)
@@ -1,62 +1,57 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
<chapter id="sid-8094332_GateInManagement-CommandLineInterface">
-
- <title>Command Line Interface</title>
- <para>The command line interface (CLI) component provides an interactive shell
using CRaSH to map commands to management requests. It connects over SSH, using the CRaSH
SSH plugin.</para>
- <note>
- <title>Note</title>
- <para>
+ <title>Command Line Interface</title>
+ <para>The command line interface (CLI) component provides an interactive shell
using CRaSH to map commands to management requests. It connects over SSH, using the CRaSH
SSH plugin.</para>
+ <note>
+ <title>Note</title>
+ <para>
For more information on CRaSH please visit
<ulink url="http://code.google.com/p/crsh/"/>
.
</para>
- </note>
- <section id="sid-8094332_GateInManagement-DeployingtheCLI">
-
- <title>Deploying the CLI</title>
- <para>
+ </note>
+ <section id="sid-8094332_GateInManagement-DeployingtheCLI">
+ <title>Deploying the CLI</title>
+ <para>
The JBoss Enterprise Portal Platform distribution includes an archive of the
gatein-management-cli application.
</para>
- <para>
+ <para>
To deploy the application, copy the
<filename><replaceable><JBOSS_HOME></replaceable>/gatein-management/gatein-management-cli.war</filename>
to the <filename>deploy</filename> directory of your portal profile
(<filename><replaceable><JBOSS_HOME></replaceable>/server/<replaceable>default</replaceable>/deploy/</filename>,
for example).
</para>
-
- </section>
- <section id="sid-8094332_GateInManagement-RunningtheCLI">
-
- <title>Running the CLI</title>
- <para>After deploying the CLI web application you can connect to the CLI over
SSH as follows</para>
- <example>
- <title>SSH Syntax</title>
- <programlisting>ssh -p <port>
<user>@<host></programlisting>
- </example>
- <example>
- <title>SSH Example</title>
- <programlisting>ssh -p 2000 root@localhost</programlisting>
- </example>
- <para>
+ </section>
+ <section id="sid-8094332_GateInManagement-RunningtheCLI">
+ <title>Running the CLI</title>
+ <para>After deploying the CLI web application you can connect to the CLI over
SSH as follows</para>
+ <example>
+ <title>SSH Syntax</title>
+ <programlisting>ssh -p <port>
<user>@<host></programlisting>
+ </example>
+ <example>
+ <title>SSH Example</title>
+ <programlisting>ssh -p 2000 root@localhost</programlisting>
+ </example>
+ <para>
You can change the default port that SSH listens on by changing the property
crash.ssh.port in the
<code>WEB-INF/crash/crash.properties</code>
file.
</para>
- <example>
- <title>crash.properties</title>
- <programlisting># VFS configuration
+ <example>
+ <title>crash.properties</title>
+ <programlisting># VFS configuration
crash.vfs.refresh_period=1
# SSH configuration
crash.ssh.port=2000</programlisting>
- </example>
- <important>
- <title>Important</title>
- <para>Make sure the configured port is open and not blocked by firewall
settings.</para>
- </important>
- </section>
- <section id="sid-8094332_GateInManagement-Commands">
-
- <title>Commands</title>
- <para>
+ </example>
+ <important>
+ <title>Important</title>
+ <para>Make sure the configured port is open and not blocked by firewall
settings.</para>
+ </important>
+ </section>
+ <section id="sid-8094332_GateInManagement-Commands">
+ <title>Commands</title>
+ <para>
The CLI component comes with a number of management commands that will execute
operations on managed resources in the portal. For a listing of all commands available
type in
<emphasis role="strong">help</emphasis>
in the shell. You can also add the help option
@@ -67,17 +62,16 @@
<emphasis role="strong">man</emphasis>
command can be executed for even more detailed information about the command.
</para>
- <section id="sid-8094332_GateInManagement-mgmt">
-
- <title>mgmt</title>
- <para>
+ <section id="sid-8094332_GateInManagement-mgmt">
+ <title>mgmt</title>
+ <para>
The mgmt command allows a user to connect and disconnect from the management
system. It also provides an
<code>exec</code>
command which allows more custom control over executing operations with the
management system.
</para>
- <example>
- <title>mgmt help</title>
- <programlisting>% mgmt -h
+ <example>
+ <title>mgmt help</title>
+ <programlisting>% mgmt -h
usage: mgmt[-h | --help] COMMAND [ARGS]
The most commonly used mgmt commands are:
@@ -94,36 +88,36 @@
[-c | --container] portal container name (default is portal)
%</programlisting>
- </example>
- <para>
+ </example>
+ <para>
The
<code>mgmt connect</code>
- command allows the user to connect to the management system, optionally
specifying a portal container (default is 'portal'). Since management commands are
administrative operations, the user must authenticate again in order to validate
authorization to the portal container.
+ command allows the user to connect to the management system, optionally
specifying a portal container (default is 'portal'). Since management
commands are administrative operations, the user must authenticate again in order to
validate authorization to the portal container.
</para>
- <example>
- <title>Connecting to default portal container</title>
- <programlisting>% mgmt connect
+ <example>
+ <title>Connecting to default portal container</title>
+ <programlisting>% mgmt connect
Password:
-Successfully connected to gatein management system: [user=root,
container='portal', host='127.0.0.1']
+Successfully connected to gatein management system: [user=root,
container='portal', host='127.0.0.1']
[ /]%</programlisting>
- </example>
- <example>
- <title>Connecting to portal container 'sample-portal' as user
john</title>
- <programlisting>% mgmt connect -u john -c sample-portal
+ </example>
+ <example>
+ <title>Connecting to portal container 'sample-portal' as
user john</title>
+ <programlisting>% mgmt connect -u john -c sample-portal
Password:
-Successfully connected to gatein management system: [user=john,
container='sample-portal', host='127.0.0.1']
+Successfully connected to gatein management system: [user=john,
container='sample-portal', host='127.0.0.1']
[ /]%</programlisting>
- </example>
- <para>
+ </example>
+ <para>
The
<code>mgmt exec</code>
command allows complete control over what to send to the management system.
</para>
- <example>
- <title>mgmt exec help</title>
- <programlisting>[ /]% mgmt exec -h
+ <example>
+ <title>mgmt exec help</title>
+ <programlisting>[ /]% mgmt exec -h
usage: mgmt [-h | --help] exec [-c | --contentType] [-f | --file] [-a | --attribute] [-o
| --operation] path
[-h | --help] command usage
@@ -134,20 +128,19 @@
path
[ /]%</programlisting>
- </example>
- <example>
- <title>Executing operation read-config-as-xml on managed component
foo</title>
- <programlisting>[ /]% mgmt exec --operation read-config-as-xml
--contentType xml /foo
-<?xml version='1.0' encoding='UTF-8'?>
+ </example>
+ <example>
+ <title>Executing operation read-config-as-xml on managed component
foo</title>
+ <programlisting>[ /]% mgmt exec --operation read-config-as-xml
--contentType xml /foo
+<?xml version='1.0' encoding='UTF-8'?>
<data>...</data>
[ /]%</programlisting>
- </example>
- </section>
- <section id="sid-8094332_GateInManagement-cat">
-
- <title>cat</title>
- <para>
+ </example>
+ </section>
+ <section id="sid-8094332_GateInManagement-cat">
+ <title>cat</title>
+ <para>
The
<code>cat</code>
command executes the
@@ -156,55 +149,53 @@
<code>read-config-as-xml</code>
operation.
</para>
- <example>
- <title>cat help</title>
- <programlisting>[ /]% cat -h
+ <example>
+ <title>cat help</title>
+ <programlisting>[ /]% cat -h
usage: cat [-h | --help] path
- [-h | --help] command usage
- path
+   [-h | --help] command usage
+   path
[ /]% cat /foo
-<?xml version='1.0' encoding='UTF-8'?>
+<?xml version='1.0' encoding='UTF-8'?>
<data>...</data>
[ /]%</programlisting>
- </example>
- </section>
- <section id="sid-8094332_GateInManagement-cd">
-
- <title>cd</title>
- <para>The cd command changes the current path of the CLI.</para>
- <example>
- <title>cd help</title>
- <programlisting>[ /]% cd -h
+ </example>
+ </section>
+ <section id="sid-8094332_GateInManagement-cd">
+ <title>cd</title>
+ <para>The cd command changes the current path of the CLI.</para>
+ <example>
+ <title>cd help</title>
+ <programlisting>[ /]% cd -h
usage: cd [-h | --help] path
- [-h | --help] command usage
- path
+   [-h | --help] command usage
+   path
[ /]%</programlisting>
- </example>
- <example>
- <title>Change path to /foo/bar</title>
- <programlisting>[ /]% cd /foo/bar
+ </example>
+ <example>
+ <title>Change path to /foo/bar</title>
+ <programlisting>[ /]% cd /foo/bar
[bar]%</programlisting>
- </example>
- </section>
- <section id="sid-8094332_GateInManagement-ls">
-
- <title>ls</title>
- <para>
+ </example>
+ </section>
+ <section id="sid-8094332_GateInManagement-ls">
+ <title>ls</title>
+ <para>
The
<code>ls</code>
command executes the
<code>read-resource</code>
operation on the current (or specified by the path) managed resource.
</para>
- <example>
- <title>ls help</title>
- <programlisting>[ /]% ls -h
+ <example>
+ <title>ls help</title>
+ <programlisting>[ /]% ls -h
usage: ls [-h | --help] path
[-h | --help] command usage
@@ -218,19 +209,18 @@
baz
[ /]%</programlisting>
- </example>
- </section>
- <section id="sid-8094332_GateInManagement-pwd">
-
- <title>pwd</title>
- <para>
+ </example>
+ </section>
+ <section id="sid-8094332_GateInManagement-pwd">
+ <title>pwd</title>
+ <para>
The
<code>pwd</code>
command prints out the current resource path of the CLI.
</para>
- <example>
- <title>pwd help</title>
- <programlisting>[ /]% pwd -h
+ <example>
+ <title>pwd help</title>
+ <programlisting>[ /]% pwd -h
usage: pwd [-h | --help]
[-h | --help] command usage
@@ -243,25 +233,24 @@
/foo/baz
[baz]%</programlisting>
- </example>
- </section>
- <section id="sid-8094332_GateInManagement-export">
-
- <title>export</title>
- <para>
+ </example>
+ </section>
+ <section id="sid-8094332_GateInManagement-export">
+ <title>export</title>
+ <para>
The
<code>export</code>
operation executes the
<code>export-resource</code>
operation on a managed resource and writes the exported content to the file.
</para>
- <important>
- <title>Important</title>
- <para>Since the CLI is connected to the portal server over SSH, the
export command will write to the servers file system, not the client.</para>
- </important>
- <example>
- <title>export help</title>
- <programlisting>[ /]% export -h
+ <important>
+ <title>Important</title>
+ <para>Since the CLI is connected to the portal server over SSH, the export
command will write to the servers file system, not the client.</para>
+ </important>
+ <example>
+ <title>export help</title>
+ <programlisting>[ /]% export -h
usage: export [-h | --help] [-f | --file] [-r | --filter] path
[-h | --help] command usage
@@ -270,46 +259,45 @@
path
[ /]%</programlisting>
- </example>
- <example>
- <title>Export resource foo to /tmp directory</title>
- <programlisting>[ /]% export --file /tmp foo
+ </example>
+ <example>
+ <title>Export resource foo to /tmp directory</title>
+ <programlisting>[ /]% export --file /tmp foo
Export complete ! File location: /tmp/foo_2011-10-21_18-29-36.zip
[ /%]</programlisting>
- </example>
- <note>
- <title>Note</title>
- <para>If you only specify a directory the export command will write a
file with the name of the managed resource and a timestamp.</para>
- </note>
- <example>
- <title>Export resource /foo to /tmp/export-example.zip
file</title>
- <programlisting>[ /]% export --file /tmp/export-example.zip foo
+ </example>
+ <note>
+ <title>Note</title>
+ <para>If you only specify a directory the export command will write a file
with the name of the managed resource and a timestamp.</para>
+ </note>
+ <example>
+ <title>Export resource /foo to /tmp/export-example.zip file</title>
+ <programlisting>[ /]% export --file /tmp/export-example.zip foo
Export complete ! File location: /tmp/export-example.zip
[ /%]</programlisting>
- </example>
- <example>
- <title>Export resource filtering on path template variable
bar</title>
- <programlisting>[ /]% export --file /tmp/export-filter-example.zip
--filter bar:baz,foo-bar foo
+ </example>
+ <example>
+ <title>Export resource filtering on path template variable
bar</title>
+ <programlisting>[ /]% export --file /tmp/export-filter-example.zip --filter
bar:baz,foo-bar foo
Export complete ! File location: /tmp/export-filter-example.zip
[ /%]</programlisting>
- </example>
- </section>
- <section id="sid-8094332_GateInManagement-import">
-
- <title>import</title>
- <para>
+ </example>
+ </section>
+ <section id="sid-8094332_GateInManagement-import">
+ <title>import</title>
+ <para>
The
<code>import</code>
command executes the
<code>import-resource</code>
operation on a managed resource.
</para>
- <example>
- <title>import help</title>
- <programlisting>[ /]% import -h
+ <example>
+ <title>import help</title>
+ <programlisting>[ /]% import -h
usage: importfile [-h | --help] [-f | --file] [-m | --importMode] path
[-h | --help] command usage
@@ -318,29 +306,99 @@
path
[ /]%</programlisting>
- </example>
- <important>
- <title>Important</title>
- <para>Since the CLI is connected to the portal server over SSH, the
import command must specify a file that exists on the server.</para>
- </important>
- <example>
- <title>Import file /tmp/foo.zip to resource foo</title>
- <programlisting>[ /]% import --file /tmp/foo.zip /foo
+ </example>
+ <important>
+ <title>Important</title>
+ <para>Since the CLI is connected to the portal server over SSH, the import
command must specify a file that exists on the server.</para>
+ </important>
+ <example>
+ <title>Import file /tmp/foo.zip to resource foo</title>
+ <programlisting>[ /]% import --file /tmp/foo.zip /foo
Successfully imported file /tmp/foo.zip
[ /]%</programlisting>
- </example>
- <example>
- <title>Import file /tmp/foo.zip to resource foo using importMode
overwrite</title>
- <programlisting>[ /]% import --file /tmp/foo.zip --importMode overwrite
/foo
+ </example>
+ <example>
+ <title>Import file /tmp/foo.zip to resource foo using importMode
overwrite</title>
+ <programlisting>[ /]% import --file /tmp/foo.zip --importMode overwrite
/foo
Successfully imported file /tmp/foo.zip
[ /]%</programlisting>
+ </example>
+ <note>
+ <title>Note</title>
+ <para>You can autocomplete the import modes by typing --importMode and
hitting tab.</para>
+ </note>
+ </section>
+ <section id="sid-8094332_GateInManagement-SecureCopy">
+ <title>Secure Copy (SCP)</title>
+ <para>
+ The CLI application supports SCP to execute the
+ <code>export-resource</code>
+ and
+ <code>import-resource</code>
+ operations. These operations are executed in order to export to and import from
a host other then the portal.
+ </para>
+ <section id="sid-8094332_GateInManagement-Export">
+ <title>Export</title>
+ <para>
+ To execute the
+ <code>export-resource</code>
+ operation using SCP the source of the SCP command is the portal server and the
target is the local file to export to.
+ </para>
+ <example>
+ <title>Syntax</title>
+ <programlisting>$ scp -P <port>
<user>@<host>:{portal-container}:{path}
<file></programlisting>
</example>
+ <para>
+ The
+ <code>portal-container</code>
+ is optional with default value being 'portal'. The
+ <code>path</code>
+ is the path of the resource supporting the
+ <code>export-resource</code>
+ operation.
+ </para>
+ <para>So to export 'foo/bar' resource assuming the CLI is
deployed to 'example.org'.</para>
+ <example>
+ <title>Export of foo/bar resource</title>
+ <programlisting>$ scp -P 2000
'root@example.org:portal:/foo/bar' bar.zip</programlisting>
+ </example>
+ <para>Attributes like 'filter' can be added to the path
of the SCP command just as you would add query parameters to a URL.</para>
+ <example>
+ <title>Export of foo/bar resource with filter</title>
+ <programlisting>$ scp -P 2000
'root@example.org:portal:/foo/bar?filter=bar:baz,foo-bar'
foo.zip</programlisting>
+ </example>
+ </section>
+ <section id="sid-8094332_GateInManagement-Import">
+ <title>Import</title>
+ <para>
+ To execute the
+ <code>import-resource</code>
+ operation using SCP the source of the SCP command is the local file and the
target is the portal server.
+ </para>
+ <example>
+ <title>Syntax</title>
+ <programlisting>$ scp -P <port> <file>
<user>@<host>:{portal-container}:{path}</programlisting>
+ </example>
+ <para>
+ The
+ <code>portal-container</code>
+ is optional with default value being 'portal'. The
+ <code>path</code>
+ is the path of the resource that supports the
+ <code>import-resource</code>
+ operation. So to import a foo.zip file to the /foo resource assuming the CLI is
deployed to 'example.org'.
+ </para>
+ <example>
+ <title>Import foo.zip to foo resource</title>
+ <programlisting>$ scp -P 2000 foo.zip
'root@example.org:portal:/foo'</programlisting>
+ </example>
<note>
<title>Note</title>
- <para>You can autocomplete the import modes by typing --importMode and
hitting tab.</para>
+ <para>More specific examples of the SCP command can be found below
pertaining to that particular management extension.</para>
</note>
</section>
</section>
- </chapter>
+ </section>
+</chapter>
Modified: epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml
===================================================================
--- epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-06-18
13:52:47 UTC (rev 8725)
+++ epp/docs/branches/5.2/Admin_Guide/en-US/chapter-4-Management_Extensions.xml 2012-06-19
01:07:18 UTC (rev 8726)
@@ -490,5 +490,32 @@
</important>
</section>
</section>
+ <section id="sid-8094332_GateInManagement-SecureCopy-MOP">
+ <title>Secure Copy (SCP)</title>
+ <para>The SCP command can be used to export and import MOP artifacts: site
layout, pages, and navigation over different hosts. The following examples assume the
portal and CLI is running at host 'example.org' with default ssh port
configured to 2000.</para>
+ <para>The
+ <code>export-resource</code>
+ command is supported on all resources of the MOP extension. Use the following
examples as syntax guides to export artifacts based on the configuration of the production
network.
+ </para>
+ <example>
+ <title>Export MOP artifacts</title>
+ <programlisting>$ scp -P 2000
'root@example.org:portal:/mop/portalsites/classic' classic.zip
+$ scp -P 2000
'root@example.org:portal:/mop/portalsites/classic/pages/homepage'
homepage.zip
+$ scp -P 2000 'root@example.org:portal:/mop'
mop.zip</programlisting>
+ </example>
+ <para>
+ The
+ <code>import-resource</code>
+ operation is only supported at the
+ <code>mop</code>
+ resource, so for every import the path must be '/mop'.
+ </para>
+ <example>
+ <title>Import MOP artifacts</title>
+ <programlisting>$ scp -P 2000 classic.zip
'root@example.org:portal:/mop'
+$ scp -P 2000 homepage.zip
'root@example.org:portal:/mop?importMode=overwrite'
+$ scp -P 2000 mop.zip
'root@example.org:portal:/mop'</programlisting>
+ </example>
+ </section>
</section>
</chapter>