Formatting

To help users get through content more effectively and to draw attention to important information throughout the content, we use the following formatting in Veeam technical documentation.

Bold

Use bold formatting for static interface elements: wizard names, window names, buttons, links, options, check boxes, step names, list names, icon names, menu names, pane names, tab names, toolbar names, ribbon names and view names. Also, use bold formatting to describe report output: report names, section names and table names.

Formatting Important

To emphasize a key or a combination of keys pressed on the keyboard, include the key or the combination of keys in square brackets and do not use any formatting. For key combinations, do not insert spaces between keys and the plus sign.

Italic

Use italic formatting for selectable interface elements (that is, drop-down list options, object types) and input data you enter (that is, object names, parameter names, parameter values, field values). Also, use italic formatting for error messages, section names if referencing an external document, and state and status names.

Courier

Use courier formatting for anything that can be copied/pasted into a command line: URL paths, folder names, file names, utility names, syntax, variables, parameters and properties. 

Examples

  1. Complete the New Orchestration Plan wizard.
  2. At the Scope step, in the Available Scopes list, select a scope for which you want to create the plan.
  3. At the Virtual Machines step of the wizard, click Exclusions.
  4. On the Home tab, click Backup Job > Virtual machine > VMware vSphere.
  5. Use the toolbar at the top right corner of the window to switch between views: Hosts and Clusters, VMs and Templates, Datastores and VMs, VMs and Tags.
  6. Click the Schedule icon next to the Start testing on the following day and time field, configure the necessary schedule, and click Apply.
  7. Select the Limit maximum concurrent tasks check box and specify the maximum allowed number of concurrent tasks for the backup repository.
  8. To run the job at a specific time every day, select the Daily at this time option.
  9. Click the Pick resource pool for selected VMs link.
  10. In the Choose Resource Pool window, click Add VM.
  11. Use the Up and Down buttons on the right to move the VM or VM container up and down in the list.
  12. You can click the name of an undersized VM in the RAM analysis table to drill down to performance details for this VM.
  13. From the Performance Modeling Based On drop-down list, select Average Usage.
  14. In the Top N Count field, enter 10.
  15. When configuring global email notification settings, make sure you select an event type on which you want to receive reports. You can select any of the following event types: Success, Warning or Error.
  16. If none of the conditions listed in the Extent state column is true, the report status will be shown as Success.
  17. This action will interrupt plan execution. Currently executing steps will be completed, then the plan will enter the Halted state.
  18. If a Veeam Agent backup job managed by the backup server fails to complete successfully, you will encounter the following error: Failed to start backup job Error: Unknown invoker method: 2757.
  19. In a web browser, navigate to the VAO UI web address. The address consists of a FQDN of the VAO server and the website port specified during installation: https://<hostname>:<port>
  20. To define a list of exclusions, you can use environmental variables such as %TEMP% and %windir%.
  21. The antivirus software described in the AntivirusInfos.xml file. Veeam Backup & Replication creates this configuration file on every machine with the Mount Server role and stores the file in the %ProgramFiles%\Common Files\Veeam\Backup and Replication\Mount Service folder.
  22. To retrieve a representation of a VAO scope, send the HTTP GET request to the URL of the /Scopes/{id} resource.

GET https://<hostname>:<port>/v2/Sites/{siteId}/Scopes/{id}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.