Falcon supports the following options for Entity Management:
Table 3.3. Entity Actions
| Option | Entities | Definition | CLI Usage |
|---|---|---|---|
| submit | All | Creates a new cluster, feed, or process entity and validate it against the appropriate XSD. Check for dependent entities. | $FALCON_HOME/bin/falcon entity -submit -type cluster -file /cluster/definition.xml |
| list | All | Lists all scheduled and submitted entities in Falcon for a specified entity. | $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -list |
| dependency | Feeds, Processes | CLI dependency tracking. Returns all dependencies of the specified entity. | $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name $name -dependency |
| schedule | Feeds, Processes | Schedules submitted feeds or processes. | $FALCON_HOME/bin/falcon entity -type [process|feed] -name $name -schedule |
| suspend | Feeds, Processes | Suspends any scheduled entity by triggering suspend on the Oozie bundle. | $FALCON_HOME/bin/falcon entity -type [feed|process] -name $name -suspend |
| resume | Feeds, Processes | Restores a feed or process back to the active state, resuming the related Oozie bundle. | $FALCON_HOME/bin/falcon entity -type [feed|process] -name $name -resume |
| status | All | Current status of the entity. | $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name $name -status |
| definition | All | Current entity definition. Any documentation you have made within the entity will NOT be retained. | $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name $name -definition |
| delete | All | Removes the entity from any scheduled activity and the Falcon configuration store. | $FALCON_HOME/bin/falcon entity -type [cluster|feed|process] -name $name -delete |
| update | Feeds, Processes | Allows an already submitted or scheduled entity to be updated. Not allowed for cluster entities. | $FALCON_HOME/bin/falcon entity -type [feed|process] -name $name -update [-effective $effective time] |
