| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2018-03-12 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20180312" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Falcon - FalconCLI</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> |
| |
| |
| |
| <script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> |
| </div> |
| </div> |
| <div class="pull-right"> </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="../index.html" title="Falcon"> |
| Falcon</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class="">FalconCLI</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> |
| <li id="projectVersion" class="pull-right">Version: 0.11</li> |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| <div class="section"> |
| <h2>FalconCLI<a name="FalconCLI"></a></h2> |
| <p>FalconCLI is a interface between user and Falcon. It is a command line utility provided by Falcon. FalconCLI supports Entity Management, Instance Management and Admin operations.There is a set of web services that are used by FalconCLI to interact with Falcon.</p></div> |
| <div class="section"> |
| <h4>Types of CLI Options<a name="Types_of_CLI_Options"></a></h4> |
| <p>CLI options are classified into :</p> |
| <p></p> |
| <ul> |
| <li><a href="#Common_CLI_Options">Common CLI Options</a></li> |
| <li><a href="#Entity_Management_Commands">Entity Management Commands</a></li> |
| <li><a href="#Instance_Management_Commands">Instance Management Commands</a></li> |
| <li><a href="#Metadata_Commands">Metadata Commands</a></li> |
| <li><a href="#Admin_Commands">Admin commands</a></li> |
| <li><a href="#Extension_Artifacts_Commands">Extension artifacts commands</a></li> |
| <li><a href="#Extension_Commands">Extension commands</a></li></ul><hr /></div> |
| <div class="section"> |
| <h3>Common CLI Options<a name="Common_CLI_Options"></a></h3></div> |
| <div class="section"> |
| <h4>Falcon URL<a name="Falcon_URL"></a></h4> |
| <p>Optional -url option indicating the URL of the Falcon system to run the command against can be provided. If not mentioned it will be picked from the system environment variable FALCON_URL. If FALCON_URL is not set then it will be picked from client.properties file. If the option is not provided and also not set in client.properties, Falcon CLI will fail.</p></div> |
| <div class="section"> |
| <h4>Proxy user support<a name="Proxy_user_support"></a></h4> |
| <p>The -doAs option allows the current user to impersonate other users when interacting with the Falcon system. The current user must be configured as a proxyuser in the Falcon system. The proxyuser configuration may restrict from which hosts a user may impersonate users, as well as users of which groups can be impersonated.</p> |
| <p><a href="../FalconDocumentation.html#Proxyuser_support">Proxyuser support described here.</a></p></div> |
| <div class="section"> |
| <h4>Debug Mode<a name="Debug_Mode"></a></h4> |
| <p>If you export FALCON_DEBUG=true then the Falcon CLI will output the Web Services API details used by any commands you execute. This is useful for debugging purposes to or see how the Falcon CLI works with the WS API. Alternately, you can specify '-debug' through the CLI arguments to get the debug statements. Example: $FALCON_HOME/bin/falcon entity -submit -type cluster -file /cluster/definition.xml -debug</p><hr /></div> |
| <div class="section"> |
| <h3>Entity Management Commands<a name="Entity_Management_Commands"></a></h3> |
| <p></p> |
| <table border="0" class="table table-striped"> |
| <tr class="a"> |
| <th>Command</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./Submit.html">Submit</a></td> |
| <td>Submit the entity definition.</td></tr> |
| <tr class="a"> |
| <td><a href="./Schedule.html">Schedule</a></td> |
| <td>Scheduled the entity</td></tr> |
| <tr class="b"> |
| <td><a href="./SuspendEntity.html">Suspend</a></td> |
| <td>Suspends the scheduled entity</td></tr> |
| <tr class="a"> |
| <td><a href="./ResumeEntity.html">Resume</a></td> |
| <td>Puts a suspended entity back in action</td></tr> |
| <tr class="b"> |
| <td><a href="./DeleteEntity.html">Delete</a></td> |
| <td>Remove the submitted entity</td></tr> |
| <tr class="a"> |
| <td><a href="./ListEntity.html">List</a></td> |
| <td>Lists the particular type of entity</td></tr> |
| <tr class="b"> |
| <td><a href="./SummaryEntity.html">Summary</a></td> |
| <td>Shows summary of the type of entity</td></tr> |
| <tr class="a"> |
| <td><a href="./UpdateEntity.html">Update</a></td> |
| <td>Update already submitted entity</td></tr> |
| <tr class="b"> |
| <td><a href="./Touch.html">Touch</a></td> |
| <td>Force update already submitted entity</td></tr> |
| <tr class="a"> |
| <td><a href="./StatusEntity.html">Status</a></td> |
| <td>Return's the status of the entity</td></tr> |
| <tr class="b"> |
| <td><a href="./DependencyEntity.html">Dependency</a></td> |
| <td>List all the entities on which the specified entity is dependent</td></tr> |
| <tr class="a"> |
| <td><a href="./Definition.html">Definition</a></td> |
| <td>Return's the definition of the entity</td></tr> |
| <tr class="b"> |
| <td><a href="./Lookup.html">Lookup</a></td> |
| <td>Return's the feed name for a path</td></tr> |
| <tr class="a"> |
| <td><a href="./SLAAlert.html">SLAAlert</a></td> |
| <td>Return's the feed instance which have missed sla</td></tr></table><hr /></div> |
| <div class="section"> |
| <h3>Instance Management Commands<a name="Instance_Management_Commands"></a></h3> |
| <p></p> |
| <table border="0" class="table table-striped"> |
| <tr class="a"> |
| <th>Command</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./KillInstance.html">Kill</a></td> |
| <td>Kills all the instances of specified process</td></tr> |
| <tr class="a"> |
| <td><a href="./SuspendInstance.html">Suspend</a></td> |
| <td>Suspends instances of a specified process</td></tr> |
| <tr class="b"> |
| <td><a href="./ContinueInstance.html">Continue</a></td> |
| <td>Continue the failed workflow instances</td></tr> |
| <tr class="a"> |
| <td><a href="./RerunInstance.html">Rerun</a></td> |
| <td>Rerun instances of specified process</td></tr> |
| <tr class="b"> |
| <td><a href="./ResumeInstance.html">Resume</a></td> |
| <td>Resume instance of specified process from suspended state</td></tr> |
| <tr class="a"> |
| <td><a href="./SearchInstance.html">Search</a></td> |
| <td>Search instances</td></tr> |
| <tr class="b"> |
| <td><a href="./StatusInstance.html">Status</a></td> |
| <td>Gets the status of instances</td></tr> |
| <tr class="a"> |
| <td><a href="./ListInstance.html">List</a></td> |
| <td>Gets single or multiple instances</td></tr> |
| <tr class="b"> |
| <td><a href="./SummaryInstance.html">Summary</a></td> |
| <td>Gets consolidated status of the instances between the specified time period</td></tr> |
| <tr class="a"> |
| <td><a href="./RunningInstance.html">Running</a></td> |
| <td>Gets running instances of the mentioned process</td></tr> |
| <tr class="b"> |
| <td><a href="./FeedInstanceListing.html">FeedInstanceListing</a></td> |
| <td>Gets falcon feed instance availability</td></tr> |
| <tr class="a"> |
| <td><a href="./LogsInstance.html">Logs</a></td> |
| <td>Gets logs for instance</td></tr> |
| <tr class="b"> |
| <td><a href="./LifeCycleInstance.html">LifeCycle</a></td> |
| <td>Describes list of life cycles of a entity</td></tr> |
| <tr class="a"> |
| <td><a href="./TriageInstance.html">Triage</a></td> |
| <td>Traces entities ancestors for failure</td></tr> |
| <tr class="b"> |
| <td><a href="./ParamsInstance.html">Params</a></td> |
| <td>Displays workflow params</td></tr> |
| <tr class="a"> |
| <td><a href="./DependencyInstance.html">Dependency</a></td> |
| <td>Displays the dependent instances</td></tr></table><hr /></div> |
| <div class="section"> |
| <h3>Metadata Commands<a name="Metadata_Commands"></a></h3> |
| <p></p> |
| <table border="0" class="table table-striped"> |
| <tr class="a"> |
| <th>Command</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./LineageMetadata.html">Lineage</a></td> |
| <td>Returns the relationship between processes and feeds</td></tr> |
| <tr class="a"> |
| <td><a href="./VertexMetadata.html">Vertex</a></td> |
| <td>Gets the vertex with the specified id</td></tr> |
| <tr class="b"> |
| <td><a href="./VerticesMetadata.html">Vertices</a></td> |
| <td>Gets all vertices for a key</td></tr> |
| <tr class="a"> |
| <td><a href="./VertexEdgesMetadata.html">Vertex Edges</a></td> |
| <td>Gets the adjacent vertices or edges of the vertex</td></tr> |
| <tr class="b"> |
| <td><a href="./EdgeMetadata.html">Edge</a></td> |
| <td>Gets the edge with the specified id</td></tr> |
| <tr class="a"> |
| <td><a href="./ListMetadata.html">List</a></td> |
| <td>Return list of all dimension of given type</td></tr> |
| <tr class="b"> |
| <td><a href="./RelationMetadata.html">Relations</a></td> |
| <td>Return all dimensions related to specified Dimension</td></tr></table><hr /></div> |
| <div class="section"> |
| <h3>Admin Commands<a name="Admin_Commands"></a></h3> |
| <p></p> |
| <table border="0" class="table table-striped"> |
| <tr class="a"> |
| <th>Command</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./HelpAdmin.html">Help</a></td> |
| <td>Return help options</td></tr> |
| <tr class="a"> |
| <td><a href="./VersionAdmin.html">Version</a></td> |
| <td>Return current falcon version</td></tr> |
| <tr class="b"> |
| <td><a href="./StatusAdmin.html">Status</a></td> |
| <td>Return the status of falcon</td></tr> |
| <tr class="a"> |
| <td><a href="./SafemodeAdmin.html">SetSafeMode</a></td> |
| <td>Set/unset Falcon Server in safemode</td></tr></table><hr /></div> |
| <div class="section"> |
| <h3>Extension Artifacts Management Commands<a name="Extension_Artifacts_Management_Commands"></a></h3> |
| <p></p> |
| <table border="0" class="table table-striped"> |
| <tr class="a"> |
| <th>Command</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./EnumerateExtension.html">Enumerate</a></td> |
| <td>Return all the extensions supported</td></tr> |
| <tr class="a"> |
| <td><a href="./DescribeExtension.html">Describe</a></td> |
| <td>Return description of an extension</td></tr> |
| <tr class="b"> |
| <td><a href="./DefineExtension.html">Definition</a></td> |
| <td>Return the definition of an extension</td></tr></table><hr /></div> |
| <div class="section"> |
| <h3>Extension Job Management Commands<a name="Extension_Job_Management_Commands"></a></h3> |
| <p></p> |
| <table border="0" class="table table-striped"> |
| <tr class="a"> |
| <th>Command</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="./ExtensionList.html">List</a></td> |
| <td>List jobs generated from an extension</td></tr> |
| <tr class="a"> |
| <td><a href="./ExtensionInstances.html">Instances</a></td> |
| <td>List instances of an extension job</td></tr> |
| <tr class="b"> |
| <td><a href="./ExtensionValidate.html">Validate</a></td> |
| <td>Validate an extension job</td></tr> |
| <tr class="a"> |
| <td><a href="./ExtensionSubmit.html">Submit</a></td> |
| <td>Submit an extension job</td></tr> |
| <tr class="b"> |
| <td><a href="./ExtensionUpdate.html">Update</a></td> |
| <td>Update an extension job</td></tr> |
| <tr class="a"> |
| <td><a href="./ExtensionSubmitAndSchedule.html">SubmitAndSchedule</a></td> |
| <td>Submit and schedule an extension job</td></tr> |
| <tr class="b"> |
| <td><a href="./ExtensionSchedule.html">Schedule</a></td> |
| <td>Schedule an extension job</td></tr> |
| <tr class="a"> |
| <td><a href="./ExtensionSuspend.html">Suspend</a></td> |
| <td>Suspend an extension job</td></tr> |
| <tr class="b"> |
| <td><a href="./ExtensionResume.html">Resume</a></td> |
| <td>Resume an extension job</td></tr> |
| <tr class="a"> |
| <td><a href="./ExtensionDelete.html">Delete</a></td> |
| <td>Delete an extension job</td></tr></table></div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row span12">Copyright © 2013-2018 |
| <a href="http://www.apache.org">Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| <p id="poweredBy" class="pull-right"> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
