The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Xvfb plugin

wrap([$class: 'Xvfb']): Start Xvfb before the build, and shut it down after.

  • additionalOptions (optional)
    Additional options to be added with the options above to the Xvfb command line.
    • Type: String
  • assignedLabels (optional)
    If you want to start Xvfb only on specific nodes specify its name or label. See the Restrict where this project can be run option for label expressions that you can use.
    • Type: String
  • autoDisplayName (optional)
    Uses the -displayfd option of Xvfb by which it chooses it’s own display name by scanning for an available one. This option requires a recent version of xserver, check your installation for support.
    • Type: boolean
  • debug (optional)
    If Xvfb output should appear in console log of this job, useful only if debugging Xvfb interaction.
    • Type: boolean
  • displayName (optional)
    Ordinal of the display Xvfb will be running on, if left empty (default) choosen based on current build executor number. Use only if you know what you’re doing, could leed to clashes with other builds.
    • Type: int
  • displayNameOffset (optional)
    Offset for display names, default is 1. Display names are taken from build executor’s number, i.e. if the build is performed by executor 4, and offset is 100, display name will be 104.
    • Type: int
  • installationName (optional)
    The name of the Xvfb tool installation that Jenkins administrator set up.
    • Type: String
  • parallelBuild (optional)
    When running multiple Jenkins nodes on the same machine this setting influences the display number generation. The display number will be based upon node position in the list of nodes multiplied by 100 to which current executor number and any given offset will be added. Using this with offset set to 0 there is a limit of 595 nodes and 35 executors on a node, having more nodes or executors is not compatible with this option.
    • Type: boolean
  • screen (optional)
    Resolution and color depth of the created virtual frame buffer in the format WxHxD. For example: 1024x758x16
    • Type: String
  • shutdownWithBuild (optional)
    Should the display be kept until the whole job ends (including the post build steps).
    • Type: boolean
  • timeout (optional)
    A timeout of given seconds to wait before returning control to the job, this allows Xvfb to start before there is a need for it. By default set to 0, not to delay the build, since it usualy takes just a few seconds for Xvfb to start, and outputting to display is not the first thing a job does.
    • Type: long

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.