Obsolete Pages{{Obsolete}}
The official documentation is at: http://docs.alfresco.com
{{AVMWarning}}
2.22.9AVM
The AVM Console is an administrator/developer tool for low-level interaction with the AVM. It is available with Alfresco 2.2 and higher.
You can access the AVM console via the URL:
http://<host>:<port>/alfresco/faces/jsp/admin/avm-console.jsp
Note: You must be logged-in as admin to access this page.
You can also access the AVM console (in embedded mode) from the command line tool via the class:
org.alfresco.repo.avm.AVMInterpreter (which supports the 'main' function)
Remember, you can also navigate AVM stores using the Alfresco Node Browser:
http://localhost:8080/alfresco/faces/jsp/admin/node-browser.jsp
Note: You must be logged-in as admin to access this page.
This might be useful if you wish to review certain store permissions/properties or node permissions/properties/aspects.
Enter commands into the Command box of the form:
command, arg1, arg2, arg3, ... argn
Note: the first comma and space are significant (before arg1) otherwise you may get a syntax error.
Enter further data into the Optional Data box for commands like write and create that require input data.
Click Execute to run the command.
The name of the store. Alphanumeric, and may also contain dash (-).
A valid avm path should be of the form:
storename:/name/name/name.../name.
The root of the store is simply:
storename:/
A version number is indicated by an integer constant.
-1 is used to reference the 'HEAD' version.
As of Alfresco 2.2.1, certain simple commands will default to -1 if version number is not supplied.
Lists all the avmstores.
lsrep
example
Lists the versions in a given store
lsver, storename
where
examples
Lists the versions in a given store
lsver, storename
lsver, storename, fromDate
lsver, storename, fromDate, toDate
where
examples
Create a new store.
mkrep, storename
where
examples
Creates a snapshot (a new version of an avmstore).
snap, storename, tag, description
where
examples
notes
Show information about a store.
statstore, storename
where
examples
Purges a store, i.e. makes it truly go away.
rmrep, storename
where
examples
Purges a particular version of a store.
rmver, storename, #versionnumber#
where
examples
Set the value of a store property.
setstoreproperty, storename, qname, value
where
and INT types are suppored as well as collections of these types. Collections
can be specified using a comma seperated list enclosed in square brackets.
examples
Set a permission mask on a store.
setstorepermission, storename, authority, permission
where
examples
Clears a permission mask on a store for a given authority.
clearstorepermission, storename, authority
where
examples
Lists the contents of the given directory.
ls, avmpath, #versionnumber#
where
examples
Lists the contents of the given directory recursively.
lsr, avmpath, #versionnumber#
where
examples
Loads content recursively into an avm directory.
load, fspath, avmpath
where
examples
Create a new directory
mkdir, avmpath, name
where
examples
Create a branch
mkbr, srcavmpath, dstavmpath, name, #versionnumber#
where
examples
Create a new layered directory
mkldir, targetavmpath, avmpath, name
where
examples
Set layered directory to be opaque (or not) to its indirection
setopacity, avmpath, bool
where
examples
Renames a node from one place to another.
rename, srcdiravmpath, srcname, dstdiravmpath, dstname
where
examples
Copies a file from one place to another.
cp, avmpath, #versionnumber#, diravmpath, name
where
examples
Shows the textual content of a node. Sorry no binary viewing.
cat, avmpath, #versionnumber#
where
examples
Remove a node.
rm, avmpath, name
where
examples
Writes content to an existing file.
write, avmpath
where
examples
Note: This command expects the content to be written in the Optional Data box.
Create a new file.
create, avmpath, name
where
examples
Note: This command expects the content to be written in the Optional Data box.
Get information on a node.
stat, avmpath, #versionnumber#
where
examples
List all properties of a node.
getnodeproperties, avmpath, #versionnumber#
where
examples
Describes a node (including lock information).
descnode, avmpath, #versionnumber#
where
examples
Delete a property of a node.
deletenodeproperty, avmpath, #versionnumber#, qname
where
examples
Set the value of node property.
setnodeproperty, avmpath, qname, value
where
NODE_REF and INT types are supported as well as collections of these types. Collections
must be specified using a comma separated list containing no spaces, enclosed in square brackets. For example: [aaa,bbb,ccc].
examples:
setnodeproperty, qwerty--admin:/www/avm_webapps/ROOT/folder1/file3.txt, {ah.model}aspectmv, [aaa,bbb,ccc,ddd,eee]
List all aspects of a node.
getnodeaspects, avmpath, #versionnumber#
where
examples
Add an aspect to a node.
addnodeaspect, avmpath, qname
where
examples
Remove an aspect and its properties from a node.
deletenodeaspect, avmpath, qname
where
examples
Set a permission mask on a node.
setnodepermission, avmpath, authority, permission
where
examples
Clears a permission mask on a node for a given authority.
clearnodepermission, avmpath, authority
where
examples
Get a list of the previous versions of a node.
history, avmpath, #versionnumber#, #count#
where
examples
Promotes a node from one tree to another.
update, avmpath, #versionnumber#, avmpath2
where
examples
Resets a layer.
resetLayer, avmpath
where
examples
Flattens a layer against a target tree.
flatten, avmpath1, avmpath2
where
examples
Create a new layered directory. Refer to Directory Commands above.
Compares two trees.
compare, avmpath1, #versionnumber1#, avmpath2, #versionnumber2#
where
examples
> lsrep
> mkrep, abc
> lsrep
[abc:admin:Fri Apr 04 11:58:07 BST 2008]
> statstore, abc
[abc:admin:Fri Apr 04 11:58:07 BST 2008]
{http://www.alfresco.org/model/content/1.0}creator: PropertyValue[actual-type=STRING, multi-valued=false, value-type=STRING, value=admin]
{http://www.alfresco.org/model/content/1.0}created: PropertyValue[actual-type=DATE, multi-valued=false, value-type=STRING, value=2008-04-04T11:58:07.457+01:00]
> lsver, abc
[abc:0:admin:Fri Apr 04 11:58:07 BST 2008:Initial Empty Version.]
> lsr, abc:/, -1
> mkdir, abc:/, testdir
> mkdir, abc:/testdir, testsubdir
> ls, abc:/, -1
testdir [PD:1033]
> lsr, abc:/, -1
testdir [PD:1033]
testsubdir [PD:1034]
> snap, abc
> lsver, abc
[abc:0:admin:Fri Apr 04 11:58:07 BST 2008:Initial Empty Version.]
[abc:1:admin:Fri Apr 04 12:02:37 BST 2008:null]
> mkdir, abc:/, testdir2
> snap, abc
> lsver, abc
[abc:0:admin:Fri Apr 04 11:58:07 BST 2008:Initial Empty Version.]
[abc:1:admin:Fri Apr 04 12:02:37 BST 2008:null]
[abc:2:admin:Fri Apr 04 12:04:08 BST 2008:null]
> rmver, abc, 1
> lsver, abc
[abc:0:admin:Fri Apr 04 11:58:07 BST 2008:Initial Empty Version.]
[abc:2:admin:Fri Apr 04 12:04:08 BST 2008:null]
> rmver, abc, 0
org.alfresco.service.cmr.avm.AVMBadArgumentException: Cannot purge initial version
> rmver, abc, -1
org.alfresco.service.cmr.avm.AVMNotFoundException: Version not found.
> rmrep, abc
> lsrep
> lsrep
[test--admin:admin:Thu Mar 20 18:13:52 GMT 2008]
[test--admin--preview:admin:Thu Mar 20 18:13:52 GMT 2008]
[test:admin:Thu Mar 20 18:13:52 GMT 2008]
[test--preview:admin:Thu Mar 20 18:13:53 GMT 2008]
> statstore, test--admin
[test--admin:admin:Thu Mar 20 18:13:52 GMT 2008]
{}.dns.admin.test: PropertyValue[actual-type=STRING, multi-valued=false, value-type=STRING, value=test--admin:/www/avm_webapps]
{}.background-layer.test: PropertyValue[actual-type=LONG, multi-valued=false, value-type=LONG, value=1]
{}.sandbox.store.test--admin: PropertyValue[actual-type=NULL, multi-valued=false, value-type=NULL, value=null]
{}.sandbox.author.main: PropertyValue[actual-type=NULL, multi-valued=false, value-type=NULL, value=null]
{http://www.alfresco.org/model/content/1.0}creator: PropertyValue[actual-type=STRING, multi-valued=false, value-type=STRING, value=admin]
{}.sandbox-id.6587650a-f6a9-11dc-ba7a-19d6d4e2fc41: PropertyValue[actual-type=NULL, multi-valued=false, value-type=NULL, value=null]
{}.website.name: PropertyValue[actual-type=STRING, multi-valued=false, value-type=STRING, value=test]
{http://www.alfresco.org/model/content/1.0}created: PropertyValue[actual-type=DATE, multi-valued=false, value-type=STRING, value=2008-03-20T18:13:52.073Z]
Ask for and offer help to other Alfresco Content Services Users and members of the Alfresco team.
Related links:
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.