cfadmin

Used internally by Lucee (and Railo) in the administrator to apply settings. This tag is considered undocumented / subject to change.

  <cfadmin>

 cfadmin();

This tag requires Lucee. Not supported on Adobe ColdFusion.

cfadmin Attribute Reference

action string
Required

The administrative action to perform.

type string
Required

The admin context: web or server
Values:
  • web
  • server

password string
Required

The admin password.

Links more information about cfadmin

Examples sample code using the cfadmin tag

<cfadmin
 action="collection"
 type="web|server"
 password="password"
 collectionAction="create"
 collection="#form.collName#"
 path="#form.collPath#"
 language="#form.collLanguage#"
 remoteClients="arrayOfClients">

<cfadmin
 action="collection"
 type="web|server"
 password="password"
 collectionAction="delete"
 collection="#form.name[key]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="collection"
 type="web|server"
 password="password"
 collectionAction="optimize"
 collection="#form.name[key]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="collection"
 type="web|server"
 password="password"
 collectionAction="repair"
 collection="#form.name[key]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="compileMapping"
 type="web|server"
 password="password"
 virtual="#data.virtuals[idx]#"
 stoponerror="#data.stoponerrors[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="connect"
 type="web|server"
 password="password">

<cfadmin
 action="createArchive"
 type="web|server"
 password="password"
 file="#target#"
 virtual="#data.virtuals[idx]#"
 secure="#data.secure[idx]#"
 append="#notdoDownload#"
 remoteClients="arrayOfClients">

<cfadmin
 action="createSecurityManager"
 type="web|server"
 password="password"
 id="#form.id#">

<cfadmin
 action="defaultSecurityManager"
 type="web|server"
 password="password"
 returnVariable="access">

<cfadmin
 action="executeSpoolerTask"
 type="web|server"
 password="password"
 id="#data.ids[idx]#">

<cfadmin
 action="getApplicationListener"
 type="web|server"
 password="password"
 returnVariable="listener">

<cfadmin
 action="getApplicationSetting"
 type="web|server"
 password="password"
 returnVariable="appSettings">

<cfadmin
 action="getCharset"
 type="web|server"
 password="password"
 returnVariable="charset">

<cfadmin
 action="getComponent"
 type="web|server"
 password="password"
 returnVariable="component">

<cfadmin
 action="getContextes"
 type="web|server"
 password="password"
 returnVariable="contextes">

<cfadmin
 action="getCustomTagMappings"
 type="web|server"
 password="password"
 returnVariable="mappings">

<cfadmin
 action="getCustomtagSetting"
 type="web|server"
 password="password"
 returnVariable="setting">

<cfadmin
 action="getDatasource"
 type="web|server"
 password="password"
 name="#form.name#"
 returnVariable="existing">

<cfadmin
 action="getDatasourceDriverList"
 type="web|server"
 password="password"
 returnVariable="dbdriver">

<cfadmin
 action="getDatasourceSetting"
 type="web|server"
 password="password"
 returnVariable="dbSetting">

<cfadmin
 action="getDebug"
 type="web|server"
 password="password"
 returnVariable="debug">

<cfadmin
 action="getDebugData"
 returnVariable="debugging">

<cfadmin
 action="getDebuggingList"
 type="web|server"
 password="password"
 returnVariable="debug_templates">

<cfadmin
 action="getDefaultPassword"
 type="web|server"
 password="password"
 returnVariable="defaultPassword">

<cfadmin
 action="getDefaultSecurityManager"
 type="web|server"
 password="password"
 returnVariable="access">

<cfadmin
 action="getError"
 type="web|server"
 password="password"
 returnVariable="err">

<cfadmin
 action="getErrorList"
 type="web|server"
 password="password"
 returnVariable="err_templates">

<cfadmin
 action="getExtensionInfo"
 type="web|server"
 password="password"
 returnVariable="info">

<cfadmin
 action="getExtensionProviders"
 type="web|server"
 password="password"
 returnVariable="providers">

<cfadmin
 action="getExtensions"
 type="web|server"
 password="password"
 returnVariable="extensions">

