TIBCO Platform Commands
tibcop tplatform
Commands for the TIBCO Platform
Usage
tibcop tplatform:COMMAND
Commands
| Command | Description |
|---|---|
tplatform:cicr
|
Create ingress resource inside a data plane |
tplatform:create-ingress-resource-instance
|
Create ingress resource inside a data plane |
tplatform:create-storage-resource-instance
|
Create storage resource inside a data plane |
tplatform:csr
|
Create storage resource inside a data plane |
tplatform:delete-capability-instance
|
Delete a capability instance from a data plane |
tplatform:delete-resource-instance
|
Delete a resource instance from TIBCO Control Plane |
tplatform:ldp
|
List the available data planes. |
tplatform:list-apps
|
List apps on a TIBCO Control Plane |
tplatform:list-capabilities
|
List capabalities on a TIBCO Control Plane |
tplatform:list-capability-instances
|
List capabalities instances in a data plane |
tplatform:list-dataplanes
|
List the available data planes. |
tplatform:list-resource-instances
|
List details of the resources in data plane |
tplatform:list-resources
|
List all resources from TIBCO Control Plane |
tplatform:register-control-tower-dataplane
|
Command to register a control tower data plane |
tplatform:register-k8s-dataplane
|
Command to register a Kubernetes data plane |
tplatform:unregister-dataplane
|
Unregister a data plane from TIBCO Control Plane |
tplatform:validate
|
Validates the existence/non-existence of a object. |
tibcop tplatform:list-dataplanes
List the available data planes.
Usage
tibcop tplatform:list-dataplanes [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [--name <value>] [--type k8s|control-tower] [-d]
Flags
| Flag | Description |
|---|---|
-d, --debug
|
Enable debug logging |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--name=<value>
|
Data plane name filter value |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
--type=<option>
|
Data plane type filter value <options: k8s | control-tower> |
Aliases
tibcop tplatform:ldp
Examples
tibcop tplatform:list-data-planes tibcop tplatform:list-data-planes --json
tibcop tplatform:list-resources
List all resources from TIBCO Control Plane.
Usage
tibcop tplatform:list-resources [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [-d]
Flags
| Flag | Description |
|---|---|
-d, --debug
|
Enable debug logging |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
tibcop tplatform:list-resource-instances
List details of the resources in data plane
Usage
tibcop tplatform:list-resource-instances [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [--dataplane-name <value> | --dataplane-id <value>] [-d]
Flags
| Flag | Description |
|---|---|
-d, --debug
|
Enable debug logging |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--dataplane-id=<value>
|
Data plane id |
--dataplane-name=<value>
|
Data plane name |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:list-resource-instances --dataplane-name "DATAPLANE_NAME"
tibcop tplatform:list-resource-instances --dataplane-id "DATAPLANE_ID"
tibcop tplatform:list-capabilities
List capabilities provisioned on a TIBCO Control Plane
Usage
tibcop tplatform:list-capabilities [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [-d]
Flags
| Flag | Description |
|---|---|
-d, --debug
|
Enable debug logging |
--config=<value>
|
Path to the local configuration file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:list-capabilities
tibcop tplatform:list-capability-instances
List capabilities instances in a data plane
USAGE
tibcop tplatform:list-capability-instances [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [--dataplane-name <value> | --dataplane-id <value>] [-d]
FLAGS
| Flag | Description |
|---|---|
-d, --debug
|
Enable debug logging |
--config=<value>
|
Path to the local configuration file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--dataplane-id=<value>
|
Data plane id |
--dataplane-name=<value>
|
Data plane name |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:list-capability-instances --dataplane-name "DATAPLANE_NAME"
tibcop tplatform:list-capability-instances --dataplane-id "DATAPLANE_ID"
tibcop tplatform:register-k8s-dataplane
Command to register a Kubernetes data plane.
Usage
tibcop tplatform:register-k8s-dataplane -n <value> -s <value> -a <value> [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [-d <value>] [--helm-repo-resource-instance-id <value>] [--helm-repo-resource <value>] [--cluster-scoped-permissions] [--fluent-bit] [--proxy-config <value>] [--container-registry <value>] [-o] [-d]
Flags
| Flag | Description |
|---|---|
-a, --service-account-name=<value>
|
(required) Service account name |
-d, --debug
|
Enable debug logging |
-d, --description=<value>
|
Description new data plane |
-n, --name=<value>
|
(required) Name of the new data plane |
-o, --onlyPrintScripts
|
Only print the scripts |
-s, --namespace=<value>
|
(required) Namespace |
--cluster-scoped-permissions
|
Allow cluster scoped permissions |
--config=<value>
|
Path to the local config file |
--container-registry=<value>
|
Container registry |
--cpurl=<value>
|
TIBCO Control Plane URL |
--fluent-bit
|
Fluent bit |
--helm-repo-resource=<value>
|
Helm repository resource |
--helm-repo-resource-instance-id=<value>
|
Helm repository resource instance id |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--proxy-config=<value>
|
Proxy configuration |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:register-k8s-dataplane
tibcop tplatform:register-control-tower-dataplane
Command to register a control tower data plane
USAGE
tibcop tplatform:register-control-tower-dataplane -n <value> -s <value> -a <value> --storage-resource-name <value> --storage-resource-description <value> --storage-class-name <value> --ingress-resource-name <value> --ingress-resource-description <value> --ingress-controller-name <value> --ingress-class-name <value> --fqdn <value> [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [--description <value>] [--helm-repo-resource-instance-id <value>] [--helm-repo-resource <value>] [--cluster-scoped-permissions] [--proxy-config <value>] [--container-registry <value>] [-o] [-d]
FLAGS
| Flag | Description |
|---|---|
-a, --service-account-name=<value>
|
(required) Service account name |
-d, --debug
|
Enable debug logging |
-n, --name=<value>
|
(required) Name of the new data plane |
-o, --onlyPrintScripts
|
Only print the scripts |
-s, --namespace=<value>
|
(required) Namespace |
--cluster-scoped-permissions
|
Allow cluster scoped permissions |
--config=<value>
|
Path to the local configuration file |
--container-registry=<value>
|
Container registry |
--cpurl=<value>
|
TIBCO Control Plane URL |
--description=<value>
|
Description of the new data plane |
--fqdn=<value>
|
(required) Fully qualified domain name |
--helm-repo-resource=<value>
|
Helm repository resource |
--helm-repo-resource-instance-id=<value>
|
Helm repository resource instance id |
--ingress-class-name=<value>
|
(required) Ingress class name |
--ingress-controller-name=<value>
|
(required) Ingress controller name |
--ingress-resource-description=<value>
|
(required) Ingress resource description |
--ingress-resource-name=<value>
|
(required) Ingress resource name |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--proxy-config=<value>
|
Proxy configuration |
--storage-class-name=<value>
|
(required) Storage class name |
--storage-resource-description=<value>
|
(required) Storage resource description |
--storage-resource-name=<value>
|
(required) Storage resource name |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:register-control-tower-dataplane
tibcop tplatform:create-storage-resource-instance
Create storage resource inside a data plane
USAGE
tibcop tplatform:create-storage-resource-instance -n <value> -c <value> [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [--dataplane-id <value> | --dataplane-name <value>] [--description <value>] [-d]
FLAGS
| Command Line Option | Description |
|---|---|
-c, --storage-class-name=<value>
|
(required) Storage class name |
-d, --debug
|
Enable debug logging |
-n, --name=<value>
|
(required) Resource name |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--dataplane-id=<value>
|
Data plane id |
--dataplane-name=<value>
|
Data plane name |
--description=<value>
|
Resource description for storage class |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Aliases
tibcop tplatform:csr
Examples
tibcop tplatform:create-storage-resource-instance --dataplane-name dpname --name ResourceName --storage-class-namee ResourceClassName --description Description
tibcop tplatform:create-storage-resource-instance --dataplane-id dpid --name ResourceName --storage-class-name ResourceClassName --description Description
tibcop tplatform:create-ingress-resource-instance
Create ingress resource inside a data plane
USAGE
tibcop tplatform:create-ingress-resource-instance -n <value> -c <value> -i <value> -f <value> [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [--dataplane-id <value> | --dataplane-name <value>] [--description <value>] [-d]
FLAGS
| Command Line Option | Description |
|---|---|
-c, --ingress-class-name=<value>
|
(required) Ingress class name |
-d, --debug
|
Enable debug logging |
-f, --fqdn=<value>
|
(required) Fully qualified domain name |
-i, --ingress-controller=<value>
|
(required) Ingress controller |
-n, --name=<value>
|
(required) Resource name |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--dataplane-id=<value>
|
Data plane id |
--dataplane-name=<value>
|
Data plane name |
--description=<value>
|
Resource description for storage class |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
ALIASES
tibcop tplatform:cicr
Examples
tibcop tplatform:create-ingress-resource-instance --dataplane-name dpname --name ResourceName --class-name ResourceClassName --description Description
tibcop tplatform:create-ingress-resource-instance --dataplane-id dpid --name ResourceName --class-name ResourceClassName --ingress-controller IngressController --fqdn FQDN
tibcop tplatform:unregister-dataplane
Unregister a data plane from TIBCO Control Plane
USAGE
tibcop tplatform:unregister-dataplane [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [-n <value>] [-i <value>] [-o] [-d] [-f]
FLAGS
| Command Option | Description |
|---|---|
-f, --force
|
This will force the deletion of a data plane in the TIBCO Control Plane, USE WITH CAUTION |
-i, --id=<value>
|
data plane id |
-n, --name=<value>
|
data plane name |
-o, --onlyPrintScripts
|
Only print the scripts |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:unregister-dataplane
tibcop tplatform:delete-resource-instance
Delete a resource instance from TIBCO Control Plane
USAGE
tibcop tplatform:delete-resource-instance [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [-n <value>] [-n <value>] [-i <value> | -n <value>] [-d] [-f]
FLAGS
| Option | Description |
|---|---|
-d, --debug
|
Enable debug logging |
-f, --force
|
This will force the deletion of a data plane in the TIBCO Control Plane, USE WITH CAUTION |
-i, --dataplane-id=<value>
|
data plane id |
-n, --dataplane-name=<value>
|
data plane name |
-n, --id=<value>
|
Resource instance id |
-n, --name=<value>
|
Resource instance name |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:delete-resource-instance
tibcop tplatform:delete-capability-instance
Delete a capability instance from a data plane
USAGE
tibcop tplatform:delete-capability-instance -n BWCE|TIBCOHUB|FLOGO|EMS|PULSAR [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [-i <value> | -n <value>] [-d]
FLAGS
| Option | Description |
|---|---|
-d, --debug
|
Enable debug logging |
-i, --dataplane-id=<value>
|
Data plane id |
-n, --dataplane-name=<value>
|
Data plane name |
-n, --id=<option>
|
(required) [default: TIBCOHUB] Capability id <options: BWCE|TIBCOHUB|FLOGO|EMS|PULSAR> |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:delete-capability-instance
tibcop tplatform:validate
Validates the existence or non-existence of a object. The process exits with -1 if validation fails.
USAGE
tibcop tplatform:validate -s exists|not-exists|tunnel_ok|tunnel_not_ok|green|red|amber|great [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [-t dataplane|capability] [--dataplane-id <value>] [-i <value>] [-n <value>] [-d]
FLAGS
| Option | Description |
|---|---|
-d, --debug
|
Enable debug logging |
-i, --id=<value>
|
Id of the object to validate |
-n, --name=<value>
|
Name of the object to validate |
-s, --state=<option>
|
(required) [default: green] State of the object to validate <options: exists|not-exists|tunnel_ok|tunnel_not_ok|green|red|amber|great> |
-t, --type=<option>
|
[default: dataplane] Type of object to validate <options: dataplane|capability> |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:validation --type "dataplane" --name "myDev" --state exists
tibcop tplatform:list-apps
List apps on a TIBCO Control Plane
USAGE
tibcop tplatform:list-apps [--json] [--no-warnings] [--config <value>] [--profile <value> | --cpurl <value> | --token <value>] [--dataplane-name <value> | --dataplane-id <value>] [-d]
FLAGS
| Command Line Option | Description |
|---|---|
-d, --debug
|
Enable debug logging |
--config=<value>
|
Path to the local config file |
--cpurl=<value>
|
TIBCO Control Plane URL |
--dataplane-id=<value>
|
Data plane id |
--dataplane-name=<value>
|
Data plane name |
--no-warnings
|
Disable warnings from command output |
--profile=<value>
|
Select a profile |
--token=<value>
|
OAuth token to interact with the TIBCO Platform |
Examples
tibcop tplatform:list-apps