Hyrax: BES Administrative Commands: Difference between revisions
From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
Line 43: | Line 43: | ||
---- | ---- | ||
=== | === GetConfig === | ||
Example: | Example: | ||
<hai: | <hai:GetConfig /> | ||
Retrieves the BES configuration file. | |||
Line 55: | Line 54: | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> | <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> | ||
<hai: | <hai:GetConfig /> | ||
</hai:BesAdminCmd> | </hai:BesAdminCmd> | ||
===== Response Example ===== | ===== Response Example ===== | ||
Returns the bes.conf file | |||
===== Request Example ===== | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> | |||
<hai:GetConfig module="ncml_module" /> | |||
</hai:BesAdminCmd> | |||
===== Response Example ===== | |||
Returns the configuration file for the ncml_module | |||
. | |||
=== SetConfig === | |||
Element form: | |||
<hai:SetConfig> | |||
''BES Configuration Content'' | |||
</hai:SetConfig> | |||
Retrieves the BES configuration file. | |||
===== Request Example ===== | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> | |||
<hai:SetConfig> | |||
BES.ServerAdministrator=admin.email.address@your.domain.name | |||
BES.User=user_name | |||
BES.Group=group_name | |||
BES.LogName=/usr/local/opendap/servers/hyrax-1.8.0/var/bes.log | |||
BES.LogVerbose=no | |||
BES.Catalog.catalog.RootDirectory=/Users/ndp/OPeNDAP/Projects/Hyrax/SVNDataProject | |||
</hai:SetConfig> | |||
</hai:BesAdminCmd> | |||
===== Response Example ===== | |||
Submits a new bes.conf file to the BES. | |||
===== Request Example ===== | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> | |||
<hai:SetConfig module="ncml_module"> | |||
BES.Include=dap.conf | |||
BES.modules+=ncml | |||
BES.module.ncml=/usr/local/opendap/servers/hyrax-1.8.0/lib/bes/libncml_module.so | |||
BES.Catalog.catalog.TypeMatch+=ncml:.*\.ncml(\.bz2|\.gz|\.Z)?$; | |||
NCML.TempDirectory=/tmp | |||
</hai:SetConfig> | |||
</hai:BesAdminCmd> | |||
===== Response Example ===== | |||
Returns a status indicating what happened (Was the configuration accepted, was it valid, did the bes restart, etc) | |||
. | |||
---- | ---- |
Revision as of 21:47, 26 May 2011
BES Administration Commands
Namespace: http://xml.opendap.org/ns/bes/admin/1.0#
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:Stop /> </hai:BesAdminCmd>
StopNow
Example:
<hai:StopNow/>
Stops all beslistener processes; does not wait for current transmissions to complete
Request Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:StopNow/> </hai:BesAdminCmd>
Response Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:OK/> </hai:BesAdminCmd>
<?xml version="1.0" encoding="UTF-8"?> <hai:ParseError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> message text </hai:ParseError>
<?xml version="1.0" encoding="UTF-8"?> <hai:BESError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> message text </hai:BESError>
GetConfig
Example:
<hai:GetConfig />
Retrieves the BES configuration file.
Request Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:GetConfig /> </hai:BesAdminCmd>
Response Example
Returns the bes.conf file
Request Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:GetConfig module="ncml_module" /> </hai:BesAdminCmd>
Response Example
Returns the configuration file for the ncml_module
.
SetConfig
Element form:
<hai:SetConfig> BES Configuration Content </hai:SetConfig>
Retrieves the BES configuration file.
Request Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:SetConfig> BES.ServerAdministrator=admin.email.address@your.domain.name BES.User=user_name BES.Group=group_name BES.LogName=/usr/local/opendap/servers/hyrax-1.8.0/var/bes.log BES.LogVerbose=no BES.Catalog.catalog.RootDirectory=/Users/ndp/OPeNDAP/Projects/Hyrax/SVNDataProject </hai:SetConfig> </hai:BesAdminCmd>
Response Example
Submits a new bes.conf file to the BES.
Request Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:SetConfig module="ncml_module"> BES.Include=dap.conf BES.modules+=ncml BES.module.ncml=/usr/local/opendap/servers/hyrax-1.8.0/lib/bes/libncml_module.so BES.Catalog.catalog.TypeMatch+=ncml:.*\.ncml(\.bz2|\.gz|\.Z)?$; NCML.TempDirectory=/tmp </hai:SetConfig> </hai:BesAdminCmd>
Response Example
Returns a status indicating what happened (Was the configuration accepted, was it valid, did the bes restart, etc)
.
Start
Example:
<hai:Start />
Starts the master beslistener process. If a beslistner is already running nothing will be done.
Request Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:Start /> </hai:BesAdminCmd>
Response Example
<?xml version="1.0" encoding="UTF-8"?> <hai:BesAdminCmd xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> <hai:OK/> </hai:BesAdminCmd>
<?xml version="1.0" encoding="UTF-8"?> <hai:ParseError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> message text </hai:ParseError>
<?xml version="1.0" encoding="UTF-8"?> <hai:BESError xmlns:hai="http://xml.opendap.org/ns/bes/admin/1.0#"> message text </hai:BESError>