<cfadmin
 action="getFLDs"
 type="web|server"
 password="password"
 returnVariable="flds">

<cfadmin
 action="getJavaCFXTags"
 type="web|server"
 password="password"
 returnVariable="jtags">

<cfadmin
 action="getLocales"
 locale="#stText.locale#"
 returnVariable="locales">

<cfadmin
 action="getMailServers"
 type="web|server"
 password="password"
 returnVariable="ms">

<cfadmin
 action="getMailSetting"
 type="web|server"
 password="password"
 returnVariable="mail">

<cfadmin
 action="getMappings"
 type="web|server"
 password="password"
 returnVariable="mappings">

<cfadmin
 action="getOutputSetting"
 type="web|server"
 password="password"
 returnVariable="setting">

<cfadmin
 action="getPluginDirectory"
 type="web|server"
 password="password"
 returnVariable="pluginDir">

<cfadmin
 action="getProxy"
 type="web|server"
 password="password"
 returnVariable="proxy">

<cfadmin
 action="getRegional"
 type="web|server"
 password="password"
 returnVariable="regional">

<cfadmin
 action="getRemoteClient"
 type="web|server"
 password="password"
 url="#data.urls[idx]#"
 returnVariable="rclient">

<cfadmin
 action="getRemoteClients"
 type="web|server"
 password="password"
 returnVariable="clients">

<cfadmin
 action="getRemoteClientUsage"
 type="web|server"
 password="password"
 returnVariable="usage">

<cfadmin
 action="getScope"
 type="web|server"
 password="password"
 returnVariable="scope">

<cfadmin
 action="getSecurityManager"
 type="web|server"
 password="password"
 id="#url.id#"
 returnVariable="access">

<cfadmin
 action="getSpoolerTasks"
 type="web|server"
 password="password"
 returnVariable="tasks">

<cfadmin
 action="getTimeZones"
 locale="#stText.locale#"
 returnVariable="timezones">

<cfadmin
 action="getTLDs"
 type="web|server"
 password="password"
 returnVariable="tlds">

<cfadmin
 action="getUpdate"
 type="web|server"
 password="password"
 returnvariable="update">

<cfadmin
 action="hasPassword"
 type="web|server"
 returnVariable="hasPassword">

<cfadmin
 action="index"
 type="web|server"
 password="password"
 indexAction="purge"
 collection="#form.name[key]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="index"
 type="web|server"
 password="password"
 indexAction="update"
 indexType="path"
 collection="#url.collection#"
 key="#form.path#"
 urlpath="#form.url#"
 extensions="#form.extensions#"
 recurse="#structKeyExists(form,"recurse")andform.recurse#"
 language="#form.language#"
 remoteClients="arrayOfClients">

<cfadmin
 action="removeCFX"
 type="web|server"
 password="password"
 name="#data.names[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="removeCustomTag"
 type="web|server"
 password="password"
 virtual="#data.virtuals[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="removeDatasource"
 type="web|server"
 password="password"
 name="#data.names[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="removeDefaultPassword"
 type="web|server"
 password="password">

<cfadmin
 action="removeExtension"
 type="web|server"
 password="password"
 provider="#detail.installed.provider#"
 id="#detail.installed.id#">

<cfadmin
 action="removeMapping"
 type="web|server"
 password="password"
 virtual="#data.virtuals[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="removeProxy"
 type="web|server"
 password="password"
 >

<cfadmin
 action="removeRemoteClient"
 type="web|server"
 password="password"
 url="#data.urls[idx]#">

<cfadmin
 action="removeSecurityManager"
 type="web|server"
 password="password"
 id="#data.ids[idx]#">

<cfadmin
 action="removeSpoolerTask"
 type="web|server"
 password="password"
 id="#data.ids[idx]#">

<cfadmin
 action="removeUpdate"
 type="web|server"
 password="password"
 remoteClients="arrayOfClients">

<cfadmin
 action="resetId"
 type="web|server"
 password="password">

<cfadmin
 action="resetPassword"
 type="web|server"
 password="password"
 contextPath="#form.contextPath#">

<cfadmin
 action="restart"
 type="web|server"
 password="password"
 remoteClients="arrayOfClients">

