Available commands:
...
bc-gateway.repropagate
Repropagate all elected endpoints to the client domains of the BC Gateway.
connect Connect to a Petals ESB node.
...
{code}
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:
bc-gateway.add-transport-listener usage: bc-gateway.add-transport-listener -i
<transport-listener-identifier> [-n <component-identifier>] -p
<listening-port>
DESCRIPTION:
Add a new transport listener to the given BC Gateway
OPTIONS DESCRIPTION:
-i,--identifier <transport-listener-identifier> The unique identifier
of the transport
listener to add to the
BC Gateway.
-n,--component <component-identifier> The component
identifier associated
to the BC Gateway.
-p,--port <listening-port> The listening port of
the transport listener
to add to the BC
Gateway.
{code}
The default component identifier used is: {{petals-bc-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 an already established connections won't be stopped.{tip}
{code}
USAGE:
bc-gateway.set-transport-listener-port usage: bc-gateway.set-transport-listener-port -i
<transport-listener-identifier> [-n <component-identifier>] -p
<listening-port>
DESCRIPTION:
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 BC Gateway.
-n,--component <component-identifier> The component
identifier associated
to the BC Gateway.
-p,--port <listening-port> The new listening port
of the transport
listener.
{code}
The default component identifier used is: {{petals-bc-gateway}}.
h2. 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.
{tip}A transport listener can't be removed if it's currently being used by deployed service units!{tip}
{code}
USAGE:
bc-gateway.del-transport-listener usage: bc-gateway.del-transport-listener -i
<transport-listener-identifier> [-n <component-identifier>]
DESCRIPTION:
Remove a transport listener of the given BC Gateway
OPTIONS DESCRIPTION:
-i,--identifier <transport-listener-identifier> The unique identifier
of the transport
listener to remove from
the BC Gateway.
-n,--component <component-identifier> The component
identifier associated
to the BC Gateway.
{code}
The default component identifier used is: {{petals-bc-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:
bc-gateway.list-transport-listener usage: bc-gateway.list-transport-listener [-i
<transport-listener-identifier>] [-l <boolean>] [-n
<component-identifier>] [-p <listening-port>]
DESCRIPTION:
List transport listeners of the given BC Gateway
OPTIONS DESCRIPTION:
-i,--identifier <transport-listener-identifier> The unique identifier
of the transport
listener to list.
-l,--listening <boolean> The listening status of
the transport listeners
to list.
-n,--component <component-identifier> The component
identifier associated
to the BC Gateway.
-p,--port <listening-port> The listening port of
the transport listeners
to list.
{code}
The default component identifier used is: {{petals-bc-gateway}}.
h2. Refresh endpoint propagations
The command *{{bc-gateway.repropagate}}* provides a way to refresh endpoint propagations to domain clients of the current gateway.
{code}
USAGE:
bc-gateway.repropagate usage: bc-gateway.repropagate [-c <consumer-domain-identifier>] [-n
<component-identifier>] [-s <service-unit-identifier>]
DESCRIPTION:
Repropagate all elected endpoints to the client domains of the BC Gateway
OPTIONS DESCRIPTION:
-c,--consumer-domain <consumer-domain-identifier> The consumer domain
identifier defined in
the specified service
unit.
-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}}.
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}}.
E-mail
...