Cmdlet
Use this section to describe a cmdlet available for an operation. The section structure consists of the following elements:
- Short description — a short description of the cmdlet.
Start the description with a verb. Keep the description as short as possible so that users can grasp the main idea of the cmdlet functionality right from the short description. Do not add details on how the cmdlet works at this point.
- Applies to — a list of system requirements that must be met to perform operations with the product PowerShell.
- Syntax — the cmdlet syntax.
Depending on whether the cmdlet has either one parameter set or multiple parameter sets, add the following information:
- For one parameter set, use a syntax box to list the parameters in this set.
- For multiple parameter sets, provide a short description for each parameter set. Use multiple syntax boxes to list the parameters in these sets. The default parameter set must be the first entry in the list.
- Detailed description — detailed information on the cmdlet.
Specify the purpose of the cmdlet and list operations that can be performed with the cmdlet. Explain how the cmdlet is related to other cmdlets (if any).
For each parameter, define whether the parameter is required, specify its type and position, and define whether the parameter accepts pipeline input and supports wildcard characters.
If the cmdlet supports Microsoft PowerShell common parameters, include this subsection to provide a link to the Microsoft Common Parameter Reference.
Note |
For reference topics in Veeam technical documentation, we use slightly different rules from those defined in section Articles. However, these rules apply only to articles used in descriptions of parameters and properties. Particularly, when listing the parameters of a PowerShell cmdlet, we omit an article in a parameter description if it is the first word in the description. |
- [Optional] Output object — a description for the output object returned by the cmdlet.
- Example — a PowerShell script example that illustrates how to use the cmdlet.
- If the cmdlet has one parameter set that covers different usage scenarios, provide as many examples as possible to illustrate these scenarios.
First, add the most common scenarios that require minimum parameters. After that, add complex scenarios that require optional parameters.
- If the cmdlet has multiple parameter sets, provide a separate example for each parameter set.
Example
Short Description Connects to a Veeam backup server. Syntax This cmdlet provides three parameter sets.
Detailed Description This cmdlet creates a connection with a local or remote Veeam backup server. The connection starts a Veeam PowerShell session during which you can perform all available operations with Veeam PowerShell. Within one session, you can connect to one Veeam backup server. To connect to another Veeam backup server, you must close the current session. Run Disconnect-VBRServer to stop the session with the currently connected Veeam backup server. Parameters
Common Parameters This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs. Return Type None Example This command connects to the 172.17.53.36 server using User/Password authentication.
|