<cfadmin
 action="runUpdate"
 type="web|server"
 password="password">

<cfadmin
 action="schedule"
 type="web|server"
 password="password"
 scheduleAction="delete"
 task="#data.names[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="schedule"
 type="web|server"
 password="password"
 scheduleAction="pause"
 task="#data.names[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="schedule"
 type="web|server"
 password="password"
 scheduleAction="resume"
 task="#data.names[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="schedule"
 type="web|server"
 password="password"
 scheduleAction="run"
 task="#data.names[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="schedule"
 type="web|server"
 password="password"
 scheduleAction="update"
 task="#form.name#"
 url="#form.url#"
 port="#form.port#"
 requesttimeout="#form.timeout#"
 username="#nullIfEmpty(form.username)#"
 schedulePassword="#nullIfEmpty(form.password)#"
 proxyserver="#nullIfEmpty(form.proxyserver)#"
 proxyport="#form.proxyport#"
 proxyuser="#nullIfEmpty(form.proxyuser)#"
 proxypassword="#nullIfEmpty(form.proxypassword)#"
 publish="#formBool('publish')#"
 resolveurl="#formBool('resolveurl')#"
 startdate="#nullIfNoDate('start')#"
 starttime="#nullIfNoTime('start')#"
 enddate="#nullIfNoDate('end')#"
 endtime="#nullIfNoTime('end')#"
 interval="#nullIfEmpty(form.interval)#"
 file="#nullIfEmpty(form.file)#"
 serverpassword="#variables.passwordserver#"
 remoteClients="arrayOfClients">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="access"
 secType="datasource">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="has.cfx_setting"
 secType="cfx_setting"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="has.cfx_usage"
 secType="cfx_usage"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="hasAccess"
 secType="custom_tag"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="hasAccess"
 secType="debugging"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="hasAccess"
 secType="mail"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="hasAccess"
 secType="mapping"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="hasAccess"
 secType="remote"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="hasAccess"
 secType="search"
 secValue="yes">

<cfadmin
 action="securityManager"
 type="web|server"
 password="password"
 returnVariable="hasAccess"
 secType="setting"
 secValue="yes">

<cfadmin
 action="storageGet"
 type="web|server"
 password="password"
 key="#url.plugin#"
 returnVariable="data">

<cfadmin
 action="storageSet"
 type="web|server"
 password="password"
 key="#url.plugin#"
 value="#data#">

<cfadmin
 action="updateApplicationListener"
 type="web|server"
 password="password"
 listenerType="#form.type#"
 listenerMode="#form.mode#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateApplicationSetting"
 type="web|server"
 password="password"
 scriptProtect="#form.scriptProtect#"
 AllowURLRequestTimeout="#structKeyExists(form,'AllowURLRequestTimeout')andform.AllowURLRequestTimeout#"
 requestTimeout="#CreateTimeSpan(form.request_days,form.request_hours,form.request_minutes,form.request_seconds)#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateCharset"
 type="web|server"
 password="password"
 templateCharset="#form.templateCharset#"
 webCharset="#form.webCharset#"
 resourceCharset="#form.resourceCharset#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateComponent"
 type="web|server"
 password="password"
 baseComponentTemplate="#form.baseComponentTemplate#"
 componentDumpTemplate="#form.componentDumpTemplate#"
 componentDataMemberDefaultAccess="#form.componentDataMemberDefaultAccess#"
 triggerDataMember="#isDefined('form.triggerDataMember')#"
 useShadow="#isDefined('form.useShadow')#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateCustomTag"
 type="web|server"
 password="password"
 virtual="#data.virtuals[idx]#"
 physical="#data.physicals[idx]#"
 archive="#data.archives[idx]#"
 primary="#data.primaries[idx]#"
 trusted="#data.trusteds[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateCustomTagSetting"
 type="web|server"
 password="password"
 deepSearch="#isDefined('form.customTagDeepSearchDesc')andform.customTagDeepSearchDescEQtrue#"
 localSearch="#isDefined('form.customTagLocalSearchDesc')andform.customTagLocalSearchDescEQtrue#"
 extensions="#form.extensions#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateDatasource"
 type="web|server"
 password="password"
 classname="#driver.getClass()#"
 dsn="#driver.getDSN()#"
 name="#form.name#"
 host="#form.host#"
 database="#form.database#"
 port="#form.port#"
 dbusername="#form.username#"
 dbpassword="#form.password#"
 connectionLimit="#form.connectionLimit#"
 connectionTimeout="#form.connectionTimeout#"
 blob="#getForm('blob',false)#"
 clob="#getForm('clob',false)#"
 allowed_select="#getForm('allowed_select',false)#"
 allowed_insert="#getForm('allowed_insert',false)#"
 allowed_update="#getForm('allowed_update',false)#"
 allowed_delete="#getForm('allowed_delete',false)#"
 allowed_alter="#getForm('allowed_alter',false)#"
 allowed_drop="#getForm('allowed_drop',false)#"
 allowed_revoke="#getForm('allowed_revoke',false)#"
 allowed_create="#getForm('allowed_create',false)#"
 allowed_grant="#getForm('allowed_grant',false)#"
 custom="#custom#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateDebug"
 type="web|server"
 password="password"
 debug="#form.debug#"
 debugTemplate="#form["debugTemplate_"&amp;form.debugtype]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateDefaultPassword"
 type="web|server"
 password="password"
 newPassword="#form._new_password#">

