Optimize 10.5 | webMethods Optimize Documentation | Configuring BAM | Using Command Central to Manage Optimize | Using the Command Line to Manage Optimize | Commands that Optimize Supports
 
Commands that Optimize Supports
Optimize supports the Command Central Command Line Interface commands listed in the following table. The table lists where you can find general information about each command. Additionally, the table lists where you can learn more about arguments and options that Optimize supports or details about the actions Optimize takes when you execute an exec command.
Commands
For more information, see
sagcc create configuration data
For general information about the command, see Software AG Command Central Help.
sagcc delete configuration data
For general information about the command, see Software AG Command Central Help.
sagcc get configuration data
For general information about the command, see Software AG Command Central Help.
sagcc update configuration data
For general information about the command, see Software AG Command Central Help.
sagcc get configuration instances
For general information about the command, see Software AG Command Central Help.
sagcc list configuration instances
For general information about the command, see Software AG Command Central Help.
sagcc get configuration types
For general information about the command, see Software AG Command Central Help.
sagcc list configuration types
For general information about the command, see Software AG Command Central Help.
sagcc exec configuration validation create
For general information about the command, see Software AG Command Central Help.
sagcc exec configuration validation delete
For general information about the command, see Software AG Command Central Help.
sagcc exec configuration validation update
For general information about the command, see Software AG Command Central Help.
sagcc exec administration product migration migrate
This command is supported by Optimize Infrastructure Data Collector.
For general information about the command, see Software AG Command Central Help.
For information about the Infrastructure Data Collector migration utility, see Upgrading Software AG Products On Premises.
Examples When Executing on Command Central
Examples for Analytic Engine
*To list all configuration types for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc list configuration types optimizeAnalysis-analysis
--server http://localhost:8092/spm -p secret
*To list all configuration instances for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc list configuration instances optimizeAnalysis-analysis
--server http://localhost:8092/spm -p secret
*To test the creation of a JDBC configuration instance "COMMON-JDBC-mssql" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret", and configuration definition in "test.xml" file:
sagcc exec configuration validation optimizeAnalysis-analysis create
COMMON-JDBC --server http://localhost:8092/spm -p secret
-i C:\inputs\test.xml
*To create a JDBC configuration instance "COMMON-JDBC-mssql" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret", and configuration definition in "test.xml" file:
sagcc create configuration data optimizeAnalysis-analysis COMMON-JDBC
--server http://localhost:8092/spm -p secret -i C:\inputs\test.xml
The format of the "test.xml" file that creates the "COMMON-JDBC-mssql" configuration instance is the following:
<JDBCSettings>
<Pool alias="mssql">
<Name>mssql</Name>
<Description>Microsoft SQL DB</Description>
<MinSize>8</MinSize>
<MaxSize>60</MaxSize>
<MaxIdleTime>20</MaxIdleTime>
<RampUpDelay>500</RampUpDelay>
<Retries>8</Retries>
<RetriesBackoff>500</RetriesBackoff>
<MaxStatementsInCache>0</MaxStatementsInCache>
<DatabaseServer type="SQLSERVER">
<Host>localhost</Host>
<PortNumber>1433</PortNumber>
<Database>optimize</Database>
<URL>jdbc:wm:sqlserver://localhost:1433;
DatabaseName=optimize</URL>
<User>Administrator</User>
<Password>1482227624814_4</Password>
</DatabaseServer>
</Pool>
</JDBCSettings>
*To get the configuration instance details for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret" and include the output instance details in an xml file:
sagcc get configuration instances optimizeAnalysis-analysis
COMMON-JDBC-default --server http://localhost:8092/spm -p secret --format xml
*To test the update of the configuration data of a JDBC configuration instance "COMMON-JDBC-mssql" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret", and configuration definition in "test.xml" file:
sagcc exec configuration validation optimizeAnalysis-analysis udpate
COMMON-JDBC-mssql --server http://localhost:8092/spm -p secret
-i C:\inputs\test.xml
*To update the configuration data of a JDBC configuration instance "COMMON-JDBC-mssql" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc update configuration data optimizeAnalysis-analysis
COMMON-JDBC-mssql --server http://localhost:8092/spm -p secret
-i C:\inputs\test.xml
*To get the configuration data of a JDBC configuration instance "COMMON-JDBC-mssql" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc get configuration data optimizeAnalysis-analysis COMMON-JDBC-mssql
--server http://localhost:8092/spm
*To delete a JDBC configuration instance "COMMON-JDBC-mssql" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm":
sagcc delete configuration data optimizeAnalysis-analysis COMMON-JDBC
--server http://localhost:8092/spm -p secret
*To update the configuration data of an Endpoints configuration instance "COMMON-COMPONENT-ENDPOINTS-Configuration-Agent" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data in the "test1.xml" file:
sagcc update configuration data optimizeAnalysis-analysis
COMMON-COMPONENT-ENDPOINTS-Configuration-Agent
--server http://localhost:8092/spm -p secret -i C:\inputs\test1.xml
*To update the configuration data of a Databases configuration instance "COMMON-DBFUNCTION-AnalysisEngine" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data in the "test2.xml" file:
sagcc update configuration data optimizeAnalysis-analysis
COMMON-DBFUNCTION-AnalysisEngine
--server http://localhost:8092/spm -p secret -i C:\inputs\test2.xml
*To update the configuration data of a configuration instance "COMMON-SMTP-MailSettings" for Analytic Engine with ID "optimizeAnalysis-analysis" that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data in the "test3.xml" file:
sagcc update configuration data optimizeAnalysis-analysis
COMMON-SMTP-MailSettings --server http://localhost:8092/spm
-p secret -i C:\inputs\test3.xml
The format of the "test3.xml" file that updates the "COMMON-SMTP-MailSettings" configuration instance is the following:
<EmailSettings>
<Host>smtp</Host>
<PortNumber>6670</PortNumber>
<User>admin</User>
<Password>mailServerPasswordHandle</Password>
<Charset>UTF-8</Charset>
<ExtendedProperties>
<Property name="name">Mail Settings</Property>
<Property name="AuthenticationRequired">false</Property>
<Property name="SenderDomain">softwareag.com</Property>
<Property name="DefaultSender">optimize@localhost</Property>
<Property name="AdminAddress">admin@localhost</Property>
<Property name="Templates">
Business monitor violation=./templates/BusinessMonitorViolation.template
SNMPAlert=./templates/SNMPAlert.template
DefaultTemplate=./templates/DefaultEmailAlert.template.vm
</Property>
<Property name="SocketTimeout">60000</Property>
</ExtendedProperties>
</EmailSettings>
Examples for Web Service Data Collector
*To get the configuration data of the endpoints configuration instance "COMMON-COMPONENT-ENDPOINTS-Configuration-Agent" for Web Service Data Collector with ID "optimizeWSDataCollector-dataCollector" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc get configuration data optimizeWSDataCollector-dataCollector
COMMON-COMPONENT-ENDPOINTS-Configuration-Agent
--server http://localhost:8092/spm -p secret
*To update the configuration data of the endpoints configuration instance "COMMON-COMPONENT-ENDPOINTS-Configuration-Agent" for Web Service Data Collector with ID "optimizeWSDataCollector-dataCollector" that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data in the "port_data.xml" file:
sagcc update configuration data optimizeWSDataCollector-dataCollector
COMMON-COMPONENT-ENDPOINTS-Configuration-Agent
--server http://localhost:8092/spm -p secret -i c:\inputs\port_data.xml
*To get the configuration data of a JNDI configuration instance "COMMON-JNDI-JNDIConfiguration" for Web Service Data Collector with ID "optimizeWSDataCollector-dataCollector" that is running on server "http://localhost:8092/spm":
sagcc get configuration data optimizeWSDataCollector-dataCollector
COMMON-JNDI-JNDIConfiguration --server http://localhost:8092/spm -p secret
*To update the configuration data of a JNDI configuration instance "COMMON-JNDI-JNDIConfiguration" for Web Service Data Collector that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data in the "port_data.xml" file:
sagcc update configuration data optimizeWSDataCollector-dataCollector
COMMON-JNDI-JNDIConfiguration --server http://localhost:8092/spm
-p secret -i c:\inputs\port_data.xml
*To get the configuration data of a Logging configuration instance "COMMON-LOG" for Web Service Data Collector with ID "optimizeWSDataCollector-dataCollector" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc get configuration data optimizeWSDataCollector-dataCollector
COMMON-LOG --server http://localhost:8092/spm -p secret
*To update the configuration data of a Logging configuration instance "COMMON-LOG" for Web Service Data Collector with ID "optimizeWSDataCollector-dataCollector" that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data fin the "port_data.xml" file:
sagcc update configuration data optimizeWSDataCollector-dataCollector
COMMON-LOG --server http://localhost:8092/spm -p secret
-i c:\inputs\port_data.xml
Examples for Infrastructure Data Collector
*To list all configuration types for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc list configuration types OSGI-InfraDC-ENGINE
--server http://localhost:8092/spm -p secret
*To list all configuration instances for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc list configuration instances OSGI-InfraDC-ENGINE
--server http://localhost:8092/spm -p secret
*To test the update of the configuration data of a JNDI configuration instance "COMMON-JNDI-InfraDC-JNDIConfiguration" for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm" with administrator password "secret", and configuration definition in "jndi_test.xml" file:
sagcc exec configuration validation OSGI-InfraDC-ENGINE udpate
COMMON-JNDI-InfraDC-JNDIConfiguration --server http://localhost:8092/spm
-p secret -i C:\inputs\jndi_test.xml
*To update the configuration data of a JNDI configuration instance "COMMON-JNDI-InfraDC-JNDIConfiguration" for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm" with administrator password "secret", and configuration definition in "jndi_test.xml" file:
sagcc update configuration data OSGI-InfraDC-ENGINE
COMMON-JNDI-InfraDC-JNDIConfiguration --server http://localhost:8092/spm
-p secret -i C:\inputs\jndi_test.xml
The format of the "jndi_test.xml" file that updates the "COMMON-JNDI-InfraDC-JNDIConfiguration" configuration instance is the following:
<JNDISettings>
<JNDI alias="JNDIConfiguration-InfraDC">
<ExtendedProperties>
<Property name="ConnectionUri"/>
<Property name="NamingFactoryImpl">com.pcbsys.nirvana.nSpace.
NirvanaContextFactory</Property>
<Property name="UseSSL">true</Property>
<Property name="UseEncryption">true</Property>
<Property name="KeyStoreFile">C:\SoftwareAG\certificates\
client.jks</Property>
<Property name="KeyStoreType">JKS</Property>
<Property name="DN"/>
<Property name="TrustStoreFile">C:\SoftwareAG\certificates\
truststore.jks</Property>
<Property name="TrustStoreType">JKS</Property>
<Property name="StorePassword">brokerKeyAndTrustStorePasswordHandle
</Property>
<Property name="JmsUrlOverride"/>
</ExtendedProperties>
</JNDI>
</JNDISettings>
*To get the configuration data of a JNDI configuration instance "COMMON-JNDI-InfraDC-JNDIConfiguration" for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm" with administrator password "secret":
sagcc get configuration data
OSGI-InfraDC-ENGINE COMMON-JNDI-InfraDC-JNDIConfiguration
--server http://localhost:8092/spm
*To delete a JNDI configuration instance "COMMON-JNDI-InfraDC-JNDIConfiguration" for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm":
sagcc delete configuration data
OSGI-InfraDC-ENGINE COMMON-JNDI-InfraDC-JNDIConfiguration
--server http://localhost:8092/spm -p secret
*To update the configuration data of an Endpoints configuration instance "COMMON-COMPONENT-ENDPOINTS-JMS-Provider" for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data in the "test1.xml" file:
sagcc update configuration data OSGI-InfraDC-ENGINE
COMMON-COMPONENT-ENDPOINTS-JMS-Provider
--server http://localhost:8092/spm -p secret -i C:\inputs\test.xml
*To update the configuration data of a Collector Settings configuration instance "IDC-SETTING-CollectorSettings" for Infrastructure Data Collector with ID "OSGI-InfraDC-ENGINE" that is running on server "http://localhost:8092/spm" with administrator password "secret" with the configuration data in the "cs_test.xml" file:
sagcc update configuration data OSGI-InfraDC-ENGINE
IDC-SETTING-CollectorSettings
--server http://localhost:8092/spm -p secret -i C:\inputs\cs_test.xml
The format of the "cs_test.xml" file that updates the "IDC-SETTING-CollectorSettings" configuration instance is the following:
<properties>
<name>Collector Settings</name>
<dcName>InfraDCxx</dcName>
<pollingInterval>2</pollingInterval>
<adabasLoadFlag>false</adabasLoadFlag>
<adabasSOAGatewayLoadFlag>true</adabasSOAGatewayLoadFlag>
<apamaLoadFlag>false</apamaLoadFlag>
<applinxLoadFlag>true</applinxLoadFlag>
<brokerLoadFlag>false</brokerLoadFlag>
<completeDCLoadFlag>true</completeDCLoadFlag>
<entireXLoadFlag>false</entireXLoadFlag>
<eventRoutingLoadFlag>false</eventRoutingLoadFlag>
<integrationServerLoadFlag>true</integrationServerLoadFlag>
<mwsLoadFlag>true</mwsLoadFlag>
<mzngLoadFlag>true</mzngLoadFlag>
<naturalAjaxLoadFlag>true</naturalAjaxLoadFlag>
<naturalLoadFlag>true</naturalLoadFlag>
<prestoLoadFlag>true</prestoLoadFlag>
<snmpLoadFlag>true</snmpLoadFlag>
<tcLoadFlag>true</tcLoadFlag>
<umClusterLoadFlag>false</umClusterLoadFlag>
<umLoadFlag>false</umLoadFlag>
<desLoadFlag>true</desLoadFlag>
<logLevel>TRACE</logLevel>
</properties>
*To view the command line help for the migration utility for Infrastructure Data Collector with ID "InfrastructureDC":
sagcc list administration product local InfrastructureDC migration help
*To migrate Infrastructure Data Collector with ID "InfrastructureDC" from a source directory "C:/SoftwareAG" to a destination directory "C:/SoftwareAG_" on a target node with alias "local":
sagcc exec administration product local InfrastructureDC migration
migrate srcDir=C:/SoftwareAG destDir=C:/SoftwareAG_