---
name: "udpcli"
section: "1"
platform: "linux"
package: "ion"
version: "3.2.1+dfsg-1.1"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/udpcli"
---

# udpcli(1)

UDP-based BP convergence layer input task

## NAME

udpcli - UDP-based BP convergence layer input task

## SYNOPSIS

**udpcli** *local\_hostname*\[:*local\_port\_nbr*\]

## DESCRIPTION

**udpcli** is a background "daemon" task that receives UDP datagrams via a UDP socket bound to *local\_hostname* and *local\_port\_nbr*, extracts bundles from those datagrams, and passes them to the bundle protocol agent on the local ION node.

If not specified, port number defaults to 4556.

The convergence layer input task is spawned automatically by **bpadmin** in response to the 's' (START) command that starts operation of the Bundle Protocol; the text of the command that is used to spawn the task must be provided at the time the "udp" convergence layer protocol is added to the BP database.  The convergence layer input task is terminated by **bpadmin** in response to an 'x' (STOP) command.  **udpcli** can also be spawned and terminated in response to START and STOP commands that pertain specifically to the UDP convergence layer protocol.

## EXIT STATUS

- "0"

  **udpcli** terminated normally, for reasons noted in the **ion.log** file.  If this termination was not commanded, investigate and solve the problem identified in the log file and use **bpadmin** to restart **udpcli**.

- "1"

  **udpcli** terminated abnormally, for reasons noted in the **ion.log** file. Investigate and solve the problem identified in the log file, then use **bpadmin** to restart **udpcli**.

## FILES

No configuration files are needed.

## ENVIRONMENT

No environment variables apply.

## DIAGNOSTICS

The following diagnostics may be issued to the **ion.log** log file:

- udpcli can't attach to BP.

  **bpadmin** has not yet initialized Bundle Protocol operations.

- No such udp duct.

  No UDP induct matching *local\_hostname* and *local\_port\_nbr* has been added to the BP database.  Use **bpadmin** to stop the UDP convergence-layer protocol, add the induct, and then restart the UDP protocol.

- CLI task is already started for this duct.

  Redundant initiation of **udpcli**.

- Can't get IP address for host

  Operating system error.  Check errtext, correct problem, and restart UDP.

- Can't open UDP socket

  Operating system error.  Check errtext, correct problem, and restart UDP.

- Can't initialize socket

  Operating system error.  Check errtext, correct problem, and restart UDP.

- udpcli can't create receiver thread

  Operating system error.  Check errtext, correct problem, and restart UDP.

## BUGS

Report bugs to \<ion-bugs@korgano.eecs.ohiou.edu\>

## SEE ALSO

[*bpadmin*(1)](/bpadmin/1.md), [*bprc*(5)](/bprc/5.md), [*udpclo*(1)](/udpclo/1.md)