Help

[iLoveTux]

I am running this on a Lubuntu 14.10 workstation.

I cloned the repository, I installed the pre-requisites and I built the project as per your instructions in README.md. Everything went as expected.

Now I am looking through the resulting directory structure, and there is no documentation...

I am what I would consider a competent sytem admin/developer, but I need some sort of pointer as to where to go now...

Could you please add a file which would give some basic commands I would issue, from there I am sure I can dig in and discover the more advanced functionality, but without a starting point I find I am unable to do a thing.

[iLoveTux]

OK, so I guess it's time to RTFM, but there is one problem...my employer will not authorize this, which puts me in an awkward position, because I will have to do this on my own time, which I don't really mind, but is a lot more limited than my work hours, and this will put us behind schedule...my boss doesn't like delays...

I am including a link to the apach ant manual in case anyone else happens across this issue in the search for information.

This is probably going to remove DCM as a possibility for us, my boss is talking about switching to dpBuddy (Which is ok I guess), but I would like to stick to IBM tools where I can, I guess this is just one of those times when I can't.

Anyway, Thanks for putting this out there, I do appreciate the time and effort. I will stay subscribed to this issue in case you decide to include a quick-start guide.

here is the link to the apache ant manual:

http://ant.apache.org/manual/index.html

[ghost]

We will have more documentation soon, but in the meantime, here's an example on how to use DCM. It is recommended that you use the Apache Ant that's packaged by the build script.

These are the operations that are available:

certificate-from-def - upload a cert (or multiple certs) based on a dcm:definition (with Crypto Certificate objects, of course)

check-access - check whether the device is accessible and that the userid/password works

checkpoint-delete - delete the specified checkpoint
checkpoint-restore - restore from the specified checkpoint
checkpoint-save - create/overwrite the specified checkpoint

create-tam-files - Create TAM files based on a whole bunch of parameters

clean - delete any temp files created by this ant script

domain-create - ensure the domain exists
domain-delete - delete the domain
domain-init - delete and recreate the domain, then upload the standard files
domain-quiesce - quiesce all the services in the domain
domain-recreate - delete and recreate the domain, then save
domain-reset - clear all the objects from the domain (but not files)
domain-restart - restart the domain
domain-unquiesce - unquiesce all the services in the domain

host-alias-remove - remove a specific host alias
host-alias-set - create/overwrite a host alias

idcred-from-def - create an idcred object based on a dcm:definition
idcred-from-key-and-cert - create an idcred object after uploading matching key and certificate files
idcred-from-p12 - create an idcred object after uploading a #PKCS12 file containing matching key and certificate

import-changed - import a specified .zip or .xcfg file into the domain, making changes along the way

key-from-def - upload a key (or multiple keys) based on a dcm:definition (with Crypto Key objects, of course)

load-balancer-group-from-def - create/overwrite a load balancer group object

ltpa-password - prompt the console user for the LTPA shared-secret password

main (default target) - execute the import-changed and save targets (in that order)

objects-from-def - create, delete, or modify objects based on dcm:object-* elements

save - save the domain

upload-dir - upload an entire directory
upload-from-def - upload files specified in dcm:definition/dcm:upload elements

valcred-from-def - create a valcred object based on a dcm:definition
valcred-from-dir - create a valcred object from a set of certificates in a directory

This script relies on the following ANT properties:

host - the hostname or IP address of the DataPower device
domain - the name of the domain on that device
uid - the userid on that device
pwd - the password for the userid on that device
port - the XML Management Interface port on that device (optional, defaults to 5550)

dcm.jar - location of DCM jar file
work.dir - location of DCM temp directory
dcm.dir - location of DCM stylesheets directory
schema.dir - location of directory used by DCM to cache internally-generated schemas 

An example usage to import a configuration file:

ant -f deploy.ant.xml -Ddcm.dir=.  -Dhost=mydphost -Duid=admin -Dpwd=admin -Ddomain=mydomain -Dimport.file=file_to_import.zip import-changed

All the above commands are in the comments in deploy.ant.xml file.

[iLoveTux]

Ok, This is perfect.

Thank you so much. I will mark this issue as closed because this gives me plenty to start with, but could I recomend moving these comments from deploy.ant.xml (This might be a standard place for this, but especially the section "IF YOU ARE NEW TO ANT" because if you are new to ANT then you wouldn't know to look in this file) into a file called quick-start.txt or if you can't do that maybe just putting a line in README.md pointing to this documentation.

These comments give me more than enough to start working with this tool, but I had no idea to look in that particular file.

Thank you so much for your response.

[ghost]

I am glad that helped. Like I said, we plan to have more documentation out soon. Feel free to let us know of any issues or questions.

[richgroot]

That new documentation is now available in the wiki. Check out the Quick Start page for getting DCM installed and the Easy On Ramp page for getting started with the basic concepts and a decent way of organizing your DCM assets.