<cfadmin
 action="updateDefaultSecurity"
 type="web|server"
 password="password"
 setting="#fb('defaultSetting')#"
 file="#form.defaultFile#"
 direct_java_access="#fb('defaultDirectJavaAccess')#"
 mail="#fb('defaultMail')#"
 datasource="#fb('defaultDatasource')#"
 mapping="#fb('defaultMapping')#"
 custom_tag="#fb('defaultCustomTag')#"
 cfx_setting="#fb('defaultCfxSetting')#"
 cfx_usage="#fb('defaultCfxUsage')#"
 debugging="#fb('defaultDebugging')#"
 tag_execute="#fb('defaultTagExecute')#"
 tag_import="#fb('defaultTagImport')#"
 tag_object="#fb('defaultTagObject')#"
 tag_registry="#fb('defaultTagRegistry')#">

<cfadmin
 action="updateDefaultSecurityManager"
 type="web|server"
 password="password"
 setting="#fb('defaultSetting')#"
 file="#form.defaultFile#"
 direct_java_access="#fb('defaultDirectJavaAccess')#"
 mail="#fb('defaultMail')#"
 datasource="#form.defaultDatasource#"
 mapping="#fb('defaultMapping')#"
 remote="#fb('defaultRemote')#"
 custom_tag="#fb('defaultCustomTag')#"
 cfx_setting="#fb('defaultCfxSetting')#"
 cfx_usage="#fb('defaultCfxUsage')#"
 debugging="#fb('defaultDebugging')#"
 search="#fb('defaultSearch')#"
 scheduled_task="#fb('defaultScheduledTask')#"
 tag_execute="#fb('defaultTagExecute')#"
 tag_import="#fb('defaultTagImport')#"
 tag_object="#fb('defaultTagObject')#"
 tag_registry="#fb('defaultTagRegistry')#"
 access_read="#form.defaultaccess_read#"
 access_write="#form.defaultaccess_write#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateError"
 type="web|server"
 password="password"
 template500="#form["errorTemplate_"&amp;form.errtype500&amp;500]#"
 template404="#form["errorTemplate_"&amp;form.errtype404&amp;404]#"
 statuscode="#isDefined('form.doStatusCode')#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateExtension"
 type="web|server"
 password="password"
 config="#config#"
 provider="#detail.url#"
 id="#detail.app.id#"
 version="#detail.app.version#"
 name="#detail.app.name#"
 label="#detail.app.label#"
 description="#detail.app.description#"
 category="#detail.app.category#"
 image="#detail.app.image#"
 author="#detail.app.author#"
 codename="#detail.app.codename#"
 video="#detail.app.video#"
 support="#detail.app.support#"
 documentation="#detail.app.documentation#"
 forum="#detail.app.forum#"
 mailinglist="#detail.app.mailinglist#"
 network="#detail.app.network#"
 created="#detail.app.created#">

<cfadmin action="updateJavaCFX"
 type="web|server"
 password="password"
 name="#data.names[idx]#"
 class="#data.classes[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateMailSetting"
 type="web|server"
 password="password"
 logfile="#form.logFile#"
 loglevel="#form.loglevel#"
 spoolEnable="#isDefined("form.spoolenable")andform.spoolenable#"
 spoolInterval="#form.spoolInterval#"
 timeout="#form.timeout#"
 defaultEncoding="#form.defaultEncoding#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateMapping"
 type="web|server"
 password="password"
 virtual="#data.virtuals[idx]#"
 physical="#data.physicals[idx]#"
 archive="#data.archives[idx]#"
 primary="#data.primaries[idx]#"
 trusted="#data.trusteds[idx]#"
 toplevel="#data.toplevels[idx]#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateOutputSetting"
 type="web|server"
 password="password"
 supressWhiteSpace="#isDefined('form.supressWhitespace')andform.supressWhitespace#"
 showVersion="#isDefined('form.showVersion')andform.showVersion#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updatePassword"
 type="web|server"
 newPassword="#form.new_password#">

<cfadmin
 action="updateProxy"
 type="web|server"
 password="password"
 proxyEnabled="true"
 proxyServer="#proxy.server#"
 proxyPort="#proxy.port#"
 proxyUsername="#proxy.username#"
 proxyPassword="#proxy.password#">

<cfadmin
 action="updatePSQ"
 type="web|server"
 password="password"
 psq="#structKeyExists(form,"psq")andform.psq#">

<cfadmin
 action="updateRegional"
 type="web|server"
 password="password"
 timezone="#form.timezone#"
 locale="#form.locale#"
 timeserver="#form.timeserver#"
 remoteClients="arrayOfClients">

<cfadmin
 action="updateRemoteClient"
 type="web|server"
 remotetype="web|server"
 password="password"
 attributeCollection="#attrColl#">

<cfadmin
 action="updateScope"
 type="web|server"
 password="password"
 sessionType="#form.sessionType#"
 localMode="#form.localMode#"
 scopeCascadingType="#form.scopeCascadingType#"
 allowImplicidQueryCall="#isDefined("form.allowImplicidQueryCall")andform.allowImplicidQueryCall#"
 mergeFormAndUrl="#isDefined("form.mergeFormAndUrl")andform.mergeFormAndUrl#"
 sessionTimeout="#CreateTimeSpan(form.session_days,form.session_hours,form.session_minutes,form.session_seconds)#"
 applicationTimeout="#CreateTimeSpan(form.application_days,form.application_hours,form.application_minutes,form.application_seconds)#"
 sessionManagement="#isDefined("form.sessionManagement")andform.sessionManagement#"
 clientManagement="#isDefined("form.clientManagement")andform.clientManagement#"
 clientCookies="#isDefined("form.clientCookies")andform.clientCookies#"
 domaincookies="#isDefined("form.domaincookies")andform.domaincookies#"
 remoteClients="arrayOfClients">

<cfadmin
 action="UpdateUpdate"
 type="web|server"
 password="password"
 updateType="#form.type#"
 updateLocation="#form.location#"
 remoteClients="arrayOfClients">

<cfadmin
 action="verifyDatasource"
 type="web|server"
 password="password"
 name="#data.names[idx]#"
 dbusername="#data.usernames[idx]#"
 dbpassword="#data.passwords[idx]#">

<cfadmin
 action="verifyJavaCFX"
 type="web|server"
 password="password"
 name="#data.names[idx]#"
 class="#data.classes[idx]#">

<cfadmin
 action="verifyMailServer"
 type="web|server"
 password="password"
 hostname="#data.hosts[idx]#"
 port="#data.ports[idx]#"
 mailusername="#data.usernames[idx]#"
 mailpassword="#data.passwords[idx]#">

<cfadmin
 action="verifyRemoteClient"
 type="web|server"
 password="password"
 attributeCollection="#rclient#">

Fork me on GitHub