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.

SWEAGLE Plugin

SWEAGLEExport: SWEAGLE Get Config

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • mdsName
    Exact name of pending config data set for which the data should be exported
    • Type: String
  • args (optional)
    Use comma separated values for exporter variables
    • Type: String
  • exporter (optional)
    The SWEAGLE exporter to use when retrieving the config data.
    • Type: String
  • fileLocation (optional)
    Location of file within the Jenkins workspace to save the exported data.
    • Type: String
  • format (optional)
    Select the supported format of the file to be uploaded.
    • Type: String
  • mapToVariables (optional)
    Sets a Jenkins Environment variable to value of a configuration data item. One variable on each line. format is colon seperated key value pair VARIABLE:Path.to.node.cdi Example: INTERNAL_IP:PRD.infra.db023.ipInternal
    • Type: String
  • markFailed (optional)
    Mark the build as "Failed" should the data export fail.
    • Type: boolean
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log.
    • Type: boolean
  • tag (optional)
    • Type: String

SWEAGLESnapshot: SWEAGLE Snapshot

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • mdsName
    Exact name of pending config data set for which the snapshot should be taken.
    • Type: String
  • description (optional)
    A description for the snapshot
    • Type: String
  • markFailed (optional)
    Mark the build as "Failed" should the snapshot fail.
    • Type: boolean
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log. Warning !!! The API results of a snapshot will include the entire Config Data set.
    • Type: boolean
  • tag (optional)
    A single string as TAG for that snapshot - cannot contain spaces but can utilize Jenkins variable4s ex "release1.2.${BUILD_ID}"
    • Type: String

SWEAGLEUpload: SWEAGLE Upload

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • fileLocation
    Fullpath of file relatove to the Jenkins workspace using Ant file filter format for selecting multiple files with wildcard. Details here. Examples: myconfig.json *.json subdirectory/*.json
    • Type: String
  • format
    Select the supported format of the file to be uploaded.
    • Type: String
  • nodePath
    Enter the path where the data should be uploaded. Separate the nodenames in the path with a comma. In case the nodes do not yet exist, they will be created automatically.
    • Type: String
  • allowDelete (optional)

    Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. If the nodes are included or inherited the nodes and MDIs at points of inclusion will also be deleted unless "Only Parent" is also checked.

    • Type: boolean
  • autoRecognize (optional)
    • Type: boolean
  • description (optional)
    A description for the snapshot
    • Type: String
  • filenameNodes (optional)

    Create Filename Nodes If checked, nodes will be created for all matching files names in the file location and file data will be placed under file name node.

    • Type: boolean
  • identifierWords (optional)

    Identifier Words To make nodes part of an array uniquely identifiable, a comma separated list of 'identifier words' can be added. If no identifierWords are provided, the behavior will default to the identifierWords listed in the find.identity_attributes_discovery.word_list preference

    • Type: String
  • markFailed (optional)
    Mark the build as "Failed" should the data upload fail for any reason.
    • Type: boolean
  • onlyParent (optional)

    Only Parent This controls if in case the allowDelete flag is set to true if the deletion of nodes and CDIs will only happen at the node itself, or also at any other place where the node is included or in every child node that is inheriting.

    • Type: boolean
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log.
    • Type: boolean
  • subDirectories (optional)

    Search Sub-directories If checked sub-directories will also be searched recursively for matching files.

    • Type: boolean
  • tag (optional)
    A single string as TAG for that snapshot - cannot contain spaces but can utilize Jenkins variable4s ex "release1.2.${BUILD_ID}"
    • Type: String
  • withSnapshot (optional)

    Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted

    Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted

    Store Snapshot. This controls if automatically a snapshot should be created for each of the impacted config data sets by this data upload.

    • Type: boolean

SWEAGLEValidate: SWEAGLE Validate

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • mdsName
    The exact name of the config data set which should be validated.
    • Type: String
  • errMax (optional)
    Fail build on validate errors. Set thresholds used to determine if the build should be failed based on the number of validation errors or warnings.  Use -1 to ignore either threshold.
    • Type: int
  • markFailed (optional)
    Fail build on validate errors or if the pending data set fails to show up after all the retry attempts have completed.
    • Type: boolean
  • noPending (optional)
    Fail build if no data is found for the Config Data Set (CDS).
    • Type: boolean
  • retryCount (optional)
    Number of retry attempts while waiting for a pending config data set. Combined with with Retry Interval to force a timeout after attempts have completed. Use "-1" for unlimited retries.
    • Type: int
  • retryInterval (optional)
    Number of seconds between each attempt to find a matching config data set for validation. Combine with with Retry Count to force a timeout after attempts have completed.
    • Type: int
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log.
    • Type: boolean
  • stored (optional)
    Validate the stored snapshot for the config data set instead of the pending data.
    • Type: boolean
  • warnMax (optional)
    Fail build on validate errors. Set thresholds used to determine if the build should be failed based on the number of validation errors or warnings.  Use -1 to ignore either threshold.
    • 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.