tcp-inlet create

ockam tcp-inlet create [OPTIONS] [NAME]

Create TCP Inlets

Arguments

  • [NAME] (optional)
    Assign a name to this TCP Inlet

Options

  • --at [NODE_NAME] (optional)
    Node on which to start the TCP Inlet

  • --from [SOCKET_ADDRESS] (optional)
    Address on which to accept InfluxDB connections, in the format <scheme>://<hostname>:<port>. At least the port must be provided. The default scheme is tcp and the default hostname is 127.0.0.1. If the argument is not set, a random port will be used on the default address

  • --to [ROUTE] (optional)
    Route to a TCP Outlet or the name of the TCP Outlet service you want to connect to

  • --via [RELAY_NAME] (optional)
    Name of the relay that this TCP Inlet will use to connect to the TCP Outlet

  • --identity [IDENTITY_NAME] (optional)
    Identity to be used to create the secure channel. If not set, the node's identity will be used

  • --authorized [AUTHORIZED] (optional)
    Authorized identifier for secure channel connection

  • --alias [ALIAS] (optional)
    [DEPRECATED] Use the positional argument instead

  • --allow [POLICY_EXPRESSION] (optional)
    Policy expression that will be used for access control to the TCP Inlet. If you don't provide it, the policy set for the "tcp-inlet" resource type will be used.

You can check the fallback policy with ockam policy show --resource-type tcp-inlet.

  • --connection-wait [WAIT] (optional)
    Time to wait for the outlet to be available

  • --retry-wait [RETRY] (optional)
    Time to wait before retrying to connect to the TCP Outlet

  • --timeout [TIMEOUT] (optional)
    Override the default timeout duration that the command will wait for a response

  • --no-connection-wait (optional)
    Create the TCP Inlet without waiting for the TCP Outlet to connect

  • --udp (optional)
    [DEPRECATED] Use the udp scheme in the --from argument

  • --no-tcp-fallback (optional)
    Disable fallback to TCP. TCP won't be used to transfer data between the Inlet and the Outlet

  • --privileged (optional)
    Use eBPF and RawSocket to access TCP packets instead of TCP data stream. If OCKAM_PRIVILEGED env variable is set to 1, this argument will be true. WARNING: This flag value should be equal on both ends of a portal (inlet and outlet)

  • --tls (optional)
    [DEPRECATED] Use the tls scheme in the --from argument

  • --tls-certificate-provider [ROUTE] (optional)
    Enable TLS for the TCP Inlet using the provided certificate provider. Requires ockam-tls-certificate credential attribute

  • --skip-handshake (optional)
    Skip Portal handshake for lower latency, but also lower throughput WARNING: This flag value should be equal on both ends of a portal (inlet and outlet)

  • --enable-nagle (optional)
    Enable Nagle's algorithm for potentially higher throughput, but higher latency

  • --http-header [HTTP_HEADER] (optional)
    Set the provided HTTP headers in the client request. Existing headers with the same name will be discarded. This option assumes the protocol is HTTP/1.0 or HTTP/1.1. It expects a key-value pair in the format key:value. It can be specified multiple times

Examples:

# To create a new TCP inlet at the given address using the default node
$ ockam tcp-inlet create --from 127.0.0.1:5000 --to /node/n1/service/outlet

# To create a new TCP inlet at the given address using a specific node
$ ockam tcp-inlet create --at n2 --from 127.0.0.1:5000 --to /node/n1/service/outlet

Learn More:

Use 'ockam --help' for more information about a subcommand. Where might be: 'node', 'status', 'enroll', etc. Learn more about Command: https://command.ockam.io/manual/ Learn more about Ockam: https://docs.ockam.io/reference/command

Feedback:

If you have questions, as you explore, join us on the contributors discord channel https://discord.ockam.io