> User Documentation Home

User Handbook
Tutorials
Resources

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.

Anka Plugin

View this plugin on the Plugins site

ankaGetSaveImageResult: Wait for previous save image requests results

  • shouldFail
    • Type: boolean
  • timeoutMinutes
    • Type: int

createDynamicAnkaNode: create dynamic anka node

  • masterVmId (optional)
    • Type: String
  • SSHPort (optional)
    • Type: int
  • credentialsId (optional)
    • Type: String
  • deleteLatest (optional)
    • Type: boolean
  • description (optional)
    • Type: String
  • dontAppendTimestamp (optional)
    • Type: boolean
  • environments (optional)
      Array / List of Nested Object
    • name
      • Type: String
    • value
      • Type: String
  • extraArgs (optional)
    • Type: String
  • group (optional)
    • Type: String
  • javaArgs (optional)
    • Type: String
  • jnlpJenkinsOverrideUrl (optional)
    • Type: String
  • jnlpTunnel (optional)
    • Type: String
  • keepAliveOnError (optional)
    • Type: boolean
  • labelString (optional)
    • Type: String
  • launchDelay (optional)
    • Type: int
  • launchMethod (optional)
    • Type: String
  • mode (optional)
    • Values: NORMAL, EXCLUSIVE
  • nameTemplate (optional)
    • Type: String
  • numberOfExecutors (optional)
    • Type: int
  • priority (optional)
    • Type: int
  • pushTag (optional)
    • Type: String
  • remoteFS (optional)
    • Type: String
  • retentionStrategy (optional)
      Nested Choice of Objects
    • agent-maintenance
      Take this agent offline during dedicated maintenance windows, e.g. due to maintenance activities. Outside of an active maintenance window, the "Default Availality" is applied.
      Exact behaviour what to do with running builds can be individually defined for each maintenanance window.
      • regularRetentionStrategy
        • Type: hudson.slaves.RetentionStrategy<hudson.slaves.SlaveComputer>
    • $class: 'AlmostAlways'
      • always
        • $class: 'AzureVMCloudOnceRetentionStrategy'
          • $class: 'AzureVMCloudPoolRetentionStrategy'
            • retentionInHours
              Retention time define the time of hour before automatically deleting since the agent created. Specify 0 means agents won't be deleted automatically.
              • Type: int
            • poolSize
              Pool size define the number of agent you want to maintain.
              • Type: int
          • azureVMCloudRetentionStrategy
            • idleTerminationMinutes
              • Type: int
          • $class: 'ContainerIdleRetentionStrategy'
            • idleMinutes
              • Type: int
          • $class: 'ContainerOnceRetentionStrategy'
            • demand
              • inDemandDelay
                • Type: long
              • idleDelay
                • Type: long
            • $class: 'DockerCloudRetentionStrategy'
              • idleMinutes
                Number of minutes of idleness after which to kill the slave; serves a backup in case the strategy fails to detect the end of a task
                • Type: int
            • $class: 'DockerSwarmAgentRetentionStrategy'
              • timeout
                • Type: int
            • $class: 'IdleTimeCloudRetentionStrategy'
              • idleMinutes
                • Type: int
            • schedule
              • startTimeSpec
                • Type: String
              • upTimeMins
                • Type: int
              • keepUpWhenActive
                • Type: boolean
            • $class: 'VSphereCloudRetentionStrategy'
              • idleMinutes
                • Type: int
            • $class: 'com.github.kostyasha.yad.strategy.DockerOnceRetentionStrategy'
              • idleMinutes
                Number of minutes of idleness after which to kill the slave; serves a backup in case the strategy fails to detect the end of a task
                • Type: int
            • $class: 'com.nirima.jenkins.plugins.docker.strategy.DockerOnceRetentionStrategy'
              • idleMinutes
                Number of minutes of idleness after which to kill the agent; serves a backup in case the strategy fails to detect the end of a task
                • Type: int
            • $class: 'com.veertu.plugin.anka.RunOnceCloudRetentionStrategy'
              • idleMinutes
                • Type: int
            • $class: 'io.jenkins.plugins.orka.RunOnceCloudRetentionStrategy'
              • idleMinutes
                • Type: int
            • $class: 'org.jenkinsci.plugins.vsphere.RunOnceCloudRetentionStrategy'
              • idleMinutes
                • Type: int
          • saveImage (optional)
            • Type: boolean
          • suspend (optional)
            • Type: boolean
          • tag (optional)
            • Type: String
          • templateDescription (optional)
            • Type: String
          • templateId (optional)
            • Type: String
          • timeout (optional)
            • Type: int

          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.