obtain complete listing of available APIs for tcServer and whether or not each allows guest access
search cancel

obtain complete listing of available APIs for tcServer and whether or not each allows guest access

book

Article ID: 407763

calendar_today

Updated On:

Products

VMware Tanzu Spring Runtime

Issue/Introduction

obtain complete listing of available APIs for tcServer and whether or not each allows guest access

Resolution

tcServer does not expose distinct programmatic API for direct interaction with its core functionalities.

tc Server provides a CLI (command-line tool e.g tcserver script) intended for administrators to manage/configure service instances. These tools and templates allow for automation and customization of server behavior, including setting up SSL, clustering, and resource configurations (like JDBC datasources).
 
tcServer is built on Tomcat which is an open source web server and servlet container.

So no API listing available.

tcServer has a CLI. Following is a list. 

Loading tc Server configuration properties from: /Users/xxxxxxxx/.tc-server/tc-server-10.1.properties
Usage: tc-server-10.1 COMMAND [OPTIONS] [ARGS]

The tc Server commands are:

Instance Provisioning Commands:

   apply-template      Applies a template to an existing instance
   create              Creates a new instance
   create-from-file    Creates a new instance from a properties file or backup file
   deploy              Deploys a .war file to an instance
   destroy             Permanently removes an instance from the filesystem
   get-property        Retrieves a property from an instance's catalina.properties
   list                Lists existing instances and their details
   modify              Modifies tc Runtime version, Java Home, or catalina property of an instance

Instance Lifecycle Commands:

   configtest          Run a basic syntax check on server.xml - check exit code for result
   info                Displays information on a tc Runtime instance
   logs                Displays logs from an instance
   restart             Restarts a tc Runtime instance running as a background process
   run                 Runs a tc Runtime instance as a foreground process
   start               Starts a tc Runtime instance as a background process
   status              Reports the running status of a tc Runtime instance
   stop                Stops a tc Runtime instance running as a background process

Administrative Tooling Commands:

   backup              Creates a zip backup of instance
   decode              Decodes a string encoded by the 'encode' command
   encode              Encodes values for use in an instance
   get-template        Installs a template
   list-templates      Lists available templates from a template repository
   support-bundle      Creates a zip archive of common files needed for diagnostics
   thread-dump         Issues a thread dump of tc Runtime instance and outputs to a file

General Commands:

   about               Displays information about Tanzu tc Server(TM)
   help                More information on a specific command
   jakartaee-migrate   Runs the JakartaEE Migration Tool
   version             Displays version information about tc Server or a tc Runtime Instance

JY7DJWNPHQ:ta