Table Of Contents¶

Introduction
Quick Start Guide
Release Notes
- 3.5.2 Release Notes
- 3.5.1 Release Notes
- 3.5 Release Notes
- 3.4 Release Notes
Installation
- DPBuddy Installation
- Using DPBuddy Docker Image
- Upgrading DPBuddy
- Configuring DataPower to Work with DPBuddy
- Creating DPBuddy Configuration File
- Configuring Apache Ant to Work with DPBuddy
- Verifying Connectivity with DataPower
- Advanced Configuration
- DPBuddy License
- Upgrading from DPBuddy 2.3
Command-Line Interface (CLI)
Using DPBuddy with Apache Ant
Logging
Recommended Development and Build/Deployment Process
- Developing DataPower Artifacts
- Creating a Build in a Test Environment
- Promoting the Build to a “Higher” Environment
- Deploying to a Production Environment
Common Options and Properties
- DataPower Connection Attributes/Options
- Environment Attributes/Options
- Attributes/Options for Running Commands against Multiple Devices
- Schema Validation Attributes/Options
  - Examples
- Save Attribute/Option
- License File Attribute/Option
Managing Environment-Specific Configuration Settings
- env/device Attribute/Option and environment Task
  - Attributes of the environment Task
  - Examples
HOCON/JSON Configuration
- confFile
  - Attributes/Options
  - Examples
- confText
  - Attributes/Options
- confScope
  - Attributes/Options
Environment-Specific Properties
Encrypting Properties/Variables
- encrypt
  - Attributes/Options
  - Examples
- decrypt
  - Attributes/Options
  - Examples
Support for Multiple Devices
- Multi-Domain Execution
- execTarget
  - Examples
Selecting DataPower Objects in DPBuddy Commands
- Examples
Transforming DataPower Configuration
- transform Type
Auditing Changes
- Properties for Configuring XML Audit File
Managing DataPower Configuration
- import
- updateConfig
  - Attributes/Options
  - Examples
- disable/enable
  - Attributes/Options
  - Examples
- modifyConfig
- delConfig
- export
- save
  - Attributes/Options
  - Examples
- saveAll
  - Examples
Managing DataPower Files and Directories
- copy
- delete
  - Attributes/Options
  - Examples
- mkdir
- rmdir
- download
  - Attributes/Options
  - Examples
- downloadFile
  - Attributes/Options
  - Examples
Crypto Management Commands
- deployCrypto
  - Attributes/Options
  - Examples
- listCrypto
  - Attributes/Options
  - Examples
Configuration Checkpoints Commands
- checkpoint
  - Attributes/Options
  - Examples
- rollback
  - Attributes/Options
  - Examples
- delCheckpoint
  - Attributes/Options
  - Examples
Quiesce/Un-quiesce Commands
- quiesce and unquiesce
- quiesceDomain and unquiesceDomain
  - Attributes/Options
  - Examples
Monitoring/Verification Commands
- assertStatus
  - Attributes/Options
  - Examples
- assertFreeSpace
  - Attributes/Options
  - Examples
- assertState
- assertActiveService
- assertOpenPorts
  - Attributes/Options
  - Examples
- testTcp
  - Attributes/Options
  - Examples
Status and Configuration Reporting
- listObjects/objectStatus
  - Attributes/Options
  - Examples
- listServices/serviceStatus
  - Attributes/Options
  - Examples
- listDomains
  - Examples
- configReport
  - Attributes/Options
  - Examples
- status
  - Attributes/Options
  - Examples
Log and Log Target-Related Commands
- tailLog
- syslogTarget
  - Attributes/Options
  - Examples
- soapLogTarget
  - Attributes/Options
  - Examples
- fileLogTarget
  - Attributes/Options
  - Examples
- updateLogLevel/updateLogTargetLevel
  - Attributes/Options
  - Examples
- setLogLevel
  - Attributes/Options
  - Examples
- log
  - Attributes/Options
  - Examples
Cache Flushing Commands
- flushStylesheetCache/flushDocumentCache/flushXMLCache
  - Attributes/Options
  - Examples
- flushAAACache
  - Attributes/Options
  - Examples
- flushMiscCache
  - Attributes/Options
- flushAllCache
Backup and Restore Commands
- backup
- restore
  - Attributes/Options
  - Examples
- secureBackup
  - Attributes/Options
  - Examples
- secureRestore
  - Attributes/Options
  - Examples
Domain Management
- createDomain
  - Attributes/Options
  - Examples
- restartDomain
  - Example
- resetDomain
  - Example
Miscellaneous Commands
- action
  - Attributes/Options
  - Examples
- exec
  - Attributes/Options
  - Examples
- exportConf
  - Options
  - Examples
- firmware
  - Attributes/Options
  - Examples
- license
  - Examples
- passwordAlias
  - Attributes/Options
  - Examples
- ping
  - Attributes/Options
  - Examples
- restartDP
  - Attributes/Options
  - Examples
- somaRequest
  - Attributes/Options
  - Examples
- testConnection/connect
  - Examples
- wsrrSynchronize
  - Attributes/Options
  - Examples
Integration with Logstash and Elasticsearch
- DPBuddy’s Logstash Plugins Installation
- Elasticsearch/Kibana Setup
- Logstash DataPower Log Plugin
  - Plugin Configuration Options
- Logstash DataPower File Download Plugin
  - Plugin Configuration Options
- Saving DPBuddy Audit Log in Elasticsearch
Glossary