Complete Installation and Upgrade Information for Software AG Products
About this Documentation
Document Conventions
Online Information and Support
Data Protection
Software AG Preparation and Planning Guide
Upgrade Testing Guidelines
webMethods Release Notes
webMethods Readme Files
System Requirements for Software AG Products
Supported Upgrade Paths
Supported Version Interoperability
Installing Software AG Products On Premises
About this Guide
Using Command Central or Software AG Installer to Install Products
Using Command Central to Install Products
Using Software AG Installer to Install Products
Hardware Requirements and Operating System, Browser, and RDBMS Support
Hardware Requirements
Minimum and Recommended Hardware Requirements
Additional Hardware Requirements
Operating System Support
Browser Support
RDBMS Support
Preparing for Product Installation
Shut Down Products
Prepare for Installation For All Products (Windows System)
Prepare for Apama Installation (Linux System)
Prepare for API Gateway and Developer Portal (Linux System)
Prepare for API Portal Installation (UNIX System)
Prepare for ApplinX Installation
Prepare for CentraSite Installation (UNIX System)
Prepare for EntireX Installation
Prepare for MashZone NextGen Installation (Linux System)
Prepare for Mobile Designer Installation
Prepare for My webMethods Server Installation (UNIX System)
Prepare for webMethods OneData Installation (Windows System)
Prepare for Optimize Analytic Engine Installation (UNIX System)
Prepare for Tamino Installation
Prepare for Zementis Predictive Analytics Installation
Prepare Database Connection Information
Preparing for Database Component Creation
Database Component Descriptions and Installation Requirements
ActiveTransfer Server Database Components
API Gateway Database Component
CloudStreams Database Component
Integration Server or Microservices Runtime Database Components
External RDBMS versus Embedded Database
Using the Embedded Database
Using the External RDBMS
Archiving the ISCoreAudit Database Component
Mobile Support Database Component
My webMethods Server Database Components
webMethods OneData Database Components
Optimize Database Components
Process Engine Database Components
Archiving the ProcessAudit Database Component
Rules Engine Database Component
Trading Networks Server Database Components
Database Drivers for DB2, MySQL Enterprise Edition, Oracle, PostgreSQL, and SQL Server
Prepare for Database Component Creation in MySQL
Install the MySQL Community Edition Database Driver for Integration Server, Microservices Runtime, and Hosted Products
Install the MySQL Community Edition Database Driver and Edit the MySQL Configuration File for All Other Products
Prepare for Database Component Creation for All RDBMSs
Database Administrator Account
Character Set and Sort Order
DB2
MySQL Community Edition and Enterprise Edition
Oracle
PostgreSQL
SQL Server
Page and Block Size
Set Database Options
MySQL
Oracle
SQL Server
Installing Products, Creating Database Components, and Connecting Products to Database Components
Installing Products and Creating Database Components Using Command Central
Installing Products Using Software AG Installer and Creating Database Components Using Database Component Configurator
Installing Products Using Software AG Installer
Recommendations
Before Installing Using Software AG Installer
Gather Information
Save and Verify Product License Files
Read and Perform Required Actions in Using Software AG Installer
API Gateway and Developer Portal Requirements
CentraSite Requirements
Deployer and Asset Build Environment Requirements
Install Products Using Software AG Installer
Start the Installer and Provide General Information
Choose Products to Install
Choose Default Password for Products
Choose Language Packs to Install
Install Latest Updates
Supply Product Configuration Information
Apama
API Portal
EntireX
Integration Server or Microservices Runtime
webMethods OneData
Universal Messaging
After Installing Using Software AG Installer
Manage Products Using Command Central
Install Latest Updates if Not Available During Installation
Start, Configure, and Customize Products
Register Daemons and Set File Permissions (UNIX System)
Uninstall Products Using Software AG Installer
Uninstall EntireX
Uninstall All Other Products
Create Database Users and Storage for PostgreSQL
Create Database Users and Storage in Non-DBO Schemas for SQL Server
Create Database Components Using Database Component Configurator
Install the Database Component Configurator and Database Scripts
Database Component Configurator Graphical User Interface
Start the Database Component Configurator GUI
Create Database Components, Database User, and Storage
Choose the Action to Perform
Create Database Components, Database User, and Storage
Specify the Connection to the RDBMS
Drop Database Components
Drop the Storage and Revoke Database User Permissions
Database Component Configurator Command
Main Parameters
Additional Parameters
Examples
Create the Database User and Storage
Drop the Storage and Revoke Database User Permissions
Create Database Components
Drop Database Components
Pass Parameters to Database Component Configurator Using a Shell Script or Bat File
Connecting Products to Database Components
Registering Daemons to Automatically Start and Shut Down Products on UNIX Systems
Overview
Run the daemon.sh Command Line Tool
Configure Integration Server Shutdown Timeouts in systemd and Tanuki Service Wrapper (RHEL 7+, SLES12+, systemd)
Daemon Registration Examples for SLES 12+ and RHEL 7+ (systemd)
Product Daemons and rc-scripts
Troubleshooting
Operating in International Operating Environments
Overview
Language Packs
Language Packs for Software AG Designer
Extended Character Set
Configure Browsers and JRE Font
Configure the Proper Locale
Using the Software AG Installer
About this Guide
Concepts
Software AG Installer and Uninstaller
Installation Methods
Install Products from Empower
Install Products Using an Installation Image
Install Products Using an Installation Script
Install Products or Create Images Faster
Generate Images for Multiple Operating Systems from an Image Generation Script
Uninstallation Methods
Installation and Uninstallation Modes
JDK Support
Ports
Logging
EU General Data Protection Regulation (GDPR)
Critical Requirements and Recommendations for Successful Installation and Uninstallation
Machine Requirements
Access Requirements
Installer/Uninstaller and Installation/Uninstallation Requirements
Troubleshooting Downloads
Using GUI Mode
Start the Installer on a Windows System
Start the Installer on a Mac OS X, UNIX, or Linux System
View the Welcome Panel
Use a Proxy Server
Provide Credentials
Read the License Agreement
Choose Release
Specify the Installation Directory
Select Products to Install
Select Language Packs to Install
Select Product Updates to Install
Configure Products
Review and Install
Use Installation Images
Create an Image for One Operating System
Install from an Image
Use Existing Images to Install Products or Create Images Faster
Use Installation Scripts
Create a Script
Edit an Existing Script
Install from a Script Using the GUI
Install from a Script Using the Command Line on Windows Systems
Generate Images for Multiple Operating Systems from an Image Generation Script
Create the Image Generation Script
Generate Images
Change Logging Options
Using Console Mode to Install
Start the Installer on a Mac OS X, UNIX, or Linux System
Use a Proxy Server
Provide Credentials
Choose Release
Specify the Installation Directory
Select Products to Install
Select Language Packs to Install
Select Product Updates to Install
Read the License Agreement
Configure Products
Use Installation Images
Create an Image
Display the Contents of an Image
Validate the Contents of an Image
Install from an Image
Use Existing Images to Install Products or Create Images Faster
Use Installation Scripts
Create a Script
Edit an Existing Script
Install from a Script on Mac OS X System, Other UNIX System, or Windows System
Generate Images for Multiple Operating Systems from an Image Generation Script
Create an Image Generation Script
Generate Images
Change Logging Options
Listing the Available Artifacts
Creating Container Images with Software AG Installer on Linux systems
Examples
Uninstalling
Before You Begin
Start the Uninstaller
Uninstall Selected Products from Local or Remote Machine
Uninstall All Products from Local or Remote Machine with No User Input in GUI Mode
Uninstall All Products from Local or Remote Machine with No User Input (Silently) in Console Mode
Uninstall Using a Script in GUI Mode
Uninstall Using a Script in Console Mode
Create a Script
Edit an Existing Script
Uninstall Using a Script
Windows Usage Notes
Software AG Update Manager Help
About Software AG Update Manager
Document Conventions
Online Information and Support
Data Protection
Understanding Update Manager
What is Update Manager?
Logging
Installing Update Manager
Requirements
Installing from Empower (Windows)
Installing from an Image (Windows)
Installing from Empower (*nix)
Installing from an Image (*nix)
Arguments for the Bootstrap Installer (*nix)
Creating an Installation Image for Update Manager
Creating an Installation Script for Update Manager
Installing Update Manager from a Script
Troubleshooting Installation Issues
Uninstalling Update Manager
Using Update Manager
Best Practices for Using Update Manager
Configuring Update Manager
Starting Update Manager on Windows
Starting Update Manager on *nix
Supported Parameters for Starting Update Manager
Supported Arguments for the Start-up Scripts
Troubleshooting Start-up Operations
Troubleshooting Graphic User Interface Issues on *nix Systems
Troubleshooting Connectivity Issues
Checking the Launcher Version
Using Software AG Command Central to Call Update Manager
Connection Issues when Using NTLM Proxy Server on a *nix Machine
Managing Fix Updates
Before Installing Fixes
Installing Fixes from Empower
Connecting to Empower
Installing Fixes from an Image
Installing Fixes from a Script
Reverting the State of Product Fixes on an Installation
Deleting Fix Backups
Uninstalling Fixes
Checking for Fix Updates for a Product Installation
About Fix Updates
Checking for Fixes Available on Empower
Checking for Installed Fixes
Creating a Fix Image
About Fix Images
Creating a Fix Image
Creating a Script
Creating a Script
Creating an Inventory
Creating an Inventory
Upgrading Software AG Products On Premises
About this Guide
Prepare for Upgrade
Upgrades Covered in This Guide
Preparing, Planning, and Testing
Using Software AG Installer, Software AG Update Manager, Database Component Configurator, and Migration Utilities to Upgrade
Using Command Central to Upgrade
Documentation Needed to Perform the Upgrade
Troubleshooting
Support for Upgrade Across Operating Systems
General Upgrade Procedure Requirements
Upgrades and Migrations Covered in Other Guides
Upgrade Software AG Infrastructure
Install the New Product
Prepare the Old Installation
Migrate Software AG Infrastructure
Configurations, Data, and Assets that Will be Migrated
Run the Software AG Infrastructure Migration Utility
Complete the Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade webMethods Metering
Install the New Products
Prepare the Old Installations
Migrate Metering Agent
Configurations that Will be Migrated
Run the Metering Agent Migration Utility
Migrate the Metering Server
Folders and Locations that Will be Migrated
Run the Metering Server Migration Utility
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade BigMemory Max or Terracotta
Install the New Product
Prepare the Old Installation
Migrate BigMemory Max
Migrate Terracotta
Migrate Terracotta Management Console Configuration and Data
Migrate Ehcache 3.x Data
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Universal Messaging
Cluster Upgrade Guidelines
Install the New Product
Prepare the Old Installation
Migrate Universal Messaging
Configurations, Data, and Assets that Will be Migrated
Run the Migration Utility
Perform a Custom Migration
Migrate Using Imported Settings
Migrate Using Custom Imported Settings with Prompting
Migrate Using Custom Imported Settings without Prompting (Silent)
Migrate Using Default Imported Settings without Prompting (Silent)
Complete the Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade My webMethods Server
Cluster Upgrade Guidelines
Install the New Product
Prepare the Old Installation
Migrate Database Components
Migrate My webMethods Server
Instances, Configurations, Data, and Assets that Can be Migrated
Run the Migration Utility
Perform a Custom Migration
Migrate Using Imported Settings
Migrate Using Custom Imported Settings with Prompting
Migrate Using Default Imported Settings without Prompting (Silent)
Migrate Using Custom Imported Settings without Prompting (Silent)
Complete the My webMethods Server Upgrade
Check Java Service Wrapper #include Directives
Initialize a My webMethods Server Instance
Switch from Clone Migrated Database to Live Migrated Database
Complete the Business Rules Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Integration Server or Microservices Runtime and Hosted Wm Packages
Cluster Upgrade Guidelines
Install the New Products
Prepare the Old Installation
Migrate Database Components
Migrate Integration Server or Microservices Runtime and Hosted Wm Packages
Configurations, Data, and Assets that Can or Will be Migrated
Run the Migration Utility
Perform a Custom Migration
Migrate Using Imported Settings
Migrate Using Custom or Default Imported Settings with Prompting
Migrate Using Custom or Default Imported Settings without Prompting (Silent)
Complete the Integration Server Upgrade
Check Java Service Wrapper #include Directives
Complete the Integration Server or Microservices Runtime Upgrade
Customize Startup Files
Update WSDLs
Upgrade from 10.1: Save and Synchronize an Updated Publishable Document Type
Connect Integration Server or Microservices Runtime and Hosted Products to Database Components
Complete the Adapters or eStandards Modules Upgrade
Complete the ActiveTransfer Upgrade
Complete the CloudStreams Upgrade
Configure TLS 1.1 and 1.2 Trust Store
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Software AG Designer and Business Process Data
Install the New Software AG Designer
Prepare the Old Software AG Designer
Migrate Database Components
Migrate Software AG Designer
Before Migrating
Migrate Apama, Application Platform (Deprecated), Business Process, and Business Rule Projects
Migrate Task Application Projects
Redo Attachment List Control Customizations in CAF Applications
Migrate CloudStreams Server Definitions and Projects
Migrate Integration Server or Microservices Runtime Definitions
Migrate Mobile Projects
Complete the Business Process Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Infrastructure Data Collector
Install the New Product
Prepare the Old Installation
Migrate Infrastructure Data Collector
Configurations, Data, and Assets that Can be Migrated
Run the Migration Utility
Perform a Custom Migration
Migrate Using Imported Settings
Migrate Using Custom or Default Imported Settings with Prompting
Migrate Using Custom or Default Imported Settings without Prompting
Complete the Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Optimize
Install the New Product
Prepare the Old Installation
Migrate Database Components
Configure and Start the Terracotta Server Array
Update Connections to Other Products
Upgrade from 9.12 or Later: Migrate Optimize
Configurations, Data, and Assets that Can be Migrated
Run the Migration Utility
Complete the Upgrade
Not Reuse the Old Central Configurator System (CCS) Environment Definition
Reuse the Old CCS Environment Definition
Deploy the New Environment
Switch from webMethods Broker to Universal Messaging
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade the Asset Build Environment, Deployer, or Application Platform (Deprecated)
Install the New Product
Upgrade the Asset Build Environment
Upgrade Deployer
Prepare the Old Installation
Migrate Deployer
Configurations, Data, and Assets that Will be Migrated
Run the Migration Utility
Upgrade Application Platform (Deprecated)
Prepare the Old Installation
Migrate Application Platform (Deprecated)
Configurations, Data, and Assets that Will be Migrated
Run the Migration Utility
Complete the Upgrade
Verify and Correct Package Imports
Update the Tomcat Configuration
Upgrade from 9.9, 9.10, or 9.12: Complete the WmTomcat Web Applications Migration
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Apama
Install the New Product
Prepare the Old Installation
Migrate Apama
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade API Gateway, API Portal, or CentraSite
API Gateway Cluster Upgrade Guidelines
Install the New Products
Upgrade API Gateway
Prepare the Old Installation
Migrate Database Components
Migrate API Gateway
Configurations, Data, and Assets that Will be Migrated
Perform the Migration
Upgrade API Portal
Upgrade from 9.9 through 10.5: Prepare the Old Installation
Migrate API Portal
Assets that Can be Migrated
Perform the Migration
Complete the Upgrade
Migrate API Portal 10.7 to Developer Portal 10.11
Prepare the Old Installation
Migrate API Portal to Developer Portal
Assets that Can be Migrated
Limitations
Perform the Migration
Complete the Migration
Upgrade CentraSite
Prepare the Old Installation
Migrate CentraSite
Configurations that Will be Migrated
Run the Migration Command
Complete the Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade MashZone NextGen
Install the New Product
Upgrade from 10.1 or 10.3: Migrate MashZone NextGen
Prepare the Old Installation
Migrate MashZone NextGen
Configurations, Data, and Assets that Will be Migrated
Run the Migration Utility
Complete the Upgrade
Upgrade from 9.10 or 9.12: Migrate MashZone NextGen
Prepare the Old Installation
Set Up the MashZone NextGen Repository
Set Up the Repository When Using the Embedded Derby Database
Set Up the Repository When Using Any Other Database
Upgrade from 9.10: Add Data from the Old Repository to the New Repository
Update the MashZone NextGen Configuration and Copy Extensions
Update When an External Configuration Directory Was Used
Update When No External Configuration Directory Was Used
Upgrade from 9.10: Migrate Feeds and Run Upgrade Commands
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade from 9.9: Upgrade Mobile Designer
Install the New Product
Prepare the Old Installation
Migrate Mobile Designer
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade webMethods OneData
Gather Information for Installation
Install the New Product
Prepare the Old Installation
Migrate Database Components
Migrate webMethods OneData
Configurations, Data, and Assets that Will be Migrated
Run the Migration Utility
Complete the Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Zementis Predictive Analytics
Install the New Product
Prepare the Old Installation
Migrate Zementis Predictive Analytics
Assets that Will be Migrated
Run the Migration Command
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Upgrade Digital Event Services
Install the New Product
Prepare the Old Installation
Migrate Digital Event Services
Configurations, Data, and Assets that Will be Migrated
Run the Migration Utility
Complete the Upgrade
Configure Products, Update Host Names, Adjust Assets for Release Changes, Re-enable Auto-Startup
Migrate Database Components
Requirements and Cautions
Prepare Database Components for Migration
Migrate Database Components Using Database Component Configurator
Upgrade Using Command Central
Supported Upgrade Scenarios
Same Installation Directory, Hosts, and Ports; Live Database
New Installation Directory, Same Hosts and Ports, Cloned Database
New Installation Directory and Ports, Same Hosts, Cloned Database
New Hosts, Live or Cloned Database
Upgrade Approaches
Upgrade Products in a Single Environment
Upgrade Products Using Software Stacks (10.1 and Later)
Command Central
Software AG Command Central Supported Features Matrix
Software AG Command Central Help
Document Conventions
Online Information and Support
Data Protection
Getting Started with Command Central
What is Software AG Command Central?
Install Command Central
Override Bootstrapper Command Default Values
Start or Stop Command Central
Configure HTTP/S Proxy
Create Credentials Aliases
Connect to Software AG Repositories
Create, Refresh, or Change Sources for a Mirror Repository of Products or Fixes
Import Product License Keys for Instances or Components
Register Bootstrap Installers in Command Central
Additional Configuration for Command Central in a Production Environment
Change or Reset the Command Central Administrator Password
Change or Reset the Platform Manager Administrator Password
Secure the Connection Between Command Central and Platform Managers
Control User Access to Command Central
Configure Command Central to Use JAAS for Advanced Authentication
Set Timeouts and Thread Pool Size for Command Central
Configure the Command Central and Platform Manager JVMs
Upgrade Command Central
Creating, Managing, or Upgrading Standalone Product Installations
Understanding Standalone Product Installations
Understanding Product and Fix Repositories
Understanding Asset Repositories
Default and Custom Product Administrator User Passwords
Connect an Existing Product Installation to Command Central and Add It to Environments
Create a New Standalone Installation
Create Asset Repositories
Before Installing Products
Before Installing Fixes and Support Patches
Before Creating Database Components
Install and Configure Platform Manager for a New Standalone Installation
About Installing Platform Manager
Install Platform Manager Using the Command Central Bootstrapper
Install Platform Manager Using the Command Central Web User Interface
Supported Key Exchange Methods for SSH Connections
Configure Platform Manager
Create a New Standalone Product Installation and Add It to Environments
Create and Update Product Instances
Change the Status of an Instance or Component
Install Fixes
Install Support Patches
Compare Products, Fixes, and Instances
View KPIs and Alerts for an Instance or Component
Add an Environment to a Landscape
Configure Shared Secrets to Encrypt Instance and Component Passwords
Encrypt User Passwords for Product Configurations
Group Product Instances or Components
Monitor the Licensing State for a Landscape
Upgrade a Standalone Product Installation
Understanding License Metering (DEPRECATED)
Deprecation Impacts
License Manifests (Deprecated)
Current State of Licensing for a Landscape (Deprecated)
Creating or Upgrading Software Stacks
Understanding Software Stacks
Understanding Product and Fix Repositories
Create a Software Stack
Before Installing Products
Before Installing Fixes and Support Patches
Before Creating Database Components
Create a Software Stack
Create Software Stacks from Existing Environments
Rename a Software Stack or Layer
Upgrade Software Stacks
Common Use Cases with Command Central
How to Get Templates for Upgrade
Install or Upgrade Product Installations with Composite Templates
Install or Upgrade Product Installations with Stacks
Update Licenses on a Number of Nodes with Templates
Command Central GitHub Projects
Automate Command Central Installation, Configuration, and Upgrade
Command Central Docker Builder
Default Templates on GitHub
Using Composite Templates
About Automated Provisioning of Environments
What is a Composite Template?
Understanding the Composite Template Definition
Options
Environments
Layers
Templates
Migration
Provision
Maintenance
Nodes
Repositories
Actions
Creating a Custom Composite Template
How Command Central Processes a Composite Template for Installations of Release 10.3 or Higher
environment.mode=provision|migration
environment.mode=maintenance
How Command Central Processes a Composite Template for Installations of Release 10.1 or Lower
Importing a Template into Command Central
Creating a New Environment Using a Composite Template
Updating Command Central to the Latest Fix
Updating a Provisioned Environment Using the Same Composite Template
Migrating to a Different Host with Cloned Database
Migrating Using Disconnected Migration
Migrating a Product Instance
Changing an Instance Name During Migration
Migrating Platform Manager Using a Template
Monitoring the Status of a Composite Template
Validating a Composite Template
Correcting a Failed Composite Template Apply Operation
Composite Templates for 9.x Installations
Database Actions in the 9.x Template Samples
Using the is-layer Sample Template
Before Using the is-layer Sample Template
Configuring the is-layer Template
Understanding the is-layer Template Definition
Applying the is-layer Sample Template
Using Micro Templates
What is a Micro Template?
When to Use Micro Templates and When a Composite Template?
Connecting to the Default Templates Repository
Designing Micro Templates
Using the Sample Micro Templates
Creating a User-Defined Micro Template
Exporting the Platform Manager of an Installation to a Template
Exporting an Installed Product Instance to a Micro Template
Adding Configurations in an Exported Micro Template
Exporting the Database for Products in an Installation to a Template
Validating a Micro Template
Bootstrapping Platform Manager on a Remote Machine Using a Template
Bootstrapping Platform Manager Using the Default SSH and WinRM Templates
Bootstrapping on a Remote Machine with a Substitute User
Securing Passwords in Templates
Encrypting Passwords in Templates
Managing Database Components Using a Template
Managing Database Components Using a Template
Supported Database Component Configurator Parameters
Deploying Command Central Assets to Integration Cloud
About Deploying Command Central Assets to webMethods Cloud Container (Deprecated)
Defining Environment Variables for Platform Manager Assets
How Platform Manager Deploys Assets with Dependencies
Command Central Composite Assets
About Command Central Composite Assets
Adding Assets to the Build Source Directory
Setting Build Properties for Command Central Assets
Building Command Central Composite Assets
Template Definition Reference
Tips for Writing in YAML
Reference Template DSL Definition
Infrastructure Micro Template Reference
Run-Time Micro Template Reference
Format of COMMON-* Configuration Types in the Template Definition
Using the Command Line Interface
Installing CLI as a Remote Client
Displaying Help for the Command Line Interface
Displaying the Version of the Command Line Interface
Executing Command Central Commands
Executing Platform Manager Commands
Getting Familiar with Using Commands
Return Codes from Command Execution
Invoking Commands from Scripts
Creating Shell Scripts that Execute Commands
Creating Ant Scripts that Execute Commands
Parameters to Use with the ccsetup Task
Parameters to Use with the cc Task
Using a Unix Shell Script to Change the Administrator Password for Command Central
Managing Database Components Using CLI Commands
Installing Database Scripts for Software AG Products
Supported Database Component Configurator Actions
Create Database Components
Drop Database Components
Migrate Database Components
Recreate Database Components
Execute a Database Action with Catalog
Searching for Database Component Configurator Details
Options for the Commands
Common Options
accept
check-every
configuration-file
debug
error
expected-values
force
format
input
input-format
log
media-type
output
output-format
Recommendations When Selecting a Content Type
password
properties
quiet
retry
server
ssl-truststore-file
ssl-trust-all-hosts
ssl-truststore-password
sync-job
username
wait
wait-for-cc
Administration Commands
About Administration Commands
sagcc exec administration
sagcc list administration
License Inventory Commands
sagcc add inventory components contracts assignment
sagcc update inventory components contracts assignment
sagcc delete inventory components contracts assignment
sagcc get inventory components contracts assignment
Configuration Commands
Return Statuses from Executing Configuration Commands
Adding Configurations Exported from an Installed Product Instance to an Input File
sagcc get configuration common
sagcc get configuration compare
sagcc create configuration data
sagcc delete configuration data
sagcc get configuration data
sagcc update configuration data
sagcc get configuration instances
sagcc list configuration instances
sagcc get configuration types
sagcc list configuration types
sagcc exec configuration validation create
sagcc exec configuration validation delete
sagcc exec configuration validation update
Diagnostics Logs Commands
sagcc get diagnostics logs
sagcc get diagnostic logs export file
sagcc list diagnostics logs
Instance Management Commands
sagcc create instances
sagcc delete instances
sagcc get instances
sagcc list instances supported products
sagcc update instances
Inventory Commands
sagcc list inventory assets
sagcc create inventory components attributes
sagcc get inventory components
sagcc get inventory components attributes
sagcc list inventory components
sagcc list inventory components attributes
sagcc update inventory components
sagcc update inventory components attributes
sagcc delete inventory components attributes
sagcc get inventory fixes
sagcc get inventory fixes compare
sagcc list inventory fixes
sagcc get inventory products
sagcc get inventory products compare
sagcc list inventory products
Specifying Search Criteria for Inventory Commands
Jobmanager Jobs Commands
sagcc delete jobmanager jobs
sagcc delete jobmanager landscapejobs
sagcc list jobmanager jobs
sagcc list jobmanager landscapejobs
Landscape Commands
sagcc add landscape environments nodes
sagcc create landscape environments
sagcc delete landscape environments
sagcc get landscape environments
sagcc list landscape environments
sagcc remove landscape environments nodes
sagcc update landscape environments
sagcc create landscape nodes
sagcc delete landscape nodes
sagcc exec landscape nodes generateNodeId
sagcc get landscape nodes
sagcc list landscape nodes
sagcc update landscape nodes
License Key Commands
sagcc add license-tools keys
sagcc get license-tools keys
sagcc list license-tools keys
sagcc update license-tools keys
sagcc delete license-tools keys
sagcc update configuration license
License Reports Commands
sagcc create license-tools reports installation
sagcc delete license-tools reports installation reportid
sagcc delete license-tools reports installation
sagcc get license-tools reports installation output PDF
sagcc get license-tools reports installation output XML
sagcc list license-tools reports installation
sagcc list license-tools reports installation-report
sagcc create license-tools reports installation-report
sagcc get license-tools reports installation-report reportid
sagcc delete license-tools reports installation-report
sagcc list license-tools reports
sagcc list license-tools metering products
sagcc add license-tools manifests
sagcc delete license-tools manifests
sagcc get license-tools manifests output xml
sagcc list license-tools manifests
sagcc list license-tools manifests content
sagcc get license-tools metering contracts licensekey
sagcc list license-tools manifests contracts
Lifecycle Commands
sagcc exec lifecycle
Specifying Search Criteria for Lifecycle Commands
Monitoring Commands
sagcc get monitoring
sagcc get monitoring state
sagcc list monitoring alerts
Provisioning Bootstrap Installers Commands
sagcc list provisioning bootstrap installers
sagcc exec provisioning bootstrap nodes
Provisioning Fixes Commands
sagcc exec provisioning fixes install
sagcc exec provisioning fixes uninstall
sagcc list provisioning fixes uninstall dependencies
Provisioning Products Commands
sagcc exec provisioning products install
sagcc exec provisioning products uninstall
sagcc list provisioning products uninstall dependencies
Provisioning Assets Commands
sagcc exec provisioning assets install
sagcc exec provisioning assets uninstall
Repository Commands
About Repository Commands
Using HTTPS to Connect to Repositories
sagcc add repository assets flatfile
sagcc add repository assets git
sagcc delete repository assets
sagcc list repository assets
sagcc list repository assets content
sagcc list repository assets dependencies
sagcc list repository assets namespaces
sagcc update repository assets flatfile
sagcc update repository assets git
sagcc add repository fixes
sagcc add repository products
sagcc delete repository
sagcc delete repositories
sagcc exec repository discover
sagcc exec repository fixes export
sagcc exec repository products export
sagcc exec repository mirror validateContent
sagcc exec repository refresh
sagcc list repository
sagcc list repository discover
sagcc list repository fixes content
sagcc list repository fixes dependencies
sagcc list repository fixes readme
sagcc list repository products content
sagcc list repository products dependencies
sagcc list repository products languages
sagcc update repository fixes
sagcc update repository products
Resources Commands
sagcc list resources icons
Security Credentials Commands
sagcc add security credentials
sagcc add security credentials sharedsecret
sagcc delete security credentials
sagcc exec security encrypt
sagcc exec security encrypt input
sagcc get security credentials
Stacks and Layers Commands
sagcc create stacks
sagcc create stacks auto
sagcc create stacks layers
sagcc create stacks layers nodes master
sagcc delete stacks
sagcc delete stacks layers
sagcc exec stacks migrate
sagcc list stacks
sagcc list stacks layers
sagcc list stacks layers fixes
sagcc get stacks layers fixes compare
sagcc list stacks layers instances
sagcc list stacks layers instances compare
sagcc list stacks layers nodes
sagcc get stacks layers nodes master
sagcc list stacks layers products
sagcc list stacks migrate properties
sagcc list stacks migrate status
sagcc get stacks layers products compare
sagcc update stacks index
sagcc update stacks layers index
sagcc update stacks alias
sagcc update stacks layers alias
Template Commands
sagcc delete templates composite
sagcc exec templates composite apply
sagcc exec templates composite import
sagcc exec templates composite import repository
sagcc exec templates composite generate
sagcc exec templates composite generate input
sagcc exec templates composite generate migration
sagcc exec templates composite validate
sagcc get templates composite export
sagcc list templates composite
sagcc list templates composite properties
Configuring Command Central and Platform Manager
Configuration Types for Command Central and Platform Manager OSGI
Configuration Types for Command Central and Platform Manager OSGI ENGINE
Run-time Monitoring States for OSGI-CCE and OSGI-SPM
Run-time Monitoring States for OSGI-SPM-ENGINE
Server System Properties
Authentication
Migration
Provisioning
SSH Connections
Using the Secure Socket Layer (SSL) Protocol and Certificates in Command Central
Using the Secure Socket Layer (SSL) Protocol and Certificates in Command Central
Preparing to Replace the Default Keystore and Truststore
Configuring the HTTPs Ports to Use the Custom Keystore
Update the HTTPs Port of the Command Central Server
Update the HTTPs Port of Platform Manager
Update the SSL Connection Settings for the CLI
Considerations When Using Configuration Properties
Introduction to Command Central REST API
About Command Central REST API
Securing Command Central REST API
Session Management
Command Central REST API Resources
Supported Media Types
HTTP Response Codes
Summary of REST Services
Logging and Troubleshooting
Using the Command Central and Platform Manager Logs
Viewing Logs in Command Central
Command Central Logs
Platform Manager Logs
Using the Correlation ID
Logging Levels
Changing the Log Configuration Settings
Changing the Wrapper Logs Configuration
Deleting Logs
Size-based Log Rotation (Default)
Delete Command Central Logs
Delete Platform Manager Logs
Time-based Log Rotation
Activity Appears to Stop During File Download
Bootstrapper Fails with Package Error Such as "installer.jar not found"
Expected Product-specific Features are Not Available
Cannot Connect to Repositories Due to Invalid Credentials
Cannot Create Mirror Repository Because of Network Issues
Command Central Cannot Connect to Platform Managers
Values with Special Characters in a Template YAML File
Using the Syscap UNIX Shell Script
Applying a Template Fails Because Product Configurations Fail to Apply
Setting the Values of Java System Properties in the Command Central Web User Interface and CLI
Remote Operations Run by Command Central over SSH get Terminated
Copyright
Complete Installation and Upgrade Information for Software AG Products
Copyright