Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
LIGHTNING-AUTOCLEAN-ONCE(7)			   LIGHTNING-AUTOCLEAN-ONCE(7)

NAME
       lightning-autoclean-once	 --  A	single	deletion  of old invoices/pay-
       ments/forwards

SYNOPSIS
       autoclean-once subsystem	age

DESCRIPTION
       The autoclean-once RPC command tell the autoclean plugin	to do a	single
       sweep to	delete old entries. This is a manual alternative (or addition)
       to the various autoclean-...-age	parameters which  cause	 autoclean  to
       run once	per hour: see lightningd-config(5).

       •  subsystem  (string)  (one  of	"succeededforwards", "failedforwards",
	  "succeededpays", "failedpays",  "paidinvoices",  "expiredinvoices"):
	  What subsystem to clean. Currently supported subsystems are:

	  •  failedforwards:  routed payments which did	not succeed (failed or
	     local_failed in listforwards status).
	  •  succeededforwards:	routed payments	which  succeeded  (settled  in
	     listforwards status).
	  •  failedpays:  payment  attempts  which  did	not succeed (failed in
	     listpays status).
	  •  succeededpays: payment  attempts  which  succeeded	 (complete  in
	     listpays status).
	  •  expiredinvoices:  invoices	 which	were  not paid (and cannot be)
	     (expired in listinvoices status).
	  •  paidinvoices: invoices which were paid (paid in listinvoices sta-
	     tus).
       •  age (u64): Non-zero number in	seconds. How many seconds old an entry
	  must be to delete it.

RETURN VALUE
       On success, an object containing	autoclean is returned. It is an	object
       containing:

       •  succeededforwards (object, optional):

	  •  cleaned (u64): Total number of deletions done this	run.
	  •  uncleaned (u64): The total	number of  entries  not	 deleted  this
	     run.
       •  failedforwards (object, optional):

	  •  cleaned (u64): Total number of deletions done this	run.
	  •  uncleaned	(u64):	The  total  number of entries not deleted this
	     run.
       •  succeededpays	(object, optional):

	  •  cleaned (u64): Total number of deletions done this	run.
	  •  uncleaned (u64): The total	number of  entries  not	 deleted  this
	     run.
       •  failedpays (object, optional):

	  •  cleaned (u64): Total number of deletions done this	run.
	  •  uncleaned	(u64):	The  total  number of entries not deleted this
	     run.
       •  paidinvoices (object,	optional):

	  •  cleaned (u64): Total number of deletions done this	run.
	  •  uncleaned (u64): The total	number of  entries  not	 deleted  this
	     run.
       •  expiredinvoices (object, optional):

	  •  cleaned (u64): Total number of deletions done this	run.
	  •  uncleaned	(u64):	The  total  number of entries not deleted this
	     run.

AUTHOR
       Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible.

SEE ALSO
       lightningd-config(5), lightning-autoclean-status(7)

RESOURCES
       Main web	site: <https://github.com/ElementsProject/lightning>

EXAMPLES
       Example 1:

       Request:

       $ lightning-cli autoclean-once "failedpays" "1"

       {
	 "id": "example:autoclean-once#1",
	 "method": "autoclean-once",
	 "params": [
	   "failedpays",
	   1
	 ]
       }

       Response:

       {
	 "autoclean": {
	   "failedpays": {
	     "cleaned":	0,
	     "uncleaned": 7
	   }
	 }
       }

       Example 2:

       Request:

       $ lightning-cli autoclean-once "succeededpays" "1"

       {
	 "id": "example:autoclean-once#2",
	 "method": "autoclean-once",
	 "params": [
	   "succeededpays",
	   1
	 ]
       }

       Response:

       {
	 "autoclean": {
	   "succeededpays": {
	     "cleaned":	7,
	     "uncleaned": 0
	   }
	 }
       }

Core Lightning v25.02				   LIGHTNING-AUTOCLEAN-ONCE(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lightning-autoclean-once&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>

home | help