E-mail
|
Key
This line was removed.
This word was removed. This word was added.
This line was added.
|
Changes (44)
View Page History
...
{section} The Petals BC Gateway tooling pack for Petals CLI is a set of commands relatives to the Petals BC Gateway. The pack comes with the commands:
* {{bc-gateway.add-transport-listener}}: Add a new transport listener,
* {{bc-gateway.set-transport-listener-port}}: Modify the port of a transport listener,
* {{bc-gateway.del-transport-listener}}: Remove an existing transport listener,
* {{bc-gateway.list-transport-listener}}: List existing transport listeners of the Petals BC Gateway,
* {{bc-gateway.repropagate}}: Re-propagate endpoints to the domain clients connected on the current gateway.
* {{bc-gateway.set-transport-listener-port}}: Modify the port of a transport listener,
* {{bc-gateway.del-transport-listener}}: Remove an existing transport listener,
* {{bc-gateway.list-transport-listener}}: List existing transport listeners of the Petals BC Gateway,
* {{bc-gateway.repropagate}}: Re-propagate endpoints to the domain clients connected on the current gateway.
* {{bc-gateway.add-transport-listener}}: Add a new transport listener to the given BC Gateway.
* {{bc-gateway.set-transport-listener-port}}: Set the port of a transport listener of the given BC Gateway.
* {{bc-gateway.del-transport-listener}}: Remove a transport listener of the given BC Gateway.
* {{bc-gateway.list-transport-listener}}: List transport listeners of the given BC Gateway.
* {{bc-gateway.repropagate}}: Repropagate all elected endpoints to the client domains of the BC Gateway.
* {{bc-gateway.reconnect}}: Triggers reconnection of client domains of the BC Gateway.
* {{bc-gateway.set-transport-listener-port}}: Set the port of a transport listener of the given BC Gateway.
* {{bc-gateway.del-transport-listener}}: Remove a transport listener of the given BC Gateway.
* {{bc-gateway.list-transport-listener}}: List transport listeners of the given BC Gateway.
* {{bc-gateway.repropagate}}: Repropagate all elected endpoints to the client domains of the BC Gateway.
* {{bc-gateway.reconnect}}: Triggers reconnection of client domains of the BC Gateway.
{column}
...h1. Installing the Petals BC Gateway tooling pack
h2. Through Debians packages
If you have installed Petals CLI using the Debian packages, we recommend you to install the Petals BC Gateway tooling pack using its own Debian package ({{petals-cli-bc-gateway}}). Otherwise, unzip the content of the ZIP archive in the directory {{$PETALS_CLI_HOME/extensions}}.
...h1. Commands
h2. Adding a new transport listener
The command *{{bc-gateway.add-transport-listener}}* provides a way to configure a Petals BC Gateway to add a new transport listener.
...{code}
USAGE:
USAGE:
bc-gateway.add-transport-listener -i <transport-listener-identifier>
bc-gateway.add-transport-listener usage: bc-gateway.add-transport-listener -i
<transport-listener-identifier> [-n <component-identifier>] -p <listening-port>
<listening-port>
...{code}
The default component identifier used is: {{petals-bc-jbi-gateway}}.
h2. Modifying the port of a transport listener
The command *{{bc-gateway.set-transport-listener-port}}* provides a way to configure a Petals BC Gateway to modify the port of one of its transport listener.
{tip}Modifying the port of a transport listener of a started BC Gateway will restart it, even if it is the same port, but the an already established connections won't be stopped.{tip}
{code}
USAGE:
bc-gateway.set-transport-listener-port -i <transport-listener-identifier>
bc-gateway.set-transport-listener-port usage: bc-gateway.set-transport-listener-port -i
<transport-listener-identifier> [-n <component-identifier>] -p <listening-port>
<listening-port>
DESCRIPTION:
Modify Set the port of a transport listener of the given BC Gateway
OPTIONS DESCRIPTION:
-i,--identifier <transport-listener-identifier> The unique identifier
of the transport
listener to modify in the
the BC Gateway.
-n,--component <component-identifier> The component
identifier associated
to the BC Gateway.
identifier associated
to the BC Gateway.
-p,--port <listening-port> The new listening port of
of the transport listener
to modify in the BC listener.
Gateway.
{code}
The default component identifier used is: {{petals-bc-jbi-gateway}}.
h2. Remove Removing an existing transport listener
The command *{{bc-gateway.del-transport-listener}}* provides a way to configure a Petals BC Gateway to remove an existing transport listener.
...{code}
USAGE:
USAGE:
bc-gateway.del-transport-listener -i <transport-listener-identifier>
bc-gateway.del-transport-listener usage: bc-gateway.del-transport-listener -i
<transport-listener-identifier> [-n <component-identifier>]
...{code}
The default component identifier used is: {{petals-bc-jbi-gateway}}.
h2. Listing existing transport listeners
The command *{{bc-gateway.list-transport-listener}}* provides a way to list all configured transport listeners of the given Petals BC Gateway and given criteria: transport listener identifier, listening status and/or port.
...{code}
USAGE:
USAGE:
bc-gateway.list-transport-listener [-i <transport-listener-identifier>]
bc-gateway.list-transport-listener usage: bc-gateway.list-transport-listener [-i
<transport-listener-identifier>] [-l <boolean>] [-n
<transport-listener-identifier>] [-l <boolean>] [-n
[-l <boolean>] [-n <component-identifier>] [-p <listening-port>]
... to the BC Gateway.
-p,--port <listening-port> The listening port of
-p,--port <listening-port> The listening port of
the transport listeners
to list.
{code}
{code}
The default component identifier used is: {{petals-bc-jbi-gateway}}.
h2. Refresh endpoint propagations
...{code}
USAGE:
USAGE:
bc-gateway.repropagate [-n <component-identifier>] [-s <service-unit-identifier> [-c <consumer-domain-identifier>]]
bc-gateway.repropagate usage: bc-gateway.repropagate [-c <consumer-domain-identifier>] [-n
<component-identifier>] [-s <service-unit-identifier>]
<component-identifier>] [-s <service-unit-identifier>]
...OPTIONS DESCRIPTION:
-c,--consumer-domain <consumer-domain-identifier> The consumer domain
identifier defined in
the specified service
unit.
identifier defined in
the specified service
unit.
-n,--component <component-identifier> The component identifier associated to the BC Gateway.
identifier associated
to the BC Gateway.
to the BC Gateway.
-s,--service-unit <service-unit-identifier> The service unit identifier deployed on the BC Gateway.
-c,--consumer-domain <consumer-domain-identifier> The consumer domain identifier defined in the specified service unit.
identifier deployed
on the BC Gateway.
on the BC Gateway.
{code}
The default component identifier used is: {{petals-bc-jbi-gateway}}.
h2. Reconnect clients
The command *{{bc-gateway.reconnect}}* provides a way to reconnect the clients of the Petals BC Gateway that are disconnected (or even that are connect if the {{force}} option is used).
{code}
USAGE:
bc-gateway.reconnect usage: bc-gateway.reconnect [-c <provider-domain-identifier>] [-f] [-n
<component-identifier>] [-s <service-unit-identifier>]
DESCRIPTION:
Triggers reconnection of client domains of the BC Gateway
OPTIONS DESCRIPTION:
-c,--provider-domain <provider-domain-identifier> The provider domain
identifier defined in
the specified service
unit.
-f,--force Force reconnection
even if the provider
domain is already
connected.
-n,--component <component-identifier> The component
identifier associated
to the BC Gateway.
-s,--service-unit <service-unit-identifier> The service unit
identifier deployed
on the BC Gateway.
{code}
The default component identifier used is: {{petals-bc-gateway}}.