Skip to end of banner
Go to start of banner

Parameters

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 72 Next »

Parameters

Parameters tell the CLI the specific details needed to perform an action.  Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform the task.

The CLI requires at least one special parameter named action that tells what action to perform, without the action parameter, CLI displays help with some example actions. Parameters do not have prefixes like actions and are often specific to the app for the action. 

For example, the action getServerInfo requires details about the app or server from where the information is retrieved. To obtain the required information, the server parameter is used.

The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.


  • No labels