CFDPADMIN(1)

πŸ“¦ version 3.2.1, in ubuntu jammy

✨ NAME ✨

cfdpadmin β€” ION's CCSDS File Delivery Protocol (CFDP) administration interface πŸ’–

It lives in the CFDP executables manual, section 1, bestie β€” that's the header energy, we're not typing it as a line, we're vibing it.


🌸 SYNOPSIS 🌸

cfdpadmin [ commands_filename | . ]

πŸŽ€ DESCRIPTION πŸŽ€

Okay so, cfdpadmin is literally the girlboss of CFDP on your local ION node. She configures, starts, manages, and stops CFDP operations. All four. Multitasking queen. πŸ‘‘

She does all that in response to CFDP configuration commands, which she finds in the file commands_filename, if you gave her one. And if you didn't? No worries bestie, she just prints a lil simple prompt β€” it looks like this: : β€” and then you can type commands directly into standard input. Just you and her, having a conversation. 🫢

Now here's the cute special case: if commands_filename is a period (.), that is exactly the same as if you'd passed her a command file containing the single command x. Which means β€” and this is the important part β€” the ION node's cfdpclock task and the UT layer service task (nominally bputa) get stopped. Periodt. πŸ›‘

Wanna know the format of the commands that go in commands_filename? You can literally ask her! Just hit the h command or the ? command at the prompt and she'll spill. The full command docs live in cfdprc(5). πŸ“–


πŸ’€ EXIT STATUS πŸ’€

  • "0" β€” Successful completion of CFDP administration. That's it. That's the whole list. She ate and left no crumbs.

🌈 EXAMPLES 🌈

  • cfdpadmin β€” Enter interactive CFDP configuration command entry mode. Just you and the prompt, typing your truth. ✨
  • cfdpadmin host1.cfdprc β€” Execute all configuration commands in host1.cfdprc, then terminate immediately. No small talk, in and out. πŸ”₯
  • cfdpadmin . β€” Stop all CFDP operations on the local node. The period. The shutdown. The drama. πŸ’…

πŸ¦‹ FILES πŸ¦‹

See cfdprc(5) for details of the CFDP configuration commands. That's where the lore lives, iykyk.


πŸ“ ENVIRONMENT πŸ“

No environment variables apply. None. Zero. Nada. She doesn't need them, she's built different. πŸ™ˆ


⭐ DIAGNOSTICS ⭐

Note, bestie, this one matters: all ION administration utilities expect source file input to be lines of ASCII text that are NL-delimited. If you edit the cfdprc file on a Windows machine, be sure to use dos2unix to convert it to Unix text format before presenting it to cfdpadmin. Otherwise cfdpadmin will detect syntax errors and will not function satisfactorily. Do not skip this step, I am begging. 😭

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

  • cfdpadmin can't attach to ION. β€” There is no SDR data store for cfdpadmin to use. You should run ionadmin(1) first, to set up an SDR data store for ION. She can't attach to nothing, babe. πŸ’€
  • Can't open command file... β€” The commands_filename specified in the command line doesn't exist. It's not there. It was never there. 🫠

Various errors that don't cause cfdpadmin to fail but are noted in the ion.log log file may be caused by improperly formatted commands given at the prompt or in the commands_filename file. Please see cfdprc(5) for details. Not fatal, just messy β€” and we don't do messy. πŸ’…


πŸ‘‘ BUGS πŸ‘‘

Report bugs to <ion-bugs@korgano.eecs.ohiou.edu> β€” they're listening, fr fr. πŸ“¬


🧚 SEE ALSO 🧚


And that's the whole page, bestie. Written by perl v5.24.1, dated 2016-07-07, filed under CFDPADMIN(1) β€” and yes, she's still that girl. Slay, stay hydrated, and don't forget your dos2unix. πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from