Command Reference

Commands used in the DC/OS NiFi Service

Here is the complete list of DC/OS NiFi commands available:

  1. List IDs of all available configurations

    dcos nifi config list
    
  2. Display a specified configuration

    dcos nifi config show <config_id>
    
  3. Display the target configuration

    dcos nifi config target
    
  4. List ID of the target configuration

    dcos nifi config target_id
    
  5. List IDs of all available configurations

    dcos nifi debug config list
    
  6. Display a specified configuration

    dcos nifi debug config show <config_id>
    
  7. Display the target configuration

    dcos nifi debug config target
    
  8. List ID of the target configuration

    dcos nifi debug config target_id
    
  9. Display the Mesos framework ID

    dcos nifi debug state framework_id
    
  10. List names of all custom properties

    dcos nifi debug state properties
    
  11. Display the content of a specified property

    dcos nifi debug state property <name>
    
  12. Refresh the state cache, used for debugging

    dcos nifi debug state refresh_cache
    
  13. Pauses a pod’s tasks for debugging

    dcos nifi debug pod pause [<flags>] <pod>           
    -t, --tasks=TASKS ...  List of specific tasks to be paused, otherwise the entire pod
    
  14. Resumes a pod’s normal execution following a pause command

    dcos nifi debug pod resume [<flags>] <pod>         
    -t, --tasks=TASKS ...  List of specific tasks to be resumed, otherwise the entire pod
    
  15. View the configuration for this service

    dcos nifi describe
    
  16. View client endpoints

    dcos nifi endpoints [<name>]
    
  17. Show all plans for this service

    dcos nifi plan list
    
  18. Display the status of the plan with the provided plan name

    dcos nifi plan status [<flags>] <plan>   
    --json  Show raw JSON response instead of user-friendly tree
    
  19. Start the plan with the provided name and any optional plan arguments

    dcos nifi plan start <flags> <plan>
    -p, --params=PARAMS ...  Envvar definition in VAR=value form; can be repeated for multiple variables
    
  20. Stop the running plan with the provided name

    dcos nifi plan stop <plan>
    
  21. Pause the plan, or a specific phase in that plan with the provided phase name (or UUID)

    dcos nifi plan pause <plan> [<phase>]
    
  22. Resume the plan, or a specific phase in that plan with the provided phase name (or UUID)

    dcos nifi plan resume <plan> [<phase>]
    
  23. Restart the plan with the provided name, or a specific phase in the plan with the provided name, or a specific step in a phase of the plan with the provided step name.

    dcos nifi plan force-restart <plan> <phase> <step>
    
  24. Force complete a specific step in the provided phase. Example uses include the following: Abort a sidecar operation due to observed failure or known required manual preparation that was not performed

    dcos nifi plan force-complete <plan> [<phase> [<step>]]
    
  25. Display the list of known pod instances

    dcos nifi pod list
    
  26. Display the status for tasks in one pod or all pods

    dcos nifi pod status [<flags> <pod>]
    --json  Show raw JSON response instead of user-friendly tree
    
  27. Display the full state information for tasks in a pod

    dcos nifi pod info <pod>
    
  28. Restarts a given pod without moving it to a new agent

    dcos nifi pod restart <pod>
    
  29. Destroys a given pod and moves it to a new agent

    dcos nifi pod replace <pod>
    
  30. Display the Mesos framework ID

    dcos nifi state framework_id
    
  31. List names of all custom properties

    dcos nifi state properties
    
  32. Display the content of a specified property

    dcos nifi state property <name>
    
  33. Refresh the state cache, used for debugging

    dcos nifi state refresh_cache
    
  34. Launches an update operation

    dcos nifi update start [<flags>]
    --options=OPTIONS  Path to a JSON file that contains customized package installation options
    --package-version=PACKAGE-VERSION  
                       The desired package version
    --replace          Replace the existing configuration in whole. Otherwise, the existing configuration and options are merged.
    
  35. Force complete a specific step in the provided phase

    dcos nifi update force-complete <phase> <step>
    
  36. Restart update plan, or specific step in the provided phase

    dcos nifi update force-restart [<phase> [<step>]]
    
  37. View a list of available package versions to downgrade or upgrade to

    dcos nifi update package-versions
    
  38. Pause update plan

    dcos nifi update pause
    
  39. Resume update plan

    dcos nifi update resume
    
  40. View status of a running update

    dcos nifi update status [<flags>]
    --json  Show raw JSON response instead of user-friendly tree