API Management 10.4 | Administering CentraSite | CentraSite Command Line Tools | CentraSiteCommand Line Tools
 
CentraSiteCommand Line Tools
CentraSite Command is a tool that release managers, infrastructure engineers, system administrators, and operators can use to perform administrative tasks from a single location. CentraSite Command can assist with the following configuration, management, and monitoring tasks:
*Infrastructure engineers can see at a glance which products and fixes are installed where, and can easily compare installations to find discrepancies.
*System administrators can configure environments using a graphical user interface, command line tool, or API, so maintenance can be performed with minimum effort and risk.
*Release managers can prepare and deploy changes to multiple servers using command-line scripting for simpler, safer lifecycle management.
*Operators can monitor server status and health, as well as start and stop servers from a single location. They can also configure alerts to be sent to them in case of unplanned outages.
You execute the CentraSiteCommand in the command line tool CentraSiteCommand.cmd (Windows) or CentraSiteCommand.sh (UNIX) to perform various administrative tasks in CentraSite. The command line tool is located in the utilities folder in the <CentraSiteInstall_Directory>.
The syntax is of the format:
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.[cmd|sh] <CentraSiteCommand> <CentraSiteCommand Parameter>
If you start the command tool with no parameters, you receive a help text summarizing the required input parameters.
The parameters of the command are case-sensitive, so for example the parameter -url must be specified as shown and not as -URL.
Example:
C:\SoftwareAG\CentraSite\utilities>CentraSiteCommand.cmd set preferences -user <USER-ID> -password <PASSWORD> [-url <CENTRASITE-URL>] -targetUser <TARGET USER> -file <CONFIGFILE>
List of CentraSiteCommand Line Tools
Command Name
Description
set DefaultDomain
Sets a default authentication configuration in CentraSite.
get Authentication
Fetches information of an existing LDAP authentication configuration in CentraSite.
set Authentication
Adds a new (LDAP) authentication configuration to CentraSite.
remove Authentication
Deletes an existing LDAP authentication configuration in CentraSite.
list gateways
Shows a list of all currently defined gateways in CentraSite.
For more information, see CentraSite User’s Guide.
set gateway
Adds a new Mediator gateway to CentraSite.
For more information, see CentraSite User’s Guide.
remove gateway
Deletes an existing Mediator gateway in CentraSite.
For more information, see CentraSite User’s Guide.
state runtimeEvent
Fetches the current state of an active run-time event store in CentraSite.
For more information, see CentraSite User’s Guide.
switch runtimeEvent
Changes the storage mode of run-time events in CentraSite.
For more information, see CentraSite User’s Guide.
purge runtimeEvent
Removes unwanted data of the active run-time event store in CentraSite.
For more information, see CentraSite User’s Guide.
set SSL RR
Specifies the SSL security values for CentraSite Registry Repository (CRR).
set SSL AST
Specifies the SSL security values for CentraSite Application Server Tier (CAST).
set SSL usage
Changes the communication between CentraSite Application Server Tier and CentraSite Registry Repository from a full 2-way SSL (HTTPS) communication to HTTP communication.
get SSL RR
Fetches the SSL security values of CentraSite Registry Repository.
get SSL AST
Fetches the SSL security values of CentraSite Application Server Tier.
get SSL usage
Identifies the communication method between the CentraSite Application Server Tier (CAST) and the CentraSite Registry Repository (CRR).
set Email
Configures the email notification settings for Simple Mail Transport Protocol (SMTP) server.
For more information, see Configuring Email Server Settings.
get Email
Fetches the email notification settings of Simple Mail Transport Protocol server.
For more information, see Fetching Email Server Settings.
set preferences
Defines the user-specific settings for CentraSite Business UI.
For more information, see CentraSite User’s Guide.
get preferences
Fetches the user-specific settings for CentraSite Business UI.
For more information, see CentraSite User’s Guide.
reset preferences
Resets the user-specific settings in CentraSite Business UI.
For more information, see CentraSite User’s Guide.
list Reports
Shows a list of all the existing reports in CentraSite Business UI.
For more information, see CentraSite User’s Guide.
add Report
Adds a new report to the CentraSite.
For more information, see CentraSite User’s Guide.
update Report
Modifies the information of an existing report in the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
delete Report
Deletes an existing report in CentraSite.
For more information, see CentraSite User’s Guide.
share Report
Shares dynamic, read-only reports with the API Portal users (without giving them access to all of the report's data) for monitoring API usage.
For more information, see CentraSite User’s Guide.
download Report Template
Downloads a BIRT report design file that contains the definition of a report template.
For more information, see CentraSite User’s Guide.
list Scheduled Reports
Shows a list of all the existing scheduled reports in CentraSite.
For more information, see CentraSite User’s Guide.
add Scheduled Report
Adds a new scheduled report to CentraSite.
For more information, see CentraSite User’s Guide.
update Scheduled Report
Modifies the information of an existing scheduled report in the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
delete Scheduled Report
Deletes an existing scheduled report in CentraSite.
For more information, see CentraSite User’s Guide.
trigger Scheduled Report
Triggers an existing scheduled report in CentraSite.
For more information, see CentraSite User’s Guide.
list Pending Consumer Registrations
Shows a list of all the pending consumer registration requests that were pending for an approval and were transferred from a previous version of CentraSite in the migration process.
For more information, see CentraSite User’s Guide.
add Admin
Adds a user with the CentraSite Administrator role in CentraSite's user repository.
For more information, see CentraSite User’s Guide.
generate JaasConfiguration
Transforms and migrates the LDAP configuration to the new JAAS configuration.
restore accesstokens
Restores the expired access tokens in CentraSite.
For more information, see CentraSite User’s Guide.
deploy
Deploys (also referred to as Publish in CentraSite Business UI) a single Virtual Service to Mediator gateway.
For more information, see CentraSite User’s Guide.
undeploy
Undeploys (also referred to as Unpublish in CentraSite Business UI) a single Virtual Service from Mediator gateway.
For more information, see CentraSite User’s Guide.
bulk deploy
Deploys (also referred to as Publish in CentraSite Business UI) multiple Virtual Services to Mediator gateways in one line.
For more information, see CentraSite User’s Guide.
bulk undeploy
Undeploys (also referred to as Unpublish in CentraSite Business UI) multiple Virtual Services from Mediator gateway in one line.
For more information, see CentraSite User’s Guide.
bulk redeploy
Redeploys (also referred to as Publish in CentraSite Business UI) multiple Virtual Services to a Mediator gateway in one line.
For more information, see CentraSite User’s Guide.
bulk clean redeploy
Undeploys and redeploys multiple Virtual Services that are already deployed to a Mediator gateway in one line.
For more information, see CentraSite User’s Guide.
delete Organization
Deletes an organization that includes internal references to other registry objects in the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
add Report Association
Associates a report with the specified asset types.
For more information, see CentraSite User’s Guide.
list Report Associations
Shows a list of all the asset types that are associated with a report.
For more information, see CentraSite User’s Guide.
delete Report Association
Deletes the association between a report and the asset types.
For more information, see CentraSite User’s Guide.
set Password
Changes the password of a predefined user or a login user.
For more information, see CentraSite User’s Guide.
import Service
Imports a REST Service asset using RAML (RESTful API Modeling Language) or Swagger file into the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
ImportWSDL
Imports a Web Service asset using WSDL (Web Services Description Language) file into the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
ImportSchema
Imports an XML Schema asset using XML Schema Definition (XSD) file into the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
ImportBPEL
Imports a BPEL Process asset using BPEL file into the CentraSite Registry Repository.
For more information, see Importing a BPEL Process.
For more information, see CentraSite User’s Guide.
ImportXPDL
Imports a Process asset using XPDL file into the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
ImportArchive
Imports assets using an archive (.zip) file into the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
start auditLog
Starts logging of the CentraSite user information.
For more information, see Starting the Audit Logs.
unload auditLog
Reads the audit log and displays the information as a standard output or writes the information to a file.
For more information, see Storing the Audit Log Data.
stop auditLog
Stops logging of the CentraSite user information.
For more information, see Stopping the Audit Logs.
state auditLog
Checks if the user information was successfully logged on or not in the CentraSite Registry Repository.
For more information, see Checking Current State of Audit Log.
switch auditLog
Specifies that CentraSite should store the next log entry in the subsequent log file.
For more information, see Switching the Audit Log Store.
record auditLog
Inserts a log entry into the current audit log.
For more information, see Recording the Audit Log.
set Log
Defines the log settings for specified log units using a configuration file.
For more information, see Configuring Log Settings.
get Log
Fetches the configuration details of the log settings.
For more information, see Obtaining Log Configuration Settings.
purge Logs
Purges the log configuration settings.
For more information, see Purging Logs.
sync consumers
Synchronizes consumer applications with a Mediator gateway.
For more information, see CentraSite User’s Guide.
get Asymmetric Binding
Fetches information of the current asymmetric binding configuration in CentraSite.
For more information, see CentraSite User’s Guide.
set Asymmetric Binding
Specifies an asymmetric binding configuration in CentraSite.
For more information, see CentraSite User’s Guide.
remove Asymmetric Binding
Removes an existing asymmetric binding configuration from CentraSite.
For more information, see CentraSite User’s Guide.
set UDDI
Specifies the local UDDI properties or global UDDI properties in CentraSite.
get UDDI
Fetches information of the local UDDI properties or global UDDI properties in CentraSite.
purge accesstokens
Purges all the expired or inactive access tokens in CentraSite.
For more information, see CentraSite User’s Guide.
remove Attribute
Removes an attribute from an asset type, in cases where there are existing asset instances of the asset type containing a value for the attribute to be removed from the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
add Search
Adds a custom XQuery reporting search to the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
copy Search
Creates a copy of an XQuery reporting search in the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
get Search
Retrieves information about an XQuery reporting search in the CentraSite Registry Repository.
For more information, see CentraSite User’s Guide.
list Search
Shows a list of all XQuery reporting searches in CentraSite.
For more information, see CentraSite User’s Guide.
get ApiPortalConfig
Fetches information of the current retry configuration settings for delivery of messages from CentraSite to API Portal.
For more information, see CentraSite User’s Guide.
set ApiPortalConfig
Specifies the retry configuration settings for delivery of messages from CentraSite to API Portal.
For more information, see CentraSite User’s Guide.
send AccessTokens
Resends the undelivered access tokens to the respective API Portal gateways.
For more information, see CentraSite User’s Guide.
list CAST
Shows a list of available CASTs in CentraSite.
add CAST
Adds a new CAST to the CentraSite Registry Repository.
remove CAST
Deletes an existing CAST from the CentraSite Registry Repository.
set Consumer
Associates an Application asset (represented as a consumer application) with a Virtual Service asset.
For more information, see CentraSite User’s Guide.
reset Consumer
Removes an association that exists between an Application asset (represented as a consumer application) and a Virtual Service asset.
For more information, see CentraSite User’s Guide.
reassign Consumer
Reassigns an Application, API-Key, or OAuth2 Client asset (represented as a consumer application) to a Virtual Service asset.
For more information, see CentraSite User’s Guide.
Copyright © 2015